From 0cb72664d833c4c8e05021a12659f14bc916fea5 Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Tue, 16 Jul 2024 15:16:43 -0400 Subject: [PATCH 1/8] Revert "chore: Update discovery artifacts (#2438)" (#2441) This reverts commit 375e4397b1d4894dc9f97c2e6b7113c8e00222ab. --- ...anager_v1.accessPolicies.accessLevels.html | 10 +- ...r_v1.accessPolicies.servicePerimeters.html | 40 +- docs/dyn/admin_directory_v1.users.html | 4 +- docs/dyn/adsenseplatform_v1alpha.html | 111 - ...orm_v1alpha.platforms.accounts.events.html | 147 - ...seplatform_v1alpha.platforms.accounts.html | 271 - ...form_v1alpha.platforms.accounts.sites.html | 233 - .../adsenseplatform_v1alpha.platforms.html | 91 - ...tform_v1.projects.locations.endpoints.html | 122 +- ...jects.locations.notebookExecutionJobs.html | 263 - ...rojects.locations.persistentResources.html | 12 - ....projects.locations.publishers.models.html | 122 +- ..._v1beta1.projects.locations.endpoints.html | 173 +- ...rojects.locations.persistentResources.html | 12 - ....projects.locations.publishers.models.html | 173 +- ...sadmin_v1alpha.properties.dataStreams.html | 5 + ...csadmin_v1beta.properties.dataStreams.html | 5 + docs/dyn/androidpublisher_v3.apprecovery.html | 130 +- ...roidpublisher_v3.externaltransactions.html | 8 +- ...cations.repositories.genericArtifacts.html | 2 +- .../dyn/batch_v1.projects.locations.jobs.html | 24 +- ...jects.locations.jobs.taskGroups.tasks.html | 20 +- .../batch_v1.projects.locations.state.html | 20 +- ...lpha.organizations.locations.insights.html | 2 +- ...p_v1alpha.projects.locations.insights.html | 2 +- docs/dyn/bigquery_v2.datasets.html | 32 +- docs/dyn/bigquery_v2.jobs.html | 10 +- docs/dyn/bigquery_v2.tables.html | 14 +- docs/dyn/calendar_v3.events.html | 52 +- docs/dyn/chat_v1.spaces.html | 42 +- docs/dyn/chat_v1.spaces.messages.html | 32 +- docs/dyn/chat_v1.spaces.spaceEvents.html | 64 +- ...chromemanagement_v1.customers.reports.html | 4 +- docs/dyn/cloudbuild_v1.projects.builds.html | 8 +- ...oudbuild_v1.projects.locations.builds.html | 8 +- ...dbuild_v1.projects.locations.triggers.html | 12 +- docs/dyn/cloudbuild_v1.projects.triggers.html | 12 +- docs/dyn/compute_alpha.backendServices.html | 77 +- ...ute_alpha.globalNetworkEndpointGroups.html | 6 + docs/dyn/compute_alpha.html | 15 - .../compute_alpha.instanceGroupManagers.html | 30 +- docs/dyn/compute_alpha.instanceTemplates.html | 8 +- docs/dyn/compute_alpha.instances.html | 24 +- .../compute_alpha.instantSnapshotGroups.html | 490 - docs/dyn/compute_alpha.interconnects.html | 32 - docs/dyn/compute_alpha.machineImages.html | 12 +- .../compute_alpha.networkEndpointGroups.html | 8 + .../compute_alpha.regionBackendServices.html | 66 +- docs/dyn/compute_alpha.regionCommitments.html | 28 - ...ionInstanceGroupManagerResizeRequests.html | 479 - ...ute_alpha.regionInstanceGroupManagers.html | 25 +- ...compute_alpha.regionInstanceTemplates.html | 6 +- docs/dyn/compute_alpha.regionInstances.html | 2 +- ...ute_alpha.regionInstantSnapshotGroups.html | 490 - docs/dyn/compute_alpha.regionMultiMigs.html | 30 +- ...ute_alpha.regionNetworkEndpointGroups.html | 6 + docs/dyn/compute_alpha.regions.html | 4 +- docs/dyn/compute_alpha.reservations.html | 15 - docs/dyn/compute_alpha.resourcePolicies.html | 15 - docs/dyn/compute_alpha.vpnGateways.html | 8 +- .../compute_alpha.zoneQueuedResources.html | 8 +- docs/dyn/compute_beta.backendServices.html | 84 +- docs/dyn/compute_beta.firewallPolicies.html | 921 +- ...pute_beta.globalNetworkEndpointGroups.html | 6 + .../compute_beta.instanceGroupManagers.html | 12 +- docs/dyn/compute_beta.instanceTemplates.html | 4 - docs/dyn/compute_beta.instances.html | 13 - docs/dyn/compute_beta.machineImages.html | 6 - .../compute_beta.networkEndpointGroups.html | 8 + .../compute_beta.networkFirewallPolicies.html | 935 +- .../compute_beta.regionBackendServices.html | 72 +- ...pute_beta.regionInstanceGroupManagers.html | 10 +- .../compute_beta.regionInstanceTemplates.html | 3 - docs/dyn/compute_beta.regionInstances.html | 1 - ...pute_beta.regionNetworkEndpointGroups.html | 6 + ...te_beta.regionNetworkFirewallPolicies.html | 293 - docs/dyn/compute_beta.regions.html | 4 +- docs/dyn/compute_beta.vpnGateways.html | 8 +- docs/dyn/compute_v1.backendServices.html | 28 +- .../dyn/compute_v1.instanceGroupManagers.html | 10 +- docs/dyn/compute_v1.instanceTemplates.html | 4 - docs/dyn/compute_v1.instances.html | 7 - docs/dyn/compute_v1.machineImages.html | 6 - .../dyn/compute_v1.regionBackendServices.html | 24 +- ...ompute_v1.regionInstanceGroupManagers.html | 8 +- .../compute_v1.regionInstanceTemplates.html | 3 - docs/dyn/compute_v1.regionInstances.html | 1 - docs/dyn/compute_v1.regions.html | 4 +- docs/dyn/compute_v1.vpnGateways.html | 8 +- ....connections.connectionSchemaMetadata.html | 2 - ...ors_v1.projects.locations.connections.html | 2 - ...ions.connections.runtimeActionSchemas.html | 2 - ...tomConnectors.customConnectorVersions.html | 6 +- ...cations.providers.connectors.versions.html | 32 +- ...rojects.locations.connections.actions.html | 4 - .../dyn/css_v1.accounts.cssProductInputs.html | 362 - docs/dyn/css_v1.accounts.cssProducts.html | 442 - docs/dyn/css_v1.accounts.html | 237 - docs/dyn/css_v1.accounts.labels.html | 236 - docs/dyn/css_v1.html | 111 - ...flow_v2.projects.conversationProfiles.html | 42 - ...ojects.locations.conversationProfiles.html | 42 - ..._v2.projects.locations.encryptionSpec.html | 134 - .../dyn/dialogflow_v2.projects.locations.html | 28 - ...low_v2.projects.locations.suggestions.html | 7 - .../dialogflow_v2.projects.suggestions.html | 7 - ...v2beta1.projects.conversationProfiles.html | 42 - ...beta1.projects.conversations.messages.html | 96 - ...1.projects.conversations.participants.html | 32 - ...ojects.locations.conversationProfiles.html | 42 - ...ects.locations.conversations.messages.html | 96 - ....locations.conversations.participants.html | 32 - ...ta1.projects.locations.encryptionSpec.html | 134 - ...dialogflow_v2beta1.projects.locations.html | 28 - ...2beta1.projects.locations.suggestions.html | 39 - ...alogflow_v2beta1.projects.suggestions.html | 39 - ...ocations.agents.environments.sessions.html | 14 - ...ow_v3.projects.locations.agents.flows.html | 6 - ...projects.locations.agents.flows.pages.html | 12 - ...v3.projects.locations.agents.sessions.html | 14 - ...3.projects.locations.agents.testCases.html | 55 +- ...ts.locations.agents.testCases.results.html | 4 - ...ojects.locations.agents.conversations.html | 26 - ...ocations.agents.environments.sessions.html | 17 - ...beta1.projects.locations.agents.flows.html | 6 - ...projects.locations.agents.flows.pages.html | 12 - ...a1.projects.locations.agents.sessions.html | 17 - ...1.projects.locations.agents.testCases.html | 55 +- ...ts.locations.agents.testCases.results.html | 4 - ...collections.dataStores.servingConfigs.html | 1 - ...ns.collections.engines.servingConfigs.html | 1 - ...s.locations.dataStores.servingConfigs.html | 1 - ...anizations.locations.discoveryConfigs.html | 12 +- ...tions.locations.fileStoreDataProfiles.html | 8 +- ...nizations.locations.tableDataProfiles.html | 8 +- ...2.projects.locations.discoveryConfigs.html | 12 +- ...jects.locations.fileStoreDataProfiles.html | 8 +- ....projects.locations.tableDataProfiles.html | 8 +- ...essentialcontacts_v1.folders.contacts.html | 14 +- ...ialcontacts_v1.organizations.contacts.html | 14 +- ...ssentialcontacts_v1.projects.contacts.html | 14 +- ...le_v1beta1.projects.locations.backups.html | 4 - ..._v1alpha.projects.apps.releases.tests.html | 36 - ...v1.projects.databases.backupSchedules.html | 12 +- ...gkehub_v1.projects.locations.features.html | 40 +- ...ocations.memberships.rbacrolebindings.html | 242 - ...b_v1alpha.projects.locations.features.html | 48 +- ...ub_v1beta.projects.locations.features.html | 40 +- .../iam_v1.projects.serviceAccounts.keys.html | 82 + docs/dyn/index.md | 8 - ...tions_v1.projects.locations.templates.html | 77 +- ...illingAccounts.locations.savedQueries.html | 5 +- docs/dyn/logging_v2.folders.html | 2 +- ...ing_v2.folders.locations.savedQueries.html | 5 +- docs/dyn/logging_v2.organizations.html | 2 +- ....organizations.locations.savedQueries.html | 5 +- ...ng_v2.projects.locations.savedQueries.html | 5 +- docs/dyn/logging_v2.v2.html | 2 +- docs/dyn/meet_v2.spaces.html | 48 +- ...unts_v1beta.accounts.businessIdentity.html | 186 - ...accounts_v1beta.accounts.businessInfo.html | 252 - ...unts_v1beta.accounts.emailpreferences.html | 141 - ...api_accounts_v1beta.accounts.homepage.html | 58 - .../merchantapi_accounts_v1beta.accounts.html | 665 +- ...unts_v1beta.accounts.shippingSettings.html | 326 - ...ccounts.termsOfServiceAgreementStates.html | 6 +- ...antapi_accounts_v1beta.accounts.users.html | 55 + ...a.projects.locations.services.backups.html | 48 - ...e_v1alpha.projects.locations.services.html | 64 - ...a.projects.locations.services.backups.html | 48 - ...re_v1beta.projects.locations.services.html | 64 - ...ha1.projects.locations.preferenceSets.html | 64 +- ...jects.locations.reportConfigs.reports.html | 96 +- ...1.projects.locations.endpointPolicies.html | 172 + ...rvices_v1.projects.locations.gateways.html | 172 + ...services_v1.projects.locations.meshes.html | 172 + ...v1.projects.locations.serviceBindings.html | 172 + ...1.projects.locations.endpointPolicies.html | 172 + ...s_v1beta1.projects.locations.gateways.html | 172 + ...ces_v1beta1.projects.locations.meshes.html | 172 + ...a1.projects.locations.serviceBindings.html | 172 + ...jects.locations.scans.vulnerabilities.html | 5 + ...jects.locations.scans.vulnerabilities.html | 5 + docs/dyn/playintegrity_v1.deviceRecall.html | 119 - docs/dyn/playintegrity_v1.html | 5 - ...s.locations.catalogs.attributesConfig.html | 40 + ...retail_v2.projects.locations.catalogs.html | 26 +- ...s.locations.catalogs.attributesConfig.html | 40 + ....projects.locations.catalogs.branches.html | 6 + ...l_v2alpha.projects.locations.catalogs.html | 26 +- ...s.locations.catalogs.attributesConfig.html | 40 + ...il_v2beta.projects.locations.catalogs.html | 26 +- .../run_v2.projects.locations.services.html | 8 +- docs/dyn/serviceusage_v1.services.html | 6 +- docs/dyn/serviceusage_v1beta1.services.html | 4 +- docs/dyn/sheets_v4.spreadsheets.html | 8 +- ..._v1.projects.instanceConfigOperations.html | 10 +- .../spanner_v1.projects.instanceConfigs.html | 90 +- ...s.instances.databases.backupSchedules.html | 226 - ...anner_v1.projects.instances.databases.html | 13 +- ...projects.instances.databases.sessions.html | 2 +- docs/dyn/spanner_v1.projects.instances.html | 30 +- ...projects.instances.instancePartitions.html | 16 +- docs/dyn/sqladmin_v1.connect.html | 1 - docs/dyn/sqladmin_v1.instances.html | 18 +- docs/dyn/sqladmin_v1beta4.connect.html | 1 - docs/dyn/sqladmin_v1beta4.instances.html | 18 +- docs/dyn/sts_v1.v1.html | 1 - ...ations.sources.migratingVms.cloneJobs.html | 6 +- ...ions.sources.migratingVms.cutoverJobs.html | 6 +- ...ojects.locations.sources.migratingVms.html | 32 +- ...ations.sources.migratingVms.cloneJobs.html | 18 +- ...ions.sources.migratingVms.cutoverJobs.html | 18 +- ...ojects.locations.sources.migratingVms.html | 80 +- ...rojects.locations.workstationClusters.html | 56 +- ...orkstationClusters.workstationConfigs.html | 30 - ...rojects.locations.workstationClusters.html | 64 +- ...orkstationClusters.workstationConfigs.html | 20 +- ...sters.workstationConfigs.workstations.html | 10 - .../acceleratedmobilepageurl.v1.json | 2 +- .../documents/accessapproval.v1.json | 2 +- .../documents/accesscontextmanager.v1.json | 9 +- .../discovery_cache/documents/acmedns.v1.json | 2 +- .../documents/addressvalidation.v1.json | 2 +- .../documents/adexchangebuyer2.v2beta1.json | 2 +- .../documents/admin.datatransfer_v1.json | 2 +- .../documents/admin.directory_v1.json | 4 +- .../documents/admin.reports_v1.json | 2 +- .../discovery_cache/documents/admob.v1.json | 2 +- .../documents/admob.v1beta.json | 2 +- .../discovery_cache/documents/adsense.v2.json | 2 +- .../documents/adsenseplatform.v1alpha.json | 721 - .../documents/aiplatform.v1.json | 439 +- .../documents/aiplatform.v1beta1.json | 113 +- .../documents/airquality.v1.json | 2 +- .../documents/alertcenter.v1beta1.json | 2 +- .../discovery_cache/documents/alloydb.v1.json | 2 +- .../documents/alloydb.v1alpha.json | 23 +- .../documents/alloydb.v1beta.json | 23 +- .../documents/analyticsadmin.v1alpha.json | 45 +- .../documents/analyticsadmin.v1beta.json | 45 +- .../documents/analyticsdata.v1beta.json | 2 +- .../documents/analyticshub.v1.json | 2 +- .../documents/analyticshub.v1beta1.json | 2 +- .../documents/androidenterprise.v1.json | 2 +- .../documents/androidmanagement.v1.json | 2 +- .../documents/androidpublisher.v3.json | 64 +- .../documents/apigateway.v1.json | 2 +- .../documents/apigateway.v1beta.json | 2 +- .../discovery_cache/documents/apigee.v1.json | 2 +- .../discovery_cache/documents/apikeys.v2.json | 2 +- .../documents/apim.v1alpha.json | 2 +- .../documents/appengine.v1.json | 2 +- .../documents/appengine.v1alpha.json | 2 +- .../documents/appengine.v1beta.json | 2 +- .../discovery_cache/documents/apphub.v1.json | 2 +- .../documents/apphub.v1alpha.json | 2 +- .../documents/area120tables.v1alpha1.json | 2 +- .../documents/artifactregistry.v1.json | 10 +- .../documents/artifactregistry.v1beta1.json | 2 +- .../documents/artifactregistry.v1beta2.json | 2 +- .../documents/assuredworkloads.v1.json | 26 +- .../documents/assuredworkloads.v1beta1.json | 26 +- .../authorizedbuyersmarketplace.v1.json | 2 +- .../documents/backupdr.v1.json | 2 +- .../documents/baremetalsolution.v2.json | 2 +- .../discovery_cache/documents/batch.v1.json | 12 +- .../documents/beyondcorp.v1.json | 2 +- .../documents/beyondcorp.v1alpha.json | 6 +- .../discovery_cache/documents/biglake.v1.json | 2 +- .../documents/bigquery.v2.json | 12 +- .../documents/bigqueryconnection.v1.json | 2 +- .../documents/bigqueryconnection.v1beta1.json | 2 +- .../documents/bigquerydatapolicy.v1.json | 2 +- .../documents/bigquerydatatransfer.v1.json | 2 +- .../documents/bigqueryreservation.v1.json | 2 +- .../documents/bigtableadmin.v2.json | 2 +- .../binaryauthorization.v1beta1.json | 2 +- .../discovery_cache/documents/blogger.v2.json | 2 +- .../discovery_cache/documents/blogger.v3.json | 2 +- .../discovery_cache/documents/books.v1.json | 2 +- .../businessprofileperformance.v1.json | 2 +- .../documents/calendar.v3.json | 6 +- .../discovery_cache/documents/chat.v1.json | 30 +- .../documents/checks.v1alpha.json | 2 +- .../documents/chromemanagement.v1.json | 6 +- .../documents/chromepolicy.v1.json | 2 +- .../documents/chromeuxreport.v1.json | 2 +- .../documents/civicinfo.v2.json | 2 +- .../documents/classroom.v1.json | 2 +- .../documents/cloudasset.v1.json | 2 +- .../documents/cloudasset.v1beta1.json | 2 +- .../documents/cloudasset.v1p1beta1.json | 2 +- .../documents/cloudasset.v1p5beta1.json | 2 +- .../documents/cloudasset.v1p7beta1.json | 2 +- .../documents/cloudbilling.v1.json | 2 +- .../documents/cloudbilling.v1beta.json | 2 +- .../documents/cloudbuild.v1.json | 4 +- .../documents/cloudbuild.v2.json | 21 +- .../documents/cloudchannel.v1.json | 2 +- .../documents/cloudcontrolspartner.v1.json | 2 +- .../cloudcontrolspartner.v1beta.json | 2 +- .../documents/clouddeploy.v1.json | 2 +- .../documents/cloudfunctions.v1.json | 2 +- .../documents/cloudfunctions.v2.json | 2 +- .../documents/cloudfunctions.v2alpha.json | 2 +- .../documents/cloudfunctions.v2beta.json | 2 +- .../documents/cloudidentity.v1.json | 2 +- .../documents/cloudidentity.v1beta1.json | 2 +- .../documents/cloudresourcemanager.v1.json | 2 +- .../cloudresourcemanager.v1beta1.json | 2 +- .../documents/cloudresourcemanager.v2.json | 2 +- .../cloudresourcemanager.v2beta1.json | 2 +- .../documents/cloudresourcemanager.v3.json | 2 +- .../documents/cloudsearch.v1.json | 22350 +++------------- .../documents/cloudshell.v1.json | 2 +- .../documents/cloudsupport.v2.json | 2 +- .../documents/cloudsupport.v2beta.json | 2 +- .../documents/composer.v1.json | 2 +- .../documents/composer.v1beta1.json | 2 +- .../documents/compute.alpha.json | 909 +- .../documents/compute.beta.json | 434 +- .../discovery_cache/documents/compute.v1.json | 18 +- .../discovery_cache/documents/config.v1.json | 2 +- .../documents/connectors.v1.json | 12 +- .../documents/connectors.v2.json | 10 +- .../contactcenteraiplatform.v1alpha1.json | 2 +- .../documents/content.v2.1.json | 2 +- .../discovery_cache/documents/css.v1.json | 1216 - .../documents/customsearch.v1.json | 2 +- .../documents/dataform.v1beta1.json | 2 +- .../documents/datalineage.v1.json | 2 +- .../documents/datamigration.v1.json | 2 +- .../documents/datamigration.v1beta1.json | 2 +- .../documents/dataplex.v1.json | 2 +- .../documents/dataportability.v1.json | 2 +- .../documents/dataportability.v1beta.json | 2 +- .../documents/dataproc.v1.json | 2 +- .../documents/datastore.v1.json | 2 +- .../documents/datastore.v1beta1.json | 2 +- .../documents/datastore.v1beta3.json | 2 +- .../documents/datastream.v1.json | 2 +- .../documents/datastream.v1alpha1.json | 2 +- .../documents/developerconnect.v1.json | 2 +- .../documents/dialogflow.v2.json | 271 +- .../documents/dialogflow.v2beta1.json | 152 +- .../documents/dialogflow.v3.json | 222 +- .../documents/dialogflow.v3beta1.json | 222 +- .../documents/digitalassetlinks.v1.json | 2 +- .../documents/discoveryengine.v1.json | 65 +- .../documents/discoveryengine.v1alpha.json | 60 +- .../documents/discoveryengine.v1beta.json | 60 +- .../discovery_cache/documents/dlp.v2.json | 206 +- .../discovery_cache/documents/dns.v1.json | 2 +- .../documents/dns.v1beta2.json | 2 +- .../discovery_cache/documents/docs.v1.json | 2 +- .../documents/documentai.v1.json | 2 +- .../documents/documentai.v1beta2.json | 2 +- .../documents/documentai.v1beta3.json | 2 +- .../documents/domainsrdap.v1.json | 2 +- .../documents/doubleclickbidmanager.v2.json | 2 +- .../documents/doubleclicksearch.v2.json | 2 +- .../discovery_cache/documents/drive.v2.json | 2 +- .../discovery_cache/documents/drive.v3.json | 2 +- .../documents/driveactivity.v2.json | 2 +- .../documents/drivelabels.v2.json | 2 +- .../documents/drivelabels.v2beta.json | 2 +- .../documents/essentialcontacts.v1.json | 5 +- .../documents/factchecktools.v1alpha1.json | 2 +- .../discovery_cache/documents/fcm.v1.json | 2 +- .../documents/fcmdata.v1beta1.json | 2 +- .../discovery_cache/documents/file.v1.json | 2 +- .../documents/file.v1beta1.json | 17 +- .../documents/firebase.v1beta1.json | 2 +- .../documents/firebaseappdistribution.v1.json | 2 +- .../firebaseappdistribution.v1alpha.json | 44 +- .../documents/firebasedatabase.v1beta.json | 2 +- .../documents/firebasedynamiclinks.v1.json | 2 +- .../documents/firebasehosting.v1.json | 2 +- .../documents/firebasehosting.v1beta1.json | 2 +- .../documents/firebaseml.v1.json | 2 +- .../documents/firebaseml.v1beta2.json | 2 +- .../documents/firebaseml.v2beta.json | 2 +- .../documents/firebaserules.v1.json | 2 +- .../documents/firestore.v1.json | 4 +- .../documents/firestore.v1beta1.json | 2 +- .../documents/firestore.v1beta2.json | 2 +- .../discovery_cache/documents/fitness.v1.json | 2 +- .../discovery_cache/documents/forms.v1.json | 2 +- .../documents/gkebackup.v1.json | 2 +- .../discovery_cache/documents/gkehub.v1.json | 211 +- .../documents/gkehub.v1alpha.json | 65 +- .../documents/gkehub.v1beta.json | 50 +- .../documents/gkehub.v1beta1.json | 2 +- .../documents/gkehub.v2alpha.json | 2 +- .../discovery_cache/documents/gmail.v1.json | 2 +- .../documents/gmailpostmastertools.v1.json | 2 +- .../gmailpostmastertools.v1beta1.json | 2 +- .../documents/groupsmigration.v1.json | 2 +- .../discovery_cache/documents/iam.v1.json | 59 +- .../discovery_cache/documents/iam.v2.json | 2 +- .../discovery_cache/documents/iam.v2beta.json | 2 +- .../documents/iamcredentials.v1.json | 2 +- .../discovery_cache/documents/iap.v1.json | 2 +- .../documents/iap.v1beta1.json | 2 +- .../documents/identitytoolkit.v1.json | 2 +- .../documents/identitytoolkit.v2.json | 2 +- .../documents/indexing.v3.json | 2 +- .../documents/integrations.v1.json | 20 +- .../discovery_cache/documents/keep.v1.json | 2 +- .../documents/kmsinventory.v1.json | 2 +- .../documents/language.v1.json | 10 +- .../documents/language.v1beta2.json | 10 +- .../documents/language.v2.json | 10 +- .../documents/libraryagent.v1.json | 2 +- .../documents/licensing.v1.json | 2 +- .../documents/lifesciences.v2beta.json | 2 +- .../documents/localservices.v1.json | 2 +- .../discovery_cache/documents/logging.v2.json | 28 +- .../marketingplatformadmin.v1alpha.json | 2 +- .../discovery_cache/documents/meet.v2.json | 20 +- .../documents/memcache.v1.json | 2 +- .../documents/memcache.v1beta2.json | 2 +- .../merchantapi.accounts_v1beta.json | 468 +- .../merchantapi.conversions_v1beta.json | 2 +- .../merchantapi.datasources_v1beta.json | 2 +- .../merchantapi.inventories_v1beta.json | 2 +- .../documents/merchantapi.lfp_v1beta.json | 2 +- .../merchantapi.notifications_v1beta.json | 2 +- .../merchantapi.products_v1beta.json | 2 +- .../merchantapi.promotions_v1beta.json | 2 +- .../documents/merchantapi.quota_v1beta.json | 2 +- .../documents/merchantapi.reports_v1beta.json | 2 +- .../documents/metastore.v1.json | 36 +- .../documents/metastore.v1alpha.json | 99 +- .../documents/metastore.v1beta.json | 99 +- .../documents/migrationcenter.v1.json | 2 +- .../documents/migrationcenter.v1alpha1.json | 16 +- .../documents/monitoring.v1.json | 10 +- .../documents/monitoring.v3.json | 2 +- .../mybusinessaccountmanagement.v1.json | 2 +- .../mybusinessbusinessinformation.v1.json | 2 +- .../documents/mybusinesslodging.v1.json | 2 +- .../documents/mybusinessnotifications.v1.json | 2 +- .../documents/mybusinessplaceactions.v1.json | 2 +- .../documents/mybusinessqanda.v1.json | 2 +- .../documents/mybusinessverifications.v1.json | 2 +- .../documents/networkconnectivity.v1.json | 2 +- .../networkconnectivity.v1alpha1.json | 2 +- .../documents/networkservices.v1.json | 350 +- .../documents/networkservices.v1beta1.json | 350 +- .../documents/notebooks.v1.json | 2 +- .../documents/notebooks.v2.json | 2 +- .../documents/ondemandscanning.v1.json | 36 +- .../documents/ondemandscanning.v1beta1.json | 36 +- .../documents/orgpolicy.v2.json | 2 +- .../documents/osconfig.v1.json | 2 +- .../documents/osconfig.v1alpha.json | 2 +- .../documents/osconfig.v1beta.json | 2 +- .../discovery_cache/documents/oslogin.v1.json | 2 +- .../documents/oslogin.v1alpha.json | 2 +- .../documents/oslogin.v1beta.json | 2 +- .../documents/pagespeedonline.v5.json | 2 +- .../paymentsresellersubscription.v1.json | 2 +- .../discovery_cache/documents/people.v1.json | 2 +- .../discovery_cache/documents/places.v1.json | 2 +- .../documents/playcustomapp.v1.json | 2 +- .../playdeveloperreporting.v1alpha1.json | 2 +- .../playdeveloperreporting.v1beta1.json | 2 +- .../documents/playgrouping.v1alpha1.json | 2 +- .../documents/playintegrity.v1.json | 74 +- .../documents/policyanalyzer.v1.json | 2 +- .../documents/policyanalyzer.v1beta1.json | 2 +- .../documents/policysimulator.v1.json | 2 +- .../documents/policysimulator.v1alpha.json | 2 +- .../documents/policysimulator.v1beta.json | 2 +- .../documents/policytroubleshooter.v1.json | 2 +- .../policytroubleshooter.v1beta.json | 2 +- .../discovery_cache/documents/pollen.v1.json | 2 +- .../documents/privateca.v1.json | 2 +- .../documents/privateca.v1beta1.json | 2 +- .../documents/publicca.v1.json | 2 +- .../documents/publicca.v1alpha1.json | 2 +- .../documents/publicca.v1beta1.json | 2 +- .../discovery_cache/documents/pubsub.v1.json | 2 +- .../documents/pubsub.v1beta1a.json | 2 +- .../documents/pubsub.v1beta2.json | 2 +- .../documents/pubsublite.v1.json | 2 +- .../readerrevenuesubscriptionlinking.v1.json | 2 +- .../documents/realtimebidding.v1.json | 2 +- .../documents/recaptchaenterprise.v1.json | 2 +- .../documents/recommender.v1.json | 2 +- .../documents/recommender.v1beta1.json | 2 +- .../discovery_cache/documents/redis.v1.json | 2 +- .../documents/redis.v1beta1.json | 2 +- .../documents/reseller.v1.json | 2 +- .../documents/resourcesettings.v1.json | 2 +- .../discovery_cache/documents/retail.v2.json | 12 +- .../documents/retail.v2alpha.json | 22 +- .../documents/retail.v2beta.json | 12 +- .../discovery_cache/documents/run.v1.json | 4 +- .../discovery_cache/documents/run.v2.json | 4 +- .../documents/safebrowsing.v4.json | 2 +- .../documents/safebrowsing.v5.json | 2 +- .../discovery_cache/documents/script.v1.json | 2 +- .../documents/searchconsole.v1.json | 4 +- .../documents/secretmanager.v1.json | 2 +- .../documents/secretmanager.v1beta1.json | 2 +- .../documents/secretmanager.v1beta2.json | 2 +- .../serviceconsumermanagement.v1.json | 4 +- .../serviceconsumermanagement.v1beta1.json | 4 +- .../documents/servicecontrol.v2.json | 2 +- .../documents/servicedirectory.v1.json | 2 +- .../documents/servicedirectory.v1beta1.json | 2 +- .../documents/servicemanagement.v1.json | 2 +- .../documents/servicenetworking.v1.json | 10 +- .../documents/servicenetworking.v1beta.json | 10 +- .../documents/serviceusage.v1.json | 4 +- .../documents/serviceusage.v1beta1.json | 4 +- .../discovery_cache/documents/sheets.v4.json | 10 +- .../discovery_cache/documents/slides.v1.json | 2 +- .../discovery_cache/documents/solar.v1.json | 2 +- .../discovery_cache/documents/spanner.v1.json | 173 +- .../discovery_cache/documents/speech.v1.json | 2 +- .../documents/speech.v1p1beta1.json | 2 +- .../documents/sqladmin.v1.json | 51 +- .../documents/sqladmin.v1beta4.json | 51 +- .../discovery_cache/documents/storage.v1.json | 4 +- .../documents/storagetransfer.v1.json | 2 +- .../documents/streetviewpublish.v1.json | 2 +- .../discovery_cache/documents/sts.v1.json | 7 +- .../discovery_cache/documents/sts.v1beta.json | 2 +- .../documents/tagmanager.v1.json | 2 +- .../documents/tagmanager.v2.json | 2 +- .../discovery_cache/documents/tasks.v1.json | 2 +- .../discovery_cache/documents/testing.v1.json | 2 +- .../documents/texttospeech.v1.json | 2 +- .../documents/texttospeech.v1beta1.json | 2 +- .../documents/toolresults.v1beta3.json | 2 +- .../discovery_cache/documents/tpu.v1.json | 2 +- .../documents/tpu.v1alpha1.json | 2 +- .../discovery_cache/documents/tpu.v2.json | 2 +- .../documents/tpu.v2alpha1.json | 2 +- .../documents/transcoder.v1.json | 2 +- .../documents/travelimpactmodel.v1.json | 2 +- .../discovery_cache/documents/vault.v1.json | 2 +- .../documents/verifiedaccess.v1.json | 2 +- .../documents/verifiedaccess.v2.json | 2 +- .../documents/versionhistory.v1.json | 2 +- .../documents/vmmigration.v1.json | 4 +- .../documents/vmmigration.v1alpha1.json | 4 +- .../documents/walletobjects.v1.json | 2 +- .../discovery_cache/documents/webrisk.v1.json | 2 +- .../documents/websecurityscanner.v1.json | 2 +- .../documents/websecurityscanner.v1alpha.json | 2 +- .../documents/websecurityscanner.v1beta.json | 2 +- .../documents/workflowexecutions.v1.json | 2 +- .../documents/workflowexecutions.v1beta.json | 2 +- .../documents/workloadmanager.v1.json | 6 +- .../documents/workspaceevents.v1.json | 2 +- .../documents/workstations.v1.json | 35 +- .../documents/workstations.v1beta.json | 43 +- .../discovery_cache/documents/youtube.v3.json | 2 +- .../documents/youtubeAnalytics.v2.json | 2 +- .../documents/youtubereporting.v1.json | 2 +- 565 files changed, 9436 insertions(+), 36075 deletions(-) delete mode 100644 docs/dyn/adsenseplatform_v1alpha.html delete mode 100644 docs/dyn/adsenseplatform_v1alpha.platforms.accounts.events.html delete mode 100644 docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html delete mode 100644 docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html delete mode 100644 docs/dyn/adsenseplatform_v1alpha.platforms.html delete mode 100644 docs/dyn/compute_alpha.instantSnapshotGroups.html delete mode 100644 docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html delete mode 100644 docs/dyn/compute_alpha.regionInstantSnapshotGroups.html delete mode 100644 docs/dyn/css_v1.accounts.cssProductInputs.html delete mode 100644 docs/dyn/css_v1.accounts.cssProducts.html delete mode 100644 docs/dyn/css_v1.accounts.html delete mode 100644 docs/dyn/css_v1.accounts.labels.html delete mode 100644 docs/dyn/css_v1.html delete mode 100644 docs/dyn/dialogflow_v2.projects.locations.encryptionSpec.html delete mode 100644 docs/dyn/dialogflow_v2beta1.projects.locations.encryptionSpec.html delete mode 100644 docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html delete mode 100644 docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html delete mode 100644 docs/dyn/merchantapi_accounts_v1beta.accounts.emailpreferences.html delete mode 100644 docs/dyn/playintegrity_v1.deviceRecall.html delete mode 100644 docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html delete mode 100644 googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json delete mode 100644 googleapiclient/discovery_cache/documents/css.v1.json diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html index 558a2d04924..fa9f3f99417 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html @@ -154,7 +154,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -299,7 +299,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -385,7 +385,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -474,7 +474,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -577,7 +577,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index f2fa669849b..4c57a03e76a 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -177,9 +177,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -261,9 +261,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -431,9 +431,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -515,9 +515,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -627,9 +627,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -711,9 +711,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -829,9 +829,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -913,9 +913,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1047,9 +1047,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1131,9 +1131,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html index 2f72e9c9cd6..ba687e92e93 100644 --- a/docs/dyn/admin_directory_v1.users.html +++ b/docs/dyn/admin_directory_v1.users.html @@ -95,7 +95,7 @@

Instance Methods

Retrieves a user.

insert(body=None, resolveConflictAccount=None, x__xgafv=None)

-

Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.

+

Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case.

list(customFieldMask=None, customer=None, domain=None, event=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)

Retrieves a paginated list of either deleted users or all users in a domain.

@@ -228,7 +228,7 @@

Method Details

insert(body=None, resolveConflictAccount=None, x__xgafv=None) -
Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.
+  
Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case.
 
 Args:
   body: object, The request body.
diff --git a/docs/dyn/adsenseplatform_v1alpha.html b/docs/dyn/adsenseplatform_v1alpha.html
deleted file mode 100644
index 9a196ffc224..00000000000
--- a/docs/dyn/adsenseplatform_v1alpha.html
+++ /dev/null
@@ -1,111 +0,0 @@
-
-
-
-

AdSense Platform API

-

Instance Methods

-

- platforms() -

-

Returns the platforms 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/adsenseplatform_v1alpha.platforms.accounts.events.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.events.html deleted file mode 100644 index 3e3ecadc7ec..00000000000 --- a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.events.html +++ /dev/null @@ -1,147 +0,0 @@ - - - -

AdSense Platform API . platforms . accounts . events

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

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

-

Creates an account event.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- create(parent, body=None, x__xgafv=None) -
Creates an account event.
-
-Args:
-  parent: string, Required. Account to log events about. Format: platforms/{platform}/accounts/{account} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # A platform sub-account event to record spam signals.
-  "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
-    "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
-      "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
-      "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
-      "city": "A String", # City. Max length 60 bytes or 30 characters.
-      "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
-      "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
-      "fax": "A String", # Fax number with international code (i.e. +441234567890).
-      "phone": "A String", # Phone number with international code (i.e. +441234567890).
-      "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
-      "state": "A String", # State. Max length 60 bytes or 30 characters.
-      "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
-    },
-    "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
-  },
-  "eventTime": "A String", # Required. Event timestamp.
-  "eventType": "A String", # Required. Event type.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A platform sub-account event to record spam signals.
-  "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
-    "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
-      "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
-      "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
-      "city": "A String", # City. Max length 60 bytes or 30 characters.
-      "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
-      "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
-      "fax": "A String", # Fax number with international code (i.e. +441234567890).
-      "phone": "A String", # Phone number with international code (i.e. +441234567890).
-      "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
-      "state": "A String", # State. Max length 60 bytes or 30 characters.
-      "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
-    },
-    "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
-  },
-  "eventTime": "A String", # Required. Event timestamp.
-  "eventType": "A String", # Required. Event type.
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html deleted file mode 100644 index d2be5261406..00000000000 --- a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html +++ /dev/null @@ -1,271 +0,0 @@ - - - -

AdSense Platform API . platforms . accounts

-

Instance Methods

-

- events() -

-

Returns the events Resource.

- -

- sites() -

-

Returns the sites Resource.

- -

- close(name, body=None, x__xgafv=None)

-

Closes a sub-account.

-

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

-

Creates a sub-account.

-

- get(name, x__xgafv=None)

-

Gets information about the selected sub-account.

-

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

-

Lists a partial view of sub-accounts for a specific parent account.

-

- list_next()

-

Retrieves the next page of results.

-

- lookup(parent, creationRequestId=None, x__xgafv=None)

-

Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.

-

Method Details

-
- close(name, body=None, x__xgafv=None) -
Closes a sub-account.
-
-Args:
-  name: string, Required. Account to close. Format: platforms/{platform}/accounts/{account_id} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request definition for the account close rpc.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response definition for the account close rpc.
-}
-
- -
- create(parent, body=None, x__xgafv=None) -
Creates a sub-account.
-
-Args:
-  parent: string, Required. Platform to create an account for. Format: platforms/{platform} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Representation of an Account.
-  "createTime": "A String", # Output only. Creation time of the account.
-  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
-  "displayName": "A String", # Display name of this account.
-  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
-  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
-  "state": "A String", # Output only. Approval state of the account.
-  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
-    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
-    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
-  },
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Representation of an Account.
-  "createTime": "A String", # Output only. Creation time of the account.
-  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
-  "displayName": "A String", # Display name of this account.
-  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
-  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
-  "state": "A String", # Output only. Approval state of the account.
-  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
-    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
-    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
-  },
-}
-
- -
- get(name, x__xgafv=None) -
Gets information about the selected sub-account.
-
-Args:
-  name: string, Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id} (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Representation of an Account.
-  "createTime": "A String", # Output only. Creation time of the account.
-  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
-  "displayName": "A String", # Display name of this account.
-  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
-  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
-  "state": "A String", # Output only. Approval state of the account.
-  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
-    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
-    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
-  },
-}
-
- -
- list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists a partial view of sub-accounts for a specific parent account.
-
-Args:
-  parent: string, Required. Platform who parents the accounts. Format: platforms/{platform} (required)
-  pageSize: integer, Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
-  pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response definition for the list accounts rpc.
-  "accounts": [ # The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.
-    { # Representation of an Account.
-      "createTime": "A String", # Output only. Creation time of the account.
-      "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
-      "displayName": "A String", # Display name of this account.
-      "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
-      "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
-      "state": "A String", # Output only. Approval state of the account.
-      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
-        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
-        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
-      },
-    },
-  ],
-  "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
-}
-
- -
- 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.
-        
-
- -
- lookup(parent, creationRequestId=None, x__xgafv=None) -
Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
-
-Args:
-  parent: string, Required. Platform who parents the account. Format: platforms/{platform} (required)
-  creationRequestId: string, Optional. The creation_request_id provided when calling createAccount.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response definition for the lookup account rpc.
-  "name": "A String", # The name of the Account Format: platforms/{platform}/accounts/{account_id}
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html deleted file mode 100644 index e3f66b86721..00000000000 --- a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html +++ /dev/null @@ -1,233 +0,0 @@ - - - -

AdSense Platform API . platforms . accounts . sites

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

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

-

Creates a site for a specified account.

-

- delete(name, x__xgafv=None)

-

Deletes a site from a specified account.

-

- get(name, x__xgafv=None)

-

Gets a site from a specified sub-account.

-

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

-

Lists sites for a specific account.

-

- list_next()

-

Retrieves the next page of results.

-

- requestReview(name, x__xgafv=None)

-

Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- create(parent, body=None, x__xgafv=None) -
Creates a site for a specified account.
-
-Args:
-  parent: string, Required. Account to create site. Format: platforms/{platform}/accounts/{account_id} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Representation of a Site.
-  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
-  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
-  "state": "A String", # Output only. State of a site.
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Representation of a Site.
-  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
-  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
-  "state": "A String", # Output only. State of a site.
-}
-
- -
- delete(name, x__xgafv=None) -
Deletes a site from a specified account.
-
-Args:
-  name: string, Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
-}
-
- -
- get(name, x__xgafv=None) -
Gets a site from a specified sub-account.
-
-Args:
-  name: string, Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Representation of a Site.
-  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
-  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
-  "state": "A String", # Output only. State of a site.
-}
-
- -
- list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists sites for a specific account.
-
-Args:
-  parent: string, Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account} (required)
-  pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
-  pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response definition for the site list rpc.
-  "nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this.
-  "sites": [ # The sites returned in this list response.
-    { # Representation of a Site.
-      "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
-      "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
-      "state": "A String", # Output only. State of a site.
-    },
-  ],
-}
-
- -
- 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.
-        
-
- -
- requestReview(name, x__xgafv=None) -
Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.
-
-Args:
-  name: string, Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response definition for the site request review rpc.
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.html b/docs/dyn/adsenseplatform_v1alpha.platforms.html deleted file mode 100644 index dea2d7dab99..00000000000 --- a/docs/dyn/adsenseplatform_v1alpha.platforms.html +++ /dev/null @@ -1,91 +0,0 @@ - - - -

AdSense Platform API . platforms

-

Instance Methods

-

- accounts() -

-

Returns the accounts Resource.

- -

- close()

-

Close httplib2 connections.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- - \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 066cb53dcd4..15a076e84f3 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -158,7 +158,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Optional. Input content. + "contents": [ # Required. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -192,10 +192,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -231,7 +231,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Optional. Input content. + "contents": [ # Required. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -265,88 +265,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "fileData": { # URI based data. # Optional. URI based data. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. - "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. - "a_key": "", # Properties of the object. - }, - }, - "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "text": "A String", # Optional. Text part (can be code). - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. - "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "default": "", # Optional. Default value of the data. - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - }, - ], - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. - "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - }, - }, - }, - ], + "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` } x__xgafv: string, V1 error format. @@ -1411,6 +1333,21 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "groundingAttributions": [ # Optional. List of grounding attributions. + { # Grounding attribution. + "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. + "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. + "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + "partIndex": 42, # Output only. The index of a Part object within its parent Content object. + "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + "text": "A String", # Output only. The text corresponding to the segment from the response. + }, + "web": { # Attribution from the web. # Optional. Attribution from the web. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + }, + ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1458,7 +1395,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -2978,6 +2914,21 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "groundingAttributions": [ # Optional. List of grounding attributions. + { # Grounding attribution. + "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. + "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. + "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + "partIndex": 42, # Output only. The index of a Part object within its parent Content object. + "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + "text": "A String", # Output only. The text corresponding to the segment from the response. + }, + "web": { # Attribution from the web. # Optional. Attribution from the web. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + }, + ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -3025,7 +2976,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html index a0ec7bf8358..d753195ab0f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html @@ -82,273 +82,10 @@

Instance Methods

close()

Close httplib2 connections.

-

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

-

Creates a NotebookExecutionJob.

-

- delete(name, x__xgafv=None)

-

Deletes a NotebookExecutionJob.

-

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

-

Gets a NotebookExecutionJob.

-

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

-

Lists NotebookExecutionJobs in a Location.

-

- list_next()

-

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
-
- create(parent, body=None, notebookExecutionJobId=None, x__xgafv=None) -
Creates a NotebookExecutionJob.
-
-Args:
-  parent: string, Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # NotebookExecutionJob represents an instance of a notebook execution.
-  "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
-  "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
-    "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
-    "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
-  },
-  "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
-    "content": "A String", # The base64-encoded contents of the input notebook file.
-  },
-  "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
-  "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
-  "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
-  "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
-    "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
-    "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
-  },
-  "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
-  "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
-  "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
-  "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
-  "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
-  "serviceAccount": "A String", # The service account to run the execution as.
-  "status": { # 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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
-    "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.
-  },
-  "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
-}
-
-  notebookExecutionJobId: string, Optional. User specified ID for the NotebookExecutionJob.
-  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, x__xgafv=None) -
Deletes a NotebookExecutionJob.
-
-Args:
-  name: string, Required. The name of the NotebookExecutionJob resource to be deleted. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
-  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- get(name, view=None, x__xgafv=None) -
Gets a NotebookExecutionJob.
-
-Args:
-  name: string, Required. The name of the NotebookExecutionJob resource. (required)
-  view: string, Optional. The NotebookExecutionJob view. Defaults to BASIC.
-    Allowed values
-      NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED - When unspecified, the API defaults to the BASIC view.
-      NOTEBOOK_EXECUTION_JOB_VIEW_BASIC - Includes all fields except for direct notebook inputs.
-      NOTEBOOK_EXECUTION_JOB_VIEW_FULL - Includes all fields.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # NotebookExecutionJob represents an instance of a notebook execution.
-  "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
-  "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
-    "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
-    "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
-  },
-  "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
-    "content": "A String", # The base64-encoded contents of the input notebook file.
-  },
-  "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
-  "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
-  "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
-  "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
-    "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
-    "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
-  },
-  "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
-  "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
-  "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
-  "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
-  "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
-  "serviceAccount": "A String", # The service account to run the execution as.
-  "status": { # 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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
-    "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.
-  },
-  "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
-}
-
- -
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) -
Lists NotebookExecutionJobs in a Location.
-
-Args:
-  parent: string, Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}` (required)
-  filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
-  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
-  pageSize: integer, Optional. The standard list page size.
-  pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.
-  view: string, Optional. The NotebookExecutionJob view. Defaults to BASIC.
-    Allowed values
-      NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED - When unspecified, the API defaults to the BASIC view.
-      NOTEBOOK_EXECUTION_JOB_VIEW_BASIC - Includes all fields except for direct notebook inputs.
-      NOTEBOOK_EXECUTION_JOB_VIEW_FULL - Includes all fields.
-  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 [NotebookService.CreateNotebookExecutionJob]
-  "nextPageToken": "A String", # A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page.
-  "notebookExecutionJobs": [ # List of NotebookExecutionJobs in the requested page.
-    { # NotebookExecutionJob represents an instance of a notebook execution.
-      "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
-      "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
-        "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
-        "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
-      },
-      "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
-        "content": "A String", # The base64-encoded contents of the input notebook file.
-      },
-      "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
-      "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
-      "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
-      "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
-        "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
-        "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
-      },
-      "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
-      "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
-      "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
-        "a_key": "A String",
-      },
-      "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
-      "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
-      "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
-      "serviceAccount": "A String", # The service account to run the execution as.
-      "status": { # 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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
-        "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.
-      },
-      "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
-    },
-  ],
-}
-
- -
- list_next() -
Retrieves the next page of results.
-
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
-
-        Returns:
-          A request object that you can call 'execute()' on to request the next
-          page. Returns None if there are no more items in the collection.
-        
-
- \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html index d189511040c..3159bb89dd7 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html +++ b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html @@ -171,9 +171,6 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. - "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. - "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. - }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -323,9 +320,6 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. - "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. - "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. - }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -416,9 +410,6 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. - "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. - "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. - }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -515,9 +506,6 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. - "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. - "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. - }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index d9ee081c389..7ef17416903 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -117,7 +117,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Optional. Input content. + "contents": [ # Required. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -151,10 +151,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -190,7 +190,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Optional. Input content. + "contents": [ # Required. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -224,88 +224,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "fileData": { # URI based data. # Optional. URI based data. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. - "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. - "a_key": "", # Properties of the object. - }, - }, - "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "text": "A String", # Optional. Text part (can be code). - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. - "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "default": "", # Optional. Default value of the data. - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema - }, - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - }, - ], - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. - "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - }, - }, - }, - ], + "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` } x__xgafv: string, V1 error format. @@ -564,6 +486,21 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "groundingAttributions": [ # Optional. List of grounding attributions. + { # Grounding attribution. + "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. + "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. + "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + "partIndex": 42, # Output only. The index of a Part object within its parent Content object. + "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + "text": "A String", # Output only. The text corresponding to the segment from the response. + }, + "web": { # Attribution from the web. # Optional. Attribution from the web. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + }, + ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -611,7 +548,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1142,6 +1078,21 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "groundingAttributions": [ # Optional. List of grounding attributions. + { # Grounding attribution. + "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. + "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. + "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + "partIndex": 42, # Output only. The index of a Part object within its parent Content object. + "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + "text": "A String", # Output only. The text corresponding to the segment from the response. + }, + "web": { # Attribution from the web. # Optional. Attribution from the web. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + }, + ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1189,7 +1140,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 9b5142c348c..8f82d31a3db 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -172,7 +172,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Optional. Input content. + "contents": [ # Required. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -206,10 +206,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -245,7 +245,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Optional. Input content. + "contents": [ # Required. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -279,131 +279,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "fileData": { # URI based data. # Optional. URI based data. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. - "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. - "a_key": "", # Properties of the object. - }, - }, - "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "text": "A String", # Optional. Text part (can be code). - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. - "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "default": "", # Optional. Default value of the data. - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "default": "", # Optional. Default value of the data. - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - }, - ], - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. - "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. - "A String", - ], - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - }, - ], + "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` } x__xgafv: string, V1 error format. @@ -1650,6 +1529,25 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "groundingAttributions": [ # Optional. List of grounding attributions. + { # Grounding attribution. + "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. + "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. + "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + "partIndex": 42, # Output only. The index of a Part object within its parent Content object. + "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + "text": "A String", # Output only. The text corresponding to the segment from the response. + }, + "web": { # Attribution from the web. # Optional. Attribution from the web. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + }, + ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1700,7 +1598,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -3381,6 +3278,25 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "groundingAttributions": [ # Optional. List of grounding attributions. + { # Grounding attribution. + "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. + "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. + "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + "partIndex": 42, # Output only. The index of a Part object within its parent Content object. + "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + "text": "A String", # Output only. The text corresponding to the segment from the response. + }, + "web": { # Attribution from the web. # Optional. Attribution from the web. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + }, + ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -3431,7 +3347,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html index d00fd6e9c86..395f3abe671 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html @@ -172,9 +172,6 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. - "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. - "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. - }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -325,9 +322,6 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. - "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. - "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. - }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -419,9 +413,6 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. - "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. - "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. - }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -519,9 +510,6 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. - "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. - "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. - }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index c8a82f10756..cb2c9f05c0d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -120,7 +120,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Optional. Input content. + "contents": [ # Required. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -154,10 +154,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -193,7 +193,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Optional. Input content. + "contents": [ # Required. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -227,131 +227,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` - "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. - "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. - { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. - "fileData": { # URI based data. # Optional. URI based data. - "fileUri": "A String", # Required. URI. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. - "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. - "a_key": "", # Properties of the object. - }, - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. - }, - "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. - "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. - "response": { # Required. The function response in JSON object format. - "a_key": "", # Properties of the object. - }, - }, - "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. - "data": "A String", # Required. Raw bytes. - "mimeType": "A String", # Required. The IANA standard MIME type of the source data. - }, - "text": "A String", # Optional. Text part (can be code). - "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. - "endOffset": "A String", # Optional. The end offset of the video. - "startOffset": "A String", # Optional. The start offset of the video. - }, - }, - ], - "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. - }, - "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. - { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). - "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. - { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. - "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. - "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. - "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 - "default": "", # Optional. Default value of the data. - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. - "default": "", # Optional. Default value of the data. - "description": "A String", # Optional. The description of the data. - "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} - "A String", - ], - "example": "", # Optional. Example of the object. Will only populated when the object is the root. - "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc - "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. - "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. - "maxLength": "A String", # Optional. Maximum length of the Type.STRING - "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. - "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER - "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. - "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING - "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. - "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER - "nullable": True or False, # Optional. Indicates if the value may be null. - "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. - "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. - "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema - }, - "required": [ # Optional. Required properties of Type.OBJECT. - "A String", - ], - "title": "A String", # Optional. The title of the Schema. - "type": "A String", # Optional. The type of the data. - }, - }, - ], - "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. - }, - "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. - "vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search. - "datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}` - }, - "vertexRagStore": { # Retrieve from Vertex RAG Store for grounding. # Set to use data source powered by Vertex RAG store. User data is uploaded via the VertexRagDataService. - "ragCorpora": [ # Optional. Deprecated. Please use rag_resources instead. - "A String", - ], - "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. - { # The definition of the Rag resource. - "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` - "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. - "A String", - ], - }, - ], - "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. - "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. - }, - }, - }, - ], + "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` } x__xgafv: string, V1 error format. @@ -654,6 +533,25 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "groundingAttributions": [ # Optional. List of grounding attributions. + { # Grounding attribution. + "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. + "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. + "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + "partIndex": 42, # Output only. The index of a Part object within its parent Content object. + "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + "text": "A String", # Output only. The text corresponding to the segment from the response. + }, + "web": { # Attribution from the web. # Optional. Attribution from the web. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + }, + ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -704,7 +602,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1314,6 +1211,25 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. + "groundingAttributions": [ # Optional. List of grounding attributions. + { # Grounding attribution. + "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. + "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. + "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. + "partIndex": 42, # Output only. The index of a Part object within its parent Content object. + "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. + "text": "A String", # Output only. The text corresponding to the segment from the response. + }, + "web": { # Attribution from the web. # Optional. Attribution from the web. + "title": "A String", # Output only. Title of the attribution. + "uri": "A String", # Output only. URI reference of the attribution. + }, + }, + ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1364,7 +1280,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html index 3beb3dcec17..23e2ba6562b 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html @@ -79,6 +79,11 @@

Instance Methods

Returns the eventCreateRules Resource.

+

+ eventEditRules() +

+

Returns the eventEditRules Resource.

+

measurementProtocolSecrets()

diff --git a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html index ffa13534241..b3a1636bb64 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html @@ -74,6 +74,11 @@

Google Analytics Admin API . properties . dataStreams

Instance Methods

+

+ eventEditRules() +

+

Returns the eventEditRules Resource.

+

measurementProtocolSecrets()

diff --git a/docs/dyn/androidpublisher_v3.apprecovery.html b/docs/dyn/androidpublisher_v3.apprecovery.html index 28ad483e802..7a7c4a08757 100644 --- a/docs/dyn/androidpublisher_v3.apprecovery.html +++ b/docs/dyn/androidpublisher_v3.apprecovery.html @@ -77,6 +77,9 @@

Instance Methods

addTargeting(packageName, appRecoveryId, body=None, x__xgafv=None)

Incrementally update targeting for a recovery action. Note that only the criteria selected during the creation of recovery action can be expanded.

+

+ appRecoveries(packageName, versionCode=None, x__xgafv=None)

+

List all app recovery action resources associated with a particular package name and app version.

cancel(packageName, appRecoveryId, body=None, x__xgafv=None)

Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.

@@ -89,9 +92,6 @@

Instance Methods

deploy(packageName, appRecoveryId, body=None, x__xgafv=None)

Deploy an already created app recovery action with recovery status DRAFT. Note that this action activates the recovery action for all targeted users and changes its status to ACTIVE.

-

- list(packageName, versionCode=None, x__xgafv=None)

-

List all app recovery action resources associated with a particular package name and app version.

Method Details

addTargeting(packageName, appRecoveryId, body=None, x__xgafv=None) @@ -133,6 +133,68 @@

Method Details

}
+
+ appRecoveries(packageName, versionCode=None, x__xgafv=None) +
List all app recovery action resources associated with a particular package name and app version.
+
+Args:
+  packageName: string, Required. Package name of the app for which list of recovery actions is requested. (required)
+  versionCode: string, Required. Version code targeted by the list of recovery actions.
+  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 ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled
+  "recoveryActions": [ # List of recovery actions associated with the requested package name.
+    { # Information about an app recovery action.
+      "appRecoveryId": "A String", # ID corresponding to the app recovery action.
+      "cancelTime": "A String", # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled.
+      "createTime": "A String", # Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action.
+      "deployTime": "A String", # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed.
+      "lastUpdateTime": "A String", # Timestamp of when the developer last updated recovery action. In case the action is cancelled, it corresponds to cancellation time. It is always set after creation of the recovery action.
+      "remoteInAppUpdateData": { # Data related to Remote In-App Update action such as recovered user count, affected user count etc. # Data about the remote in-app update action such as such as recovered user base, recoverable user base etc. Set only if the recovery action type is Remote In-App Update.
+        "remoteAppUpdateDataPerBundle": [ # Data related to the recovery action at bundle level.
+          { # Data related to the recovery action at bundle level.
+            "recoveredDeviceCount": "A String", # Total number of devices which have been rescued.
+            "totalDeviceCount": "A String", # Total number of devices affected by this recovery action associated with bundle of the app.
+            "versionCode": "A String", # Version Code corresponding to the target bundle.
+          },
+        ],
+      },
+      "status": "A String", # The status of the recovery action.
+      "targeting": { # Targeting details for a recovery action such as regions, android sdk levels, app versions etc. # Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc.
+        "allUsers": { # Object representation to describe all set of users. # All users are targeted.
+          "isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed.
+        },
+        "androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices.
+          "sdkLevels": [ # Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android.
+            "A String",
+          ],
+        },
+        "regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region.
+          "regionCode": [ # Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes.
+            "A String",
+          ],
+        },
+        "versionList": { # Data format for a list of app versions. # Target version codes as a list.
+          "versionCodes": [ # List of app version codes.
+            "A String",
+          ],
+        },
+        "versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range.
+          "versionCodeEnd": "A String", # Highest app version in the range, inclusive.
+          "versionCodeStart": "A String", # Lowest app version in the range, inclusive.
+        },
+      },
+    },
+  ],
+}
+
+
cancel(packageName, appRecoveryId, body=None, x__xgafv=None)
Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.
@@ -278,66 +340,4 @@ 

Method Details

}
-
- list(packageName, versionCode=None, x__xgafv=None) -
List all app recovery action resources associated with a particular package name and app version.
-
-Args:
-  packageName: string, Required. Package name of the app for which list of recovery actions is requested. (required)
-  versionCode: string, Required. Version code targeted by the list of recovery actions.
-  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 ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled
-  "recoveryActions": [ # List of recovery actions associated with the requested package name.
-    { # Information about an app recovery action.
-      "appRecoveryId": "A String", # ID corresponding to the app recovery action.
-      "cancelTime": "A String", # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled.
-      "createTime": "A String", # Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action.
-      "deployTime": "A String", # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed.
-      "lastUpdateTime": "A String", # Timestamp of when the developer last updated recovery action. In case the action is cancelled, it corresponds to cancellation time. It is always set after creation of the recovery action.
-      "remoteInAppUpdateData": { # Data related to Remote In-App Update action such as recovered user count, affected user count etc. # Data about the remote in-app update action such as such as recovered user base, recoverable user base etc. Set only if the recovery action type is Remote In-App Update.
-        "remoteAppUpdateDataPerBundle": [ # Data related to the recovery action at bundle level.
-          { # Data related to the recovery action at bundle level.
-            "recoveredDeviceCount": "A String", # Total number of devices which have been rescued.
-            "totalDeviceCount": "A String", # Total number of devices affected by this recovery action associated with bundle of the app.
-            "versionCode": "A String", # Version Code corresponding to the target bundle.
-          },
-        ],
-      },
-      "status": "A String", # The status of the recovery action.
-      "targeting": { # Targeting details for a recovery action such as regions, android sdk levels, app versions etc. # Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc.
-        "allUsers": { # Object representation to describe all set of users. # All users are targeted.
-          "isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed.
-        },
-        "androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices.
-          "sdkLevels": [ # Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android.
-            "A String",
-          ],
-        },
-        "regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region.
-          "regionCode": [ # Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes.
-            "A String",
-          ],
-        },
-        "versionList": { # Data format for a list of app versions. # Target version codes as a list.
-          "versionCodes": [ # List of app version codes.
-            "A String",
-          ],
-        },
-        "versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range.
-          "versionCodeEnd": "A String", # Highest app version in the range, inclusive.
-          "versionCodeStart": "A String", # Lowest app version in the range, inclusive.
-        },
-      },
-    },
-  ],
-}
-
- \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.externaltransactions.html b/docs/dyn/androidpublisher_v3.externaltransactions.html index 9bbb8ffa422..87b674c4392 100644 --- a/docs/dyn/androidpublisher_v3.externaltransactions.html +++ b/docs/dyn/androidpublisher_v3.externaltransactions.html @@ -136,7 +136,7 @@

Method Details

}, "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. }, - "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. + "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. "transactionState": "A String", # Output only. The current state of the transaction. "transactionTime": "A String", # Required. The time when the transaction was completed. "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. @@ -189,7 +189,7 @@

Method Details

}, "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. }, - "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. + "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. "transactionState": "A String", # Output only. The current state of the transaction. "transactionTime": "A String", # Required. The time when the transaction was completed. "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. @@ -248,7 +248,7 @@

Method Details

}, "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. }, - "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. + "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. "transactionState": "A String", # Output only. The current state of the transaction. "transactionTime": "A String", # Required. The time when the transaction was completed. "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. @@ -323,7 +323,7 @@

Method Details

}, "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. }, - "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. + "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. "transactionState": "A String", # Output only. The current state of the transaction. "transactionTime": "A String", # Required. The time when the transaction was completed. "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html index 4bcdb61c3a4..0ff14748d2c 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html @@ -97,7 +97,7 @@

Method Details

{ # The request to upload a generic artifact. The created GenericArtifact will have the resource name {parent}/genericArtifacts/package_id:version_id. The created file will have the resource name {parent}/files/package_id:version_id:filename. "filename": "A String", # The name of the file of the generic artifact to be uploaded. E.g. `example-file.zip` The filename is limited to letters, numbers, and url safe characters, i.e. [a-zA-Z0-9-_.~@]. - "packageId": "A String", # The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` should start and end with a letter or number, only contain letters, numbers, hyphens, underscores, and periods, and not exceed 256 characters. + "packageId": "A String", # The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters. "versionId": "A String", # The ID of the version of the generic artifact. If the version does not exist, a new version will be created. The version_id must start and end with a letter or number, can only contain lowercase letters, numbers, hyphens and periods, i.e. [a-z0-9-.] and cannot exceed a total of 128 characters. Creating a version called `latest` is not allowed. } diff --git a/docs/dyn/batch_v1.projects.locations.jobs.html b/docs/dyn/batch_v1.projects.locations.jobs.html index 2f501200062..e292439499d 100644 --- a/docs/dyn/batch_v1.projects.locations.jobs.html +++ b/docs/dyn/batch_v1.projects.locations.jobs.html @@ -213,13 +213,13 @@

Method Details

"runDuration": "A String", # The duration of time that the Job spent in status RUNNING. "state": "A String", # Job state "statusEvents": [ # Job status events - { # Status event. + { # Status event "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State. This field is only defined for task-level status events. + "taskState": "A String", # Task State "type": "A String", # Type of the event. }, ], @@ -482,13 +482,13 @@

Method Details

"runDuration": "A String", # The duration of time that the Job spent in status RUNNING. "state": "A String", # Job state "statusEvents": [ # Job status events - { # Status event. + { # Status event "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State. This field is only defined for task-level status events. + "taskState": "A String", # Task State "type": "A String", # Type of the event. }, ], @@ -793,13 +793,13 @@

Method Details

"runDuration": "A String", # The duration of time that the Job spent in status RUNNING. "state": "A String", # Job state "statusEvents": [ # Job status events - { # Status event. + { # Status event "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State. This field is only defined for task-level status events. + "taskState": "A String", # Task State "type": "A String", # Type of the event. }, ], @@ -1073,13 +1073,13 @@

Method Details

"runDuration": "A String", # The duration of time that the Job spent in status RUNNING. "state": "A String", # Job state "statusEvents": [ # Job status events - { # Status event. + { # Status event "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State. This field is only defined for task-level status events. + "taskState": "A String", # Task State "type": "A String", # Type of the event. }, ], diff --git a/docs/dyn/batch_v1.projects.locations.jobs.taskGroups.tasks.html b/docs/dyn/batch_v1.projects.locations.jobs.taskGroups.tasks.html index 70988349623..960050f9a90 100644 --- a/docs/dyn/batch_v1.projects.locations.jobs.taskGroups.tasks.html +++ b/docs/dyn/batch_v1.projects.locations.jobs.taskGroups.tasks.html @@ -108,16 +108,16 @@

Method Details

{ # A Cloud Batch task. "name": "A String", # Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01". - "status": { # Status of a task. # Task Status. - "state": "A String", # Task state. + "status": { # Status of a task # Task Status. + "state": "A String", # Task state "statusEvents": [ # Detailed info about why the state is reached. - { # Status event. + { # Status event "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State. This field is only defined for task-level status events. + "taskState": "A String", # Task State "type": "A String", # Type of the event. }, ], @@ -147,16 +147,16 @@

Method Details

"tasks": [ # Tasks. { # A Cloud Batch task. "name": "A String", # Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01". - "status": { # Status of a task. # Task Status. - "state": "A String", # Task state. + "status": { # Status of a task # Task Status. + "state": "A String", # Task state "statusEvents": [ # Detailed info about why the state is reached. - { # Status event. + { # Status event "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State. This field is only defined for task-level status events. + "taskState": "A String", # Task State "type": "A String", # Type of the event. }, ], diff --git a/docs/dyn/batch_v1.projects.locations.state.html b/docs/dyn/batch_v1.projects.locations.state.html index af2c1eb10d2..9552d1ffc75 100644 --- a/docs/dyn/batch_v1.projects.locations.state.html +++ b/docs/dyn/batch_v1.projects.locations.state.html @@ -105,16 +105,16 @@

Method Details

{ # Task Info "runnable": "A String", # The highest index of a runnable started by the agent for this task. The runnables are indexed from 1. Value 0 is undefined. "taskId": "A String", # ID of the Task - "taskStatus": { # Status of a task. # The status of the Task. If we need agent specific fields we should fork the public TaskStatus into an agent specific one. Or add them below. - "state": "A String", # Task state. + "taskStatus": { # Status of a task # The status of the Task. If we need agent specific fields we should fork the public TaskStatus into an agent specific one. Or add them below. + "state": "A String", # Task state "statusEvents": [ # Detailed info about why the state is reached. - { # Status event. + { # Status event "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State. This field is only defined for task-level status events. + "taskState": "A String", # Task State "type": "A String", # Type of the event. }, ], @@ -308,16 +308,16 @@

Method Details

}, ], }, - "status": { # Status of a task. # Task status. - "state": "A String", # Task state. + "status": { # Status of a task # Task status. + "state": "A String", # Task state "statusEvents": [ # Detailed info about why the state is reached. - { # Status event. + { # Status event "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State. This field is only defined for task-level status events. + "taskState": "A String", # Task State "type": "A String", # Type of the event. }, ], diff --git a/docs/dyn/beyondcorp_v1alpha.organizations.locations.insights.html b/docs/dyn/beyondcorp_v1alpha.organizations.locations.insights.html index b10c144d302..22e2af1b8bd 100644 --- a/docs/dyn/beyondcorp_v1alpha.organizations.locations.insights.html +++ b/docs/dyn/beyondcorp_v1alpha.organizations.locations.insights.html @@ -249,7 +249,7 @@

Method Details

Args: parent: string, Required. The resource name of InsightMetadata using the form: `organizations/{organization_id}/locations/{location}` `projects/{project_id}/locations/{location_id}` (required) - filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). + filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). orderBy: string, Optional. Hint for how to order the results. This is currently ignored. pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50. pageToken: string, Optional. A token identifying a page of results the server should return. diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.insights.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.insights.html index 6ce7bc89c0a..f5f265c13fb 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.insights.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.insights.html @@ -249,7 +249,7 @@

Method Details

Args: parent: string, Required. The resource name of InsightMetadata using the form: `organizations/{organization_id}/locations/{location}` `projects/{project_id}/locations/{location_id}` (required) - filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). + filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). orderBy: string, Optional. Hint for how to order the results. This is currently ignored. pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50. pageToken: string, Optional. A token identifying a page of results the server should return. diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html index 6a341c28e0d..dc8892bdd22 100644 --- a/docs/dyn/bigquery_v2.datasets.html +++ b/docs/dyn/bigquery_v2.datasets.html @@ -158,13 +158,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -260,13 +260,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -360,13 +360,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -520,13 +520,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -620,13 +620,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -735,13 +735,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -838,13 +838,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -938,13 +938,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 72773ff7108..b8f7834e669 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -417,7 +417,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -1815,7 +1815,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -3289,7 +3289,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -4658,7 +4658,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -6050,7 +6050,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index 405765143ad..f2c9865ad09 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -206,7 +206,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -678,7 +678,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -1091,7 +1091,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -1612,7 +1612,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -2026,7 +2026,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -2558,7 +2558,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -2972,7 +2972,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. diff --git a/docs/dyn/calendar_v3.events.html b/docs/dyn/calendar_v3.events.html index be076afef8d..f0fbbf739b9 100644 --- a/docs/dyn/calendar_v3.events.html +++ b/docs/dyn/calendar_v3.events.html @@ -376,7 +376,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -413,7 +413,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -672,7 +672,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -709,7 +709,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -963,7 +963,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -1000,7 +1000,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -1258,7 +1258,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -1295,7 +1295,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -1558,7 +1558,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -1595,7 +1595,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -1884,7 +1884,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -1921,7 +1921,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -2275,7 +2275,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -2312,7 +2312,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -2603,7 +2603,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -2640,7 +2640,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -2899,7 +2899,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -2936,7 +2936,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -3200,7 +3200,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -3237,7 +3237,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -3505,7 +3505,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -3542,7 +3542,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -3801,7 +3801,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -3838,7 +3838,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -4102,7 +4102,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. + "reminders": { # Information about the event's reminders for the authenticated user. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -4139,7 +4139,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. + "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 4b2bc501b9e..d60901f745d 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -149,12 +149,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The import mode space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -183,12 +183,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -216,12 +216,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -273,12 +273,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -312,12 +312,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -356,12 +356,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -406,12 +406,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -427,7 +427,7 @@

Method Details

"type": "A String", # Output only. Deprecated: Use `space_type` instead. The type of a space. } - updateMask: string, Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. + updateMask: string, Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error. If you receive the error message `ALREADY_EXISTS` when updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error). `space_type` is not supported with admin access. - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.) `space_history_state` is not supported with admin access. - `access_settings.audience` (Supports changing the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -439,12 +439,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -493,12 +493,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Required. The `Space.spaceType` field is required. To create a space, set `Space.spaceType` to `SPACE` and set `Space.displayName`. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. To create a group chat, set `Space.spaceType` to `GROUP_CHAT`. Don't set `Space.displayName`. To create a 1:1 conversation between humans, set `Space.spaceType` to `DIRECT_MESSAGE` and set `Space.singleUserBotDm` to `false`. Don't set `Space.displayName` or `Space.spaceDetails`. To create an 1:1 conversation between a human and the calling Chat app, set `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`. Don't set `Space.displayName` or `Space.spaceDetails`. If a `DIRECT_MESSAGE` space already exists, that space is returned instead of creating a new space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -526,12 +526,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index 2e3b0337bdd..a27cfced554 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -1853,12 +1853,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -3627,12 +3627,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -5419,12 +5419,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -7199,12 +7199,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -8984,12 +8984,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -10752,12 +10752,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -12520,12 +12520,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -14288,12 +14288,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 71bca4dc5e4..bad59df17dd 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -1968,12 +1968,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -3731,12 +3731,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -5494,12 +5494,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -7255,12 +7255,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -9014,12 +9014,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -10773,12 +10773,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -10888,12 +10888,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -10915,12 +10915,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -12821,12 +12821,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -14584,12 +14584,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -16347,12 +16347,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -18108,12 +18108,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -19867,12 +19867,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -21626,12 +21626,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -21741,12 +21741,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -21768,12 +21768,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. diff --git a/docs/dyn/chromemanagement_v1.customers.reports.html b/docs/dyn/chromemanagement_v1.customers.reports.html index 2cf118d0d2b..018ba0b2858 100644 --- a/docs/dyn/chromemanagement_v1.customers.reports.html +++ b/docs/dyn/chromemanagement_v1.customers.reports.html @@ -340,8 +340,8 @@

Method Details

Args: customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) - filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions - orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions + filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id + orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id orgUnitId: string, The ID of the organizational unit. pageSize: integer, Maximum number of results to return. Maximum and default are 100. pageToken: string, Token to specify the page of the request to be returned. diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html index b170d1787da..b8baf936d51 100644 --- a/docs/dyn/cloudbuild_v1.projects.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.builds.html @@ -248,7 +248,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -618,7 +618,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1019,7 +1019,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1395,7 +1395,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index db839e27767..2740973c710 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -247,7 +247,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -617,7 +617,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1018,7 +1018,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1394,7 +1394,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index 9214132e968..7e6f644ccd4 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -236,7 +236,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -775,7 +775,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1342,7 +1342,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1893,7 +1893,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -2449,7 +2449,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -2990,7 +2990,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index 662205fc333..ce2d032ff9a 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -236,7 +236,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -775,7 +775,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1342,7 +1342,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1893,7 +1893,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -2450,7 +2450,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -2989,7 +2989,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. }, }, "id": "A String", # Output only. Unique identifier of the build. diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 000cfc0abfb..5da6fa53131 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -300,13 +300,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -746,9 +739,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -1076,13 +1069,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -1522,9 +1508,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -1693,13 +1679,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -2139,9 +2118,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -2293,13 +2272,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -2739,9 +2711,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -2791,13 +2763,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -3237,9 +3202,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -3305,13 +3270,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -3751,9 +3709,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -4391,13 +4349,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -4837,9 +4788,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. diff --git a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html index b5be2cae7c0..ddf7f384898 100644 --- a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html @@ -122,6 +122,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -397,6 +398,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -549,6 +551,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -613,6 +616,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -807,6 +811,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -915,6 +920,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 20547da92bb..79f8b7810f0 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -224,11 +224,6 @@

Instance Methods

Returns the instances Resource.

-

- instantSnapshotGroups() -

-

Returns the instantSnapshotGroups Resource.

-

instantSnapshots()

@@ -389,11 +384,6 @@

Instance Methods

Returns the regionHealthChecks Resource.

-

- regionInstanceGroupManagerResizeRequests() -

-

Returns the regionInstanceGroupManagerResizeRequests Resource.

-

regionInstanceGroupManagers()

@@ -414,11 +404,6 @@

Instance Methods

Returns the regionInstances Resource.

-

- regionInstantSnapshotGroups() -

-

Returns the regionInstantSnapshotGroups Resource.

-

regionInstantSnapshots()

diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index 9a80e32b2b2..9216cea065b 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -363,7 +363,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -441,9 +441,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1327,7 +1324,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1405,9 +1402,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1530,7 +1524,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1608,9 +1602,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1863,7 +1854,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1941,9 +1932,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -2419,7 +2407,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2497,9 +2485,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -4294,7 +4279,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -4372,9 +4357,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html index adaa57adc6e..9af4028e419 100644 --- a/docs/dyn/compute_alpha.instanceTemplates.html +++ b/docs/dyn/compute_alpha.instanceTemplates.html @@ -390,7 +390,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -932,7 +932,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1392,7 +1392,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1887,7 +1887,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index 6ad330494e5..c6fd5ecc13e 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -1029,7 +1029,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -1068,7 +1068,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1731,7 +1731,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -2764,7 +2764,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -2803,7 +2803,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -3822,7 +3822,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -3861,7 +3861,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -4399,7 +4399,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -4438,7 +4438,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -6621,7 +6621,7 @@

Method Details

{ # Sets the scheduling options for an Instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -8436,7 +8436,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -8475,7 +8475,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.instantSnapshotGroups.html b/docs/dyn/compute_alpha.instantSnapshotGroups.html deleted file mode 100644 index b85ea5aa722..00000000000 --- a/docs/dyn/compute_alpha.instantSnapshotGroups.html +++ /dev/null @@ -1,490 +0,0 @@ - - - -

Compute Engine API . instantSnapshotGroups

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- delete(project, zone, instantSnapshotGroup, requestId=None, x__xgafv=None)

-

deletes a Zonal InstantSnapshotGroup resource

-

- get(project, zone, instantSnapshotGroup, x__xgafv=None)

-

returns the specified InstantSnapshotGroup resource in the specified zone.

-

- insert(project, zone, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None)

-

inserts a Zonal InstantSnapshotGroup resource

-

- list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

-

retrieves the list of InstantSnapshotGroup resources contained within the specified zone.

-

- list_next()

-

Retrieves the next page of results.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- delete(project, zone, instantSnapshotGroup, requestId=None, x__xgafv=None) -
deletes a Zonal InstantSnapshotGroup resource
-
-Args:
-  project: string, Project ID for this request. (required)
-  zone: string, The name of the zone for this request. (required)
-  instantSnapshotGroup: string, Name of the InstantSnapshot resource to delete. (required)
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
- -
- get(project, zone, instantSnapshotGroup, x__xgafv=None) -
returns the specified InstantSnapshotGroup resource in the specified zone.
-
-Args:
-  project: string, Project ID for this request. (required)
-  zone: string, The name of the zone for this request. (required)
-  instantSnapshotGroup: string, Name of the instantSnapshotGroup resource to return. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    {
-  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
-  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
-  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
-  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
-  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-  "resourceStatus": {
-    "consistencyMembershipResolutionTime": "A String", # [Output Only]
-    "sourceInfo": { # [Output Only]
-      "consistencyGroup": "A String",
-      "consistencyGroupId": "A String",
-    },
-  },
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
-  "status": "A String", # [Output Only]
-  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-}
-
- -
- insert(project, zone, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None) -
inserts a Zonal InstantSnapshotGroup resource
-
-Args:
-  project: string, Project ID for this request. (required)
-  zone: string, Name of the zone for this request. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{
-  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
-  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
-  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
-  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
-  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-  "resourceStatus": {
-    "consistencyMembershipResolutionTime": "A String", # [Output Only]
-    "sourceInfo": { # [Output Only]
-      "consistencyGroup": "A String",
-      "consistencyGroupId": "A String",
-    },
-  },
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
-  "status": "A String", # [Output Only]
-  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-}
-
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  sourceConsistencyGroup: string, begin_interface: MixerMutationRequestBuilder
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
- -
- list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
retrieves the list of InstantSnapshotGroup resources contained within the specified zone.
-
-Args:
-  project: string, Project ID for this request. (required)
-  zone: string, The name of the zone for this request. (required)
-  filter: string, 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.
-  maxResults: integer, 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`)
-  orderBy: string, 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.
-  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
-  returnPartialSuccess: boolean, 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.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Contains a list of InstantSnapshotGroup resources.
-  "etag": "A String",
-  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-  "items": [ # A list of InstantSnapshotGroup resources.
-    {
-      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-      "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
-      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
-      "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
-      "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
-      "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-      "resourceStatus": {
-        "consistencyMembershipResolutionTime": "A String", # [Output Only]
-        "sourceInfo": { # [Output Only]
-          "consistencyGroup": "A String",
-          "consistencyGroupId": "A String",
-        },
-      },
-      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
-      "status": "A String", # [Output Only]
-      "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-    },
-  ],
-  "kind": "compute#instantSnapshotGroupsList", # Type of resource.
-  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
-  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
-  "unreachables": [ # [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
-    "A String",
-  ],
-  "warning": { # [Output Only] Informational warning message.
-    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-      {
-        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-        "value": "A String", # [Output Only] A warning data value corresponding to the key.
-      },
-    ],
-    "message": "A String", # [Output Only] A human-readable description of the warning code.
-  },
-}
-
- -
- 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/compute_alpha.interconnects.html b/docs/dyn/compute_alpha.interconnects.html index 6789842e579..d070351c802 100644 --- a/docs/dyn/compute_alpha.interconnects.html +++ b/docs/dyn/compute_alpha.interconnects.html @@ -271,14 +271,6 @@

Method Details

}, ], }, - "egressMinBandwidthPercentagePolicy": { - "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. - { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. - "percentage": 42, # Bandwidth percentage for a specific traffic class. - "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. - }, - ], - }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, @@ -562,14 +554,6 @@

Method Details

}, ], }, - "egressMinBandwidthPercentagePolicy": { - "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. - { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. - "percentage": 42, # Bandwidth percentage for a specific traffic class. - "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. - }, - ], - }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, @@ -793,14 +777,6 @@

Method Details

}, ], }, - "egressMinBandwidthPercentagePolicy": { - "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. - { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. - "percentage": 42, # Bandwidth percentage for a specific traffic class. - "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. - }, - ], - }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, @@ -924,14 +900,6 @@

Method Details

}, ], }, - "egressMinBandwidthPercentagePolicy": { - "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. - { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. - "percentage": 42, # Bandwidth percentage for a specific traffic class. - "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. - }, - ], - }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index bc41011422a..3fef14c548c 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -502,7 +502,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -742,7 +742,7 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1172,7 +1172,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1412,7 +1412,7 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1873,7 +1873,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -2113,7 +2113,7 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.networkEndpointGroups.html b/docs/dyn/compute_alpha.networkEndpointGroups.html index 12190e30f0c..d1a59909e5b 100644 --- a/docs/dyn/compute_alpha.networkEndpointGroups.html +++ b/docs/dyn/compute_alpha.networkEndpointGroups.html @@ -149,6 +149,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -257,6 +258,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -534,6 +536,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -687,6 +690,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -752,6 +756,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -947,6 +952,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -1027,6 +1033,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -1079,6 +1086,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index c38ac05ac86..98226353b9b 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -273,13 +273,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -719,9 +712,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -893,13 +886,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -1339,9 +1325,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -1494,13 +1480,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -1940,9 +1919,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -1993,13 +1972,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -2439,9 +2411,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -2508,13 +2480,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -2954,9 +2919,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -3466,13 +3431,6 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. - "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. - { # 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. - }, - ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -3912,9 +3870,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index 93ee59d3c5d..98e0b78b3dd 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -141,7 +141,6 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -202,9 +201,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -276,7 +272,6 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, - "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -616,7 +611,6 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -677,9 +671,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -751,7 +742,6 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, - "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -784,7 +774,6 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -845,9 +834,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -919,7 +905,6 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, - "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -1082,7 +1067,6 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -1143,9 +1127,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -1217,7 +1198,6 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, - "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -1312,7 +1292,6 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. - "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -1373,9 +1352,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -1447,7 +1423,6 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, - "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -1639,9 +1614,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html deleted file mode 100644 index 3d327f613e8..00000000000 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html +++ /dev/null @@ -1,479 +0,0 @@ - - - -

Compute Engine API . regionInstanceGroupManagerResizeRequests

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- get(project, region, instanceGroupManager, resizeRequest, x__xgafv=None)

-

Returns all of the details about the specified resize request.

-

- insert(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

-

Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- get(project, region, instanceGroupManager, resizeRequest, x__xgafv=None) -
Returns all of the details about the specified resize request.
-
-Args:
-  project: string, Project ID for this request. (required)
-  region: string, The name of the region scoping this request. Name should conform to RFC1035. (required)
-  instanceGroupManager: string, The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. (required)
-  resizeRequest: string, The name of the resize request. Name should conform to RFC1035 or be a resource ID. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.
-  "count": 42, # This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.
-  "creationTimestamp": "A String", # [Output Only] The creation timestamp for this resize request in RFC3339 text format.
-  "description": "A String", # An optional description of this resource.
-  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
-  "kind": "compute#instanceGroupManagerResizeRequest", # [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
-  "name": "A String", # The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
-  "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible.
-    "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
-      "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
-      "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-    },
-    "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
-  },
-  "requestedRunDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
-    "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
-    "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-  },
-  "resizeBy": 42, # The number of instances to be created by this resize request. The group's target size will be increased by this number.
-  "selfLink": "A String", # [Output Only] The URL for this resize request. The server defines this URL.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
-  "state": "A String", # [Output only] Current state of the request.
-  "status": { # [Output only] Status of the request.
-    "error": { # [Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.
-      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-        {
-          "code": "A String", # [Output Only] The error type identifier for this error.
-          "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-            {
-              "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-                "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-                "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                  "a_key": "A String",
-                },
-                "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-              },
-              "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-                "links": [ # URL(s) pointing to additional information on handling the current error.
-                  { # Describes a URL link.
-                    "description": "A String", # Describes what the link offers.
-                    "url": "A String", # The URL of the link.
-                  },
-                ],
-              },
-              "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-                "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-                "message": "A String", # The localized error message in the above locale.
-              },
-              "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-                "dimensions": { # The map holding related quota dimensions.
-                  "a_key": "A String",
-                },
-                "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-                "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-                "limitName": "A String", # The name of the quota limit.
-                "metricName": "A String", # The Compute Engine quota metric name.
-                "rolloutStatus": "A String", # Rollout status of the future quota limit.
-              },
-            },
-          ],
-          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-          "message": "A String", # [Output Only] An optional, human-readable error message.
-        },
-      ],
-    },
-    "lastAttempt": { # [Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the "error" field only.
-      "error": { # Errors that prevented the ResizeRequest to be fulfilled.
-        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-          {
-            "code": "A String", # [Output Only] The error type identifier for this error.
-            "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-              {
-                "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-                  "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-                  "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                    "a_key": "A String",
-                  },
-                  "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-                },
-                "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-                  "links": [ # URL(s) pointing to additional information on handling the current error.
-                    { # Describes a URL link.
-                      "description": "A String", # Describes what the link offers.
-                      "url": "A String", # The URL of the link.
-                    },
-                  ],
-                },
-                "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-                  "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-                  "message": "A String", # The localized error message in the above locale.
-                },
-                "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-                  "dimensions": { # The map holding related quota dimensions.
-                    "a_key": "A String",
-                  },
-                  "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-                  "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-                  "limitName": "A String", # The name of the quota limit.
-                  "metricName": "A String", # The Compute Engine quota metric name.
-                  "rolloutStatus": "A String", # Rollout status of the future quota limit.
-                },
-              },
-            ],
-            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-            "message": "A String", # [Output Only] An optional, human-readable error message.
-          },
-        ],
-      },
-    },
-    "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, setting queueing policy is no longer supported. Constraints for the time when the instances start provisioning. Always exposed as absolute time.
-      "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
-        "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
-        "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-      },
-      "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
-    },
-  },
-  "zone": "A String", # [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
-}
-
- -
- insert(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None) -
Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.
-
-Args:
-  project: string, Project ID for this request. (required)
-  region: string, Name of the region scoping this request. Name should conform to RFC1035. (required)
-  instanceGroupManager: string, Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.
-  "count": 42, # This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.
-  "creationTimestamp": "A String", # [Output Only] The creation timestamp for this resize request in RFC3339 text format.
-  "description": "A String", # An optional description of this resource.
-  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
-  "kind": "compute#instanceGroupManagerResizeRequest", # [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
-  "name": "A String", # The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
-  "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible.
-    "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
-      "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
-      "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-    },
-    "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
-  },
-  "requestedRunDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
-    "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
-    "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-  },
-  "resizeBy": 42, # The number of instances to be created by this resize request. The group's target size will be increased by this number.
-  "selfLink": "A String", # [Output Only] The URL for this resize request. The server defines this URL.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
-  "state": "A String", # [Output only] Current state of the request.
-  "status": { # [Output only] Status of the request.
-    "error": { # [Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.
-      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-        {
-          "code": "A String", # [Output Only] The error type identifier for this error.
-          "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-            {
-              "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-                "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-                "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                  "a_key": "A String",
-                },
-                "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-              },
-              "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-                "links": [ # URL(s) pointing to additional information on handling the current error.
-                  { # Describes a URL link.
-                    "description": "A String", # Describes what the link offers.
-                    "url": "A String", # The URL of the link.
-                  },
-                ],
-              },
-              "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-                "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-                "message": "A String", # The localized error message in the above locale.
-              },
-              "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-                "dimensions": { # The map holding related quota dimensions.
-                  "a_key": "A String",
-                },
-                "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-                "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-                "limitName": "A String", # The name of the quota limit.
-                "metricName": "A String", # The Compute Engine quota metric name.
-                "rolloutStatus": "A String", # Rollout status of the future quota limit.
-              },
-            },
-          ],
-          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-          "message": "A String", # [Output Only] An optional, human-readable error message.
-        },
-      ],
-    },
-    "lastAttempt": { # [Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the "error" field only.
-      "error": { # Errors that prevented the ResizeRequest to be fulfilled.
-        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-          {
-            "code": "A String", # [Output Only] The error type identifier for this error.
-            "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-              {
-                "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-                  "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-                  "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                    "a_key": "A String",
-                  },
-                  "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-                },
-                "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-                  "links": [ # URL(s) pointing to additional information on handling the current error.
-                    { # Describes a URL link.
-                      "description": "A String", # Describes what the link offers.
-                      "url": "A String", # The URL of the link.
-                    },
-                  ],
-                },
-                "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-                  "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-                  "message": "A String", # The localized error message in the above locale.
-                },
-                "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-                  "dimensions": { # The map holding related quota dimensions.
-                    "a_key": "A String",
-                  },
-                  "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-                  "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-                  "limitName": "A String", # The name of the quota limit.
-                  "metricName": "A String", # The Compute Engine quota metric name.
-                  "rolloutStatus": "A String", # Rollout status of the future quota limit.
-                },
-              },
-            ],
-            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-            "message": "A String", # [Output Only] An optional, human-readable error message.
-          },
-        ],
-      },
-    },
-    "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, setting queueing policy is no longer supported. Constraints for the time when the instances start provisioning. Always exposed as absolute time.
-      "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
-        "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
-        "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
-      },
-      "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
-    },
-  },
-  "zone": "A String", # [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
-}
-
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index 43d462f6f32..1d18d8b9938 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -1055,7 +1055,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1133,9 +1133,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1258,7 +1255,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1336,9 +1333,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1591,7 +1585,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1669,9 +1663,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -2147,7 +2138,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2225,9 +2216,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -4022,7 +4010,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -4100,9 +4088,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html index 6060cae0968..7797342bd82 100644 --- a/docs/dyn/compute_alpha.regionInstanceTemplates.html +++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html @@ -501,7 +501,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -862,7 +862,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1358,7 +1358,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html index 974d460769d..d3705e89685 100644 --- a/docs/dyn/compute_alpha.regionInstances.html +++ b/docs/dyn/compute_alpha.regionInstances.html @@ -343,7 +343,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html deleted file mode 100644 index 3de09899788..00000000000 --- a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html +++ /dev/null @@ -1,490 +0,0 @@ - - - -

Compute Engine API . regionInstantSnapshotGroups

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- delete(project, region, instantSnapshotGroup, requestId=None, x__xgafv=None)

-

deletes a Regional InstantSnapshotGroup resource

-

- get(project, region, instantSnapshot, x__xgafv=None)

-

returns the specified InstantSnapshotGroup resource in the specified region.

-

- insert(project, region, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None)

-

creates a Regional InstantSnapshotGroup resource

-

- list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

-

retrieves the list of InstantSnapshotGroup resources contained within the specified region.

-

- list_next()

-

Retrieves the next page of results.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- delete(project, region, instantSnapshotGroup, requestId=None, x__xgafv=None) -
deletes a Regional InstantSnapshotGroup resource
-
-Args:
-  project: string, Project ID for this request. (required)
-  region: string, The name of the region for this request. (required)
-  instantSnapshotGroup: string, Name of the InstantSnapshotGroup resource to delete. (required)
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
- -
- get(project, region, instantSnapshot, x__xgafv=None) -
returns the specified InstantSnapshotGroup resource in the specified region.
-
-Args:
-  project: string, Project ID for this request. (required)
-  region: string, The name of the region for this request. (required)
-  instantSnapshot: string, Name of the InstantSnapshotGroup resource to return. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    {
-  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
-  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
-  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
-  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
-  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-  "resourceStatus": {
-    "consistencyMembershipResolutionTime": "A String", # [Output Only]
-    "sourceInfo": { # [Output Only]
-      "consistencyGroup": "A String",
-      "consistencyGroupId": "A String",
-    },
-  },
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
-  "status": "A String", # [Output Only]
-  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-}
-
- -
- insert(project, region, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None) -
creates a Regional InstantSnapshotGroup resource
-
-Args:
-  project: string, Project ID for this request. (required)
-  region: string, Name of the region for this request. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{
-  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
-  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
-  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
-  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
-  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-  "resourceStatus": {
-    "consistencyMembershipResolutionTime": "A String", # [Output Only]
-    "sourceInfo": { # [Output Only]
-      "consistencyGroup": "A String",
-      "consistencyGroupId": "A String",
-    },
-  },
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
-  "status": "A String", # [Output Only]
-  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-}
-
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  sourceConsistencyGroup: string, begin_interface: MixerMutationRequestBuilder
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
- -
- list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) -
retrieves the list of InstantSnapshotGroup resources contained within the specified region.
-
-Args:
-  project: string, Project ID for this request. (required)
-  region: string, The name of the region for this request. (required)
-  filter: string, 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.
-  maxResults: integer, 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`)
-  orderBy: string, 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.
-  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
-  returnPartialSuccess: boolean, 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.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Contains a list of InstantSnapshotGroup resources.
-  "etag": "A String",
-  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
-  "items": [ # A list of InstantSnapshotGroup resources.
-    {
-      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
-      "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
-      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
-      "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
-      "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
-      "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-      "resourceStatus": {
-        "consistencyMembershipResolutionTime": "A String", # [Output Only]
-        "sourceInfo": { # [Output Only]
-          "consistencyGroup": "A String",
-          "consistencyGroupId": "A String",
-        },
-      },
-      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
-      "status": "A String", # [Output Only]
-      "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-    },
-  ],
-  "kind": "compute#instantSnapshotGroupsList", # Type of resource.
-  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
-  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
-  "unreachables": [ # [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
-    "A String",
-  ],
-  "warning": { # [Output Only] Informational warning message.
-    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-      {
-        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-        "value": "A String", # [Output Only] A warning data value corresponding to the key.
-      },
-    ],
-    "message": "A String", # [Output Only] A human-readable description of the warning code.
-  },
-}
-
- -
- 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/compute_alpha.regionMultiMigs.html b/docs/dyn/compute_alpha.regionMultiMigs.html index 537897dedec..b2f9b9dab0e 100644 --- a/docs/dyn/compute_alpha.regionMultiMigs.html +++ b/docs/dyn/compute_alpha.regionMultiMigs.html @@ -279,7 +279,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -357,9 +357,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -453,11 +450,6 @@

Method Details

}, "selfLink": "A String", # [Output only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "status": { - "memberInstanceGroupManagers": [ - "A String", - ], - }, } @@ -510,7 +502,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -588,9 +580,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -684,11 +673,6 @@

Method Details

}, "selfLink": "A String", # [Output only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "status": { - "memberInstanceGroupManagers": [ - "A String", - ], - }, } requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @@ -872,7 +856,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -950,9 +934,6 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). - "resourcePolicies": { # Resource policies for this managed instance group. - "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy - }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1046,11 +1027,6 @@

Method Details

}, "selfLink": "A String", # [Output only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "status": { - "memberInstanceGroupManagers": [ - "A String", - ], - }, }, ], "kind": "compute#multiMigList", # Type of resource. diff --git a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html index 6580445b3c5..bac637f5d15 100644 --- a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html @@ -123,6 +123,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -400,6 +401,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -553,6 +555,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -618,6 +621,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -813,6 +817,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -922,6 +927,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_alpha.regions.html b/docs/dyn/compute_alpha.regions.html index f211f4d1b18..53036e0a87f 100644 --- a/docs/dyn/compute_alpha.regions.html +++ b/docs/dyn/compute_alpha.regions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

get(project, region, x__xgafv=None)

-

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

+

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

@@ -94,7 +94,7 @@

Method Details

get(project, region, x__xgafv=None) -
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.
+  
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html
index 35e904ff4cc..297b9e72cdc 100644
--- a/docs/dyn/compute_alpha.reservations.html
+++ b/docs/dyn/compute_alpha.reservations.html
@@ -181,9 +181,6 @@ 

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -468,9 +465,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -675,9 +669,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -911,9 +902,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -1416,9 +1404,6 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. - "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. - "a_key": "A String", - }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. diff --git a/docs/dyn/compute_alpha.resourcePolicies.html b/docs/dyn/compute_alpha.resourcePolicies.html index 11be35d2982..c599628f975 100644 --- a/docs/dyn/compute_alpha.resourcePolicies.html +++ b/docs/dyn/compute_alpha.resourcePolicies.html @@ -226,9 +226,6 @@

Method Details

}, }, }, - "workloadPolicy": { # Represents the workload policy. - "type": "A String", - }, }, ], "warning": { # Informational warning which replaces the list of resourcePolicies when the list is empty. @@ -511,9 +508,6 @@

Method Details

}, }, }, - "workloadPolicy": { # Represents the workload policy. - "type": "A String", - }, }
@@ -716,9 +710,6 @@

Method Details

}, }, }, - "workloadPolicy": { # Represents the workload policy. - "type": "A String", - }, } requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @@ -951,9 +942,6 @@

Method Details

}, }, }, - "workloadPolicy": { # Represents the workload policy. - "type": "A String", - }, }, ], "kind": "compute#resourcePolicyList", # [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies @@ -1085,9 +1073,6 @@

Method Details

}, }, }, - "workloadPolicy": { # Represents the workload policy. - "type": "A String", - }, } paths: string, A parameter (repeated) diff --git a/docs/dyn/compute_alpha.vpnGateways.html b/docs/dyn/compute_alpha.vpnGateways.html index 46601754f8b..b8e2b49648c 100644 --- a/docs/dyn/compute_alpha.vpnGateways.html +++ b/docs/dyn/compute_alpha.vpnGateways.html @@ -148,7 +148,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -365,7 +365,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -440,7 +440,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -606,7 +606,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html index 29fc233a353..e7a75e81175 100644 --- a/docs/dyn/compute_alpha.zoneQueuedResources.html +++ b/docs/dyn/compute_alpha.zoneQueuedResources.html @@ -381,7 +381,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1128,7 +1128,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1568,7 +1568,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -2138,7 +2138,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. + "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index 50d3bb643e5..17f6f9b00c3 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -487,22 +487,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -1015,22 +1007,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } @@ -1386,22 +1370,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } @@ -1739,22 +1715,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -1991,22 +1959,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -2259,22 +2219,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } @@ -3096,22 +3048,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } diff --git a/docs/dyn/compute_beta.firewallPolicies.html b/docs/dyn/compute_beta.firewallPolicies.html index 478eea6f577..5e607354b89 100644 --- a/docs/dyn/compute_beta.firewallPolicies.html +++ b/docs/dyn/compute_beta.firewallPolicies.html @@ -77,9 +77,6 @@

Instance Methods

addAssociation(firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)

Inserts an association for the specified firewall policy.

-

- addPacketMirroringRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)

-

Inserts a packet mirroring rule into a firewall policy.

addRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)

Inserts a rule into a firewall policy.

@@ -101,9 +98,6 @@

Instance Methods

getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

-

- getPacketMirroringRule(firewallPolicy, priority=None, x__xgafv=None)

-

Gets a packet mirroring rule of the specified priority.

getRule(firewallPolicy, priority=None, x__xgafv=None)

Gets a rule of the specified priority.

@@ -125,18 +119,12 @@

Instance Methods

patch(firewallPolicy, body=None, requestId=None, x__xgafv=None)

Patches the specified policy with the data included in the request.

-

- patchPacketMirroringRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

-

Patches a packet mirroring rule of the specified priority.

patchRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

Patches a rule of the specified priority.

removeAssociation(firewallPolicy, name=None, requestId=None, x__xgafv=None)

Removes an association for the specified firewall policy.

-

- removePacketMirroringRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)

-

Deletes a packet mirroring rule of the specified priority.

removeRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)

Deletes a rule of the specified priority.

@@ -282,204 +270,6 @@

Method Details

} -
- addPacketMirroringRule(firewallPolicy, body=None, requestId=None, x__xgafv=None) -
Inserts a packet mirroring rule into a firewall policy.
-
-Args:
-  firewallPolicy: string, Name of the firewall policy to update. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
-  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
-  "description": "A String", # An optional description for this resource.
-  "direction": "A String", # The direction in which this rule applies.
-  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
-  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
-  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
-  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
-    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
-      "A String",
-    ],
-    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
-      "A String",
-    ],
-    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
-      "A String",
-    ],
-    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
-      "A String",
-    ],
-    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
-      {
-        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
-        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
-          "A String",
-        ],
-      },
-    ],
-    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
-      "A String",
-    ],
-    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
-      "A String",
-    ],
-    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
-      "A String",
-    ],
-    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
-      {
-        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-      },
-    ],
-    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
-      "A String",
-    ],
-  },
-  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
-  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
-  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
-  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
-  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
-    "A String",
-  ],
-  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
-    {
-      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-    },
-  ],
-  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
-    "A String",
-  ],
-  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
-}
-
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
-
addRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)
Inserts a rule into a firewall policy.
@@ -961,83 +751,10 @@ 

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], - "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. - "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. - "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. + "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. + "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. + "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". "description": "A String", # An optional description for this resource. @@ -1239,94 +956,6 @@

Method Details

}
-
- getPacketMirroringRule(firewallPolicy, priority=None, x__xgafv=None) -
Gets a packet mirroring rule of the specified priority.
-
-Args:
-  firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
-  priority: integer, The priority of the rule to get from the firewall policy.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
-  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
-  "description": "A String", # An optional description for this resource.
-  "direction": "A String", # The direction in which this rule applies.
-  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
-  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
-  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
-  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
-    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
-      "A String",
-    ],
-    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
-      "A String",
-    ],
-    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
-      "A String",
-    ],
-    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
-      "A String",
-    ],
-    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
-      {
-        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
-        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
-          "A String",
-        ],
-      },
-    ],
-    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
-      "A String",
-    ],
-    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
-      "A String",
-    ],
-    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
-      "A String",
-    ],
-    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
-      {
-        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-      },
-    ],
-    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
-      "A String",
-    ],
-  },
-  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
-  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
-  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
-  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
-  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
-    "A String",
-  ],
-  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
-    {
-      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-    },
-  ],
-  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
-    "A String",
-  ],
-  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
-}
-
-
getRule(firewallPolicy, priority=None, x__xgafv=None)
Gets a rule of the specified priority.
@@ -1440,79 +1069,6 @@ 

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1751,79 +1307,6 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -2112,79 +1595,6 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -2383,205 +1793,6 @@

Method Details

}
-
- patchPacketMirroringRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None) -
Patches a packet mirroring rule of the specified priority.
-
-Args:
-  firewallPolicy: string, Name of the firewall policy to update. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
-  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
-  "description": "A String", # An optional description for this resource.
-  "direction": "A String", # The direction in which this rule applies.
-  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
-  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
-  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
-  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
-    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
-      "A String",
-    ],
-    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
-      "A String",
-    ],
-    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
-      "A String",
-    ],
-    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
-      "A String",
-    ],
-    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
-      {
-        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
-        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
-          "A String",
-        ],
-      },
-    ],
-    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
-      "A String",
-    ],
-    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
-      "A String",
-    ],
-    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
-      "A String",
-    ],
-    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
-      {
-        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-      },
-    ],
-    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
-      "A String",
-    ],
-  },
-  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
-  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
-  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
-  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
-  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
-    "A String",
-  ],
-  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
-    {
-      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-    },
-  ],
-  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
-    "A String",
-  ],
-  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
-}
-
-  priority: integer, The priority of the rule to patch.
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
-
patchRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)
Patches a rule of the specified priority.
@@ -2905,130 +2116,6 @@ 

Method Details

}
-
- removePacketMirroringRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None) -
Deletes a packet mirroring rule of the specified priority.
-
-Args:
-  firewallPolicy: string, Name of the firewall policy to update. (required)
-  priority: integer, The priority of the rule to remove from the firewall policy.
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
-
removeRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)
Deletes a rule of the specified priority.
diff --git a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html
index dfcebb7f00e..807675efb3a 100644
--- a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html
+++ b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html
@@ -122,6 +122,7 @@ 

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -394,6 +395,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -544,6 +546,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -605,6 +608,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -795,6 +799,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -900,6 +905,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index 98028635474..94b629af2ff 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -354,7 +354,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1289,7 +1289,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1472,7 +1472,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1784,7 +1784,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2315,7 +2315,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -4150,7 +4150,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html index f18bae10d34..5d976323b2d 100644 --- a/docs/dyn/compute_beta.instanceTemplates.html +++ b/docs/dyn/compute_beta.instanceTemplates.html @@ -367,7 +367,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -863,7 +862,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1278,7 +1276,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1727,7 +1724,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 89fa8799191..456538715be 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -798,7 +798,6 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -814,7 +813,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1413,7 +1411,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -2263,7 +2260,6 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -2279,7 +2275,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -2379,7 +2374,6 @@

Method Details

{ "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. - "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. "rules": [ # The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". @@ -3207,7 +3201,6 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -3223,7 +3216,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -3697,7 +3689,6 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -3713,7 +3704,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -5847,7 +5837,6 @@

Method Details

{ # Sets the scheduling options for an Instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -7605,7 +7594,6 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -7621,7 +7609,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html index 97ee34070a2..882a57ad2ae 100644 --- a/docs/dyn/compute_beta.machineImages.html +++ b/docs/dyn/compute_beta.machineImages.html @@ -478,7 +478,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -681,7 +680,6 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1077,7 +1075,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1280,7 +1277,6 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1706,7 +1702,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1909,7 +1904,6 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.networkEndpointGroups.html b/docs/dyn/compute_beta.networkEndpointGroups.html index f2de9e0f20f..9be6a71887c 100644 --- a/docs/dyn/compute_beta.networkEndpointGroups.html +++ b/docs/dyn/compute_beta.networkEndpointGroups.html @@ -149,6 +149,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -254,6 +255,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -528,6 +530,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -679,6 +682,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -741,6 +745,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -932,6 +937,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -1009,6 +1015,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -1060,6 +1067,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_beta.networkFirewallPolicies.html b/docs/dyn/compute_beta.networkFirewallPolicies.html index 2df899fd61b..44c593e57a0 100644 --- a/docs/dyn/compute_beta.networkFirewallPolicies.html +++ b/docs/dyn/compute_beta.networkFirewallPolicies.html @@ -77,9 +77,6 @@

Instance Methods

addAssociation(project, firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)

Inserts an association for the specified firewall policy.

-

- addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)

-

Inserts a packet mirroring rule into a firewall policy.

addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)

Inserts a rule into a firewall policy.

@@ -101,9 +98,6 @@

Instance Methods

getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

-

- getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None)

-

Gets a packet mirroring rule of the specified priority.

getRule(project, firewallPolicy, priority=None, x__xgafv=None)

Gets a rule of the specified priority.

@@ -119,18 +113,12 @@

Instance Methods

patch(project, firewallPolicy, body=None, requestId=None, x__xgafv=None)

Patches the specified policy with the data included in the request.

-

- patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

-

Patches a packet mirroring rule of the specified priority.

patchRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

Patches a rule of the specified priority.

removeAssociation(project, firewallPolicy, name=None, requestId=None, x__xgafv=None)

Removes an association for the specified firewall policy.

-

- removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)

-

Deletes a packet mirroring rule of the specified priority.

removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)

Deletes a rule of the specified priority.

@@ -277,207 +265,6 @@

Method Details

}
-
- addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None) -
Inserts a packet mirroring rule into a firewall policy.
-
-Args:
-  project: string, Project ID for this request. (required)
-  firewallPolicy: string, Name of the firewall policy to update. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
-  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
-  "description": "A String", # An optional description for this resource.
-  "direction": "A String", # The direction in which this rule applies.
-  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
-  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
-  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
-  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
-    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
-      "A String",
-    ],
-    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
-      "A String",
-    ],
-    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
-      "A String",
-    ],
-    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
-      "A String",
-    ],
-    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
-      {
-        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
-        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
-          "A String",
-        ],
-      },
-    ],
-    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
-      "A String",
-    ],
-    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
-      "A String",
-    ],
-    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
-      "A String",
-    ],
-    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
-      {
-        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-      },
-    ],
-    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
-      "A String",
-    ],
-  },
-  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
-  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
-  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
-  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
-  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
-    "A String",
-  ],
-  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
-    {
-      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-    },
-  ],
-  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
-    "A String",
-  ],
-  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
-}
-
-  maxPriority: integer, When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
-  minPriority: integer, When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
-
addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)
Inserts a rule into a firewall policy.
@@ -965,83 +752,10 @@ 

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], - "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. - "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. - "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. + "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. + "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. + "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". "description": "A String", # An optional description for this resource. @@ -1245,95 +959,6 @@

Method Details

}
-
- getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None) -
Gets a packet mirroring rule of the specified priority.
-
-Args:
-  project: string, Project ID for this request. (required)
-  firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
-  priority: integer, The priority of the rule to get from the firewall policy.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
-  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
-  "description": "A String", # An optional description for this resource.
-  "direction": "A String", # The direction in which this rule applies.
-  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
-  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
-  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
-  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
-    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
-      "A String",
-    ],
-    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
-      "A String",
-    ],
-    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
-      "A String",
-    ],
-    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
-      "A String",
-    ],
-    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
-      {
-        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
-        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
-          "A String",
-        ],
-      },
-    ],
-    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
-      "A String",
-    ],
-    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
-      "A String",
-    ],
-    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
-      "A String",
-    ],
-    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
-      {
-        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-      },
-    ],
-    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
-      "A String",
-    ],
-  },
-  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
-  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
-  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
-  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
-  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
-    "A String",
-  ],
-  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
-    {
-      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-    },
-  ],
-  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
-    "A String",
-  ],
-  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
-}
-
-
getRule(project, firewallPolicy, priority=None, x__xgafv=None)
Gets a rule of the specified priority.
@@ -1449,79 +1074,6 @@ 

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1759,83 +1311,10 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], - "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. - "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. - "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. + "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. + "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. + "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". "description": "A String", # An optional description for this resource. @@ -1969,79 +1448,6 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -2240,206 +1646,6 @@

Method Details

}
-
- patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None) -
Patches a packet mirroring rule of the specified priority.
-
-Args:
-  project: string, Project ID for this request. (required)
-  firewallPolicy: string, Name of the firewall policy to update. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
-  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
-  "description": "A String", # An optional description for this resource.
-  "direction": "A String", # The direction in which this rule applies.
-  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
-  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
-  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
-  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
-    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
-      "A String",
-    ],
-    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
-      "A String",
-    ],
-    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
-      "A String",
-    ],
-    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
-      "A String",
-    ],
-    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
-      {
-        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
-        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
-          "A String",
-        ],
-      },
-    ],
-    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
-      "A String",
-    ],
-    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
-      "A String",
-    ],
-    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
-      "A String",
-    ],
-    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
-      {
-        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-      },
-    ],
-    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
-      "A String",
-    ],
-  },
-  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
-  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
-  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
-  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
-  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
-    "A String",
-  ],
-  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
-    {
-      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-    },
-  ],
-  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
-    "A String",
-  ],
-  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
-}
-
-  priority: integer, The priority of the rule to patch.
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
-
patchRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)
Patches a rule of the specified priority.
@@ -2765,131 +1971,6 @@ 

Method Details

}
-
- removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None) -
Deletes a packet mirroring rule of the specified priority.
-
-Args:
-  project: string, Project ID for this request. (required)
-  firewallPolicy: string, Name of the firewall policy to update. (required)
-  priority: integer, The priority of the rule to remove from the firewall policy.
-  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
-  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
-  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
-  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
-  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
-  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
-    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
-      {
-        "code": "A String", # [Output Only] The error type identifier for this error.
-        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
-          {
-            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
-              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
-              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
-                "a_key": "A String",
-              },
-              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
-            },
-            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
-              "links": [ # URL(s) pointing to additional information on handling the current error.
-                { # Describes a URL link.
-                  "description": "A String", # Describes what the link offers.
-                  "url": "A String", # The URL of the link.
-                },
-              ],
-            },
-            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
-              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
-              "message": "A String", # The localized error message in the above locale.
-            },
-            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
-              "dimensions": { # The map holding related quota dimensions.
-                "a_key": "A String",
-              },
-              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
-              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
-              "limitName": "A String", # The name of the quota limit.
-              "metricName": "A String", # The Compute Engine quota metric name.
-              "rolloutStatus": "A String", # Rollout status of the future quota limit.
-            },
-          },
-        ],
-        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
-        "message": "A String", # [Output Only] An optional, human-readable error message.
-      },
-    ],
-  },
-  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
-  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
-  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
-  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
-  "instancesBulkInsertOperationMetadata": {
-    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
-        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
-        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
-        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
-        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
-      },
-    },
-  },
-  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
-  "name": "A String", # [Output Only] Name of the operation.
-  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
-  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
-  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
-  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
-    "clientOperationId": "A String", # [Output Only] The client operation id.
-    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
-      "a_key": {
-        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
-          "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.
-        },
-        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
-      },
-    },
-  },
-  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
-  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
-  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
-  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
-  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
-  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
-  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
-    {
-      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
-      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
-        {
-          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
-          "value": "A String", # [Output Only] A warning data value corresponding to the key.
-        },
-      ],
-      "message": "A String", # [Output Only] A human-readable description of the warning code.
-    },
-  ],
-  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
-}
-
-
removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)
Deletes a rule of the specified priority.
diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html
index 32048b9dc3f..d6b9019e7f6 100644
--- a/docs/dyn/compute_beta.regionBackendServices.html
+++ b/docs/dyn/compute_beta.regionBackendServices.html
@@ -460,22 +460,14 @@ 

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }
@@ -834,22 +826,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } @@ -1188,22 +1172,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -1441,22 +1417,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -1710,22 +1678,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } @@ -2420,22 +2380,14 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). - "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. - "name": "A String", # Name of the cookie. - "path": "A String", # Path to set for the cookie. - "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. - "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. - "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years - }, - }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index 49d190e12b4..3a97cfe0e54 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -1040,7 +1040,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1223,7 +1223,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1535,7 +1535,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2066,7 +2066,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -3901,7 +3901,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_beta.regionInstanceTemplates.html b/docs/dyn/compute_beta.regionInstanceTemplates.html index be002676f5f..50ba0b1d5e8 100644 --- a/docs/dyn/compute_beta.regionInstanceTemplates.html +++ b/docs/dyn/compute_beta.regionInstanceTemplates.html @@ -477,7 +477,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -793,7 +792,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1243,7 +1241,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html index 2097ae187e1..513d7e95814 100644 --- a/docs/dyn/compute_beta.regionInstances.html +++ b/docs/dyn/compute_beta.regionInstances.html @@ -320,7 +320,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html index 23acaec90a6..baf2c9ff45b 100644 --- a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html @@ -123,6 +123,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -397,6 +398,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -548,6 +550,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -610,6 +613,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -801,6 +805,7 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, + "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -907,6 +912,7 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. + "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html index 227491bfb72..62497eb8b04 100644 --- a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html @@ -760,79 +760,6 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -962,7 +889,6 @@

Method Details

{ "displayName": "A String", # [Output Only] The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. - "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. "rules": [ # The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". @@ -1313,79 +1239,6 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1624,79 +1477,6 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1835,79 +1615,6 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. - { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). - "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". - "description": "A String", # An optional description for this resource. - "direction": "A String", # The direction in which this rule applies. - "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. - "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. - "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules - "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. - "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. - "A String", - ], - "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. - "A String", - ], - "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. - "A String", - ], - "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. - "A String", - ], - "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. - "A String", - ], - "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. - { - "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. - "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. - "A String", - ], - }, - ], - "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. - "A String", - ], - "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. - "A String", - ], - "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. - "A String", - ], - "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. - "A String", - ], - "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. - "A String", - ], - }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. - { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. - }, - ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. - }, - ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. diff --git a/docs/dyn/compute_beta.regions.html b/docs/dyn/compute_beta.regions.html index 885d113c409..1795ca28e46 100644 --- a/docs/dyn/compute_beta.regions.html +++ b/docs/dyn/compute_beta.regions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

get(project, region, x__xgafv=None)

-

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

+

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

@@ -94,7 +94,7 @@

Method Details

get(project, region, x__xgafv=None) -
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.
+  
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_beta.vpnGateways.html b/docs/dyn/compute_beta.vpnGateways.html
index 1979bd1bc24..622abb43047 100644
--- a/docs/dyn/compute_beta.vpnGateways.html
+++ b/docs/dyn/compute_beta.vpnGateways.html
@@ -148,7 +148,7 @@ 

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -364,7 +364,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -439,7 +439,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -604,7 +604,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index 764a37e9971..c7c81e807ec 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -485,9 +485,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -998,9 +998,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }
@@ -1352,9 +1352,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } @@ -1690,9 +1690,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -1927,9 +1927,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -2180,9 +2180,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } @@ -3002,9 +3002,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index 0d228c9f076..ea71371d261 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -330,7 +330,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1228,7 +1228,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1374,7 +1374,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1649,7 +1649,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2132,7 +2132,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index e2db4b5214d..654b97e9f6e 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -345,7 +345,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -806,7 +805,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1191,7 +1189,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1605,7 +1602,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index 9db32736a46..8b70b0354af 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -775,7 +775,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1330,7 +1329,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -2159,7 +2157,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -2847,7 +2844,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -3297,7 +3293,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -5256,7 +5251,6 @@

Method Details

{ # Sets the scheduling options for an Instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -6871,7 +6865,6 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index 3b4c6ccaffe..10d19b4f4c1 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -456,7 +456,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -650,7 +649,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1021,7 +1019,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1215,7 +1212,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1616,7 +1612,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1810,7 +1805,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html index 2c33e970eb3..779efce6e59 100644 --- a/docs/dyn/compute_v1.regionBackendServices.html +++ b/docs/dyn/compute_v1.regionBackendServices.html @@ -458,9 +458,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }
@@ -815,9 +815,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } @@ -1154,9 +1154,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -1392,9 +1392,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], }, @@ -1646,9 +1646,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } @@ -2341,9 +2341,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ # [Output Only] List of resources referencing given backend service. + "usedBy": [ { - "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. + "reference": "A String", }, ], } diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html index 66404ebf405..d545c66f463 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html @@ -1016,7 +1016,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1162,7 +1162,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1437,7 +1437,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1920,7 +1920,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) + "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html index e140e892c59..d1e5dbe7f64 100644 --- a/docs/dyn/compute_v1.regionInstanceTemplates.html +++ b/docs/dyn/compute_v1.regionInstanceTemplates.html @@ -450,7 +450,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -736,7 +735,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1151,7 +1149,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index a0a18d9d9fc..426b6aa0aa0 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -298,7 +298,6 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.regions.html b/docs/dyn/compute_v1.regions.html index b471d6aadf9..48ac2d032b3 100644 --- a/docs/dyn/compute_v1.regions.html +++ b/docs/dyn/compute_v1.regions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

get(project, region, x__xgafv=None)

-

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

+

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

@@ -94,7 +94,7 @@

Method Details

get(project, region, x__xgafv=None) -
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.
+  
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.vpnGateways.html b/docs/dyn/compute_v1.vpnGateways.html
index 7c9b23380e9..74efc22d514 100644
--- a/docs/dyn/compute_v1.vpnGateways.html
+++ b/docs/dyn/compute_v1.vpnGateways.html
@@ -148,7 +148,7 @@ 

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -364,7 +364,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -439,7 +439,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -604,7 +604,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. diff --git a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html index 43a80086ffc..0f7828d7f76 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html @@ -272,7 +272,6 @@

Method Details

"resultMetadata": [ # Output only. List of result field metadata. { # Metadata of result field. "dataType": "A String", # The data type of the field. - "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the field. "field": "A String", # Name of the result field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result @@ -294,7 +293,6 @@

Method Details

"A String", ], }, - "nullable": True or False, # Specifies whether a null value is allowed. }, ], }, diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 0739667e877..a2f1cc3d8b0 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -2122,7 +2122,6 @@

Method Details

"resultMetadata": [ # Output only. List of result field metadata. { # Metadata of result field. "dataType": "A String", # The data type of the field. - "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the field. "field": "A String", # Name of the result field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result @@ -2144,7 +2143,6 @@

Method Details

"A String", ], }, - "nullable": True or False, # Specifies whether a null value is allowed. }, ], }, diff --git a/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html b/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html index 9b37f45fd2b..921a9428bf5 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html @@ -182,7 +182,6 @@

Method Details

"resultMetadata": [ # Output only. List of result field metadata. { # Metadata of result field. "dataType": "A String", # The data type of the field. - "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the field. "field": "A String", # Name of the result field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result @@ -204,7 +203,6 @@

Method Details

"A String", ], }, - "nullable": True or False, # Specifies whether a null value is allowed. }, ], }, diff --git a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html index 5d9c2069592..09e7733e513 100644 --- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html +++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html @@ -203,7 +203,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -407,7 +407,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -586,7 +586,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. 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 c098918d86e..1bc5d9dd8b6 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -154,7 +154,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -226,7 +226,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -345,7 +345,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -416,7 +416,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -488,7 +488,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -561,7 +561,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -660,7 +660,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -763,7 +763,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -879,7 +879,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -951,7 +951,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1070,7 +1070,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1141,7 +1141,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1213,7 +1213,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1286,7 +1286,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1385,7 +1385,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1488,7 +1488,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. + "valueSeparator": "A String", # Required. Value separator. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. diff --git a/docs/dyn/connectors_v2.projects.locations.connections.actions.html b/docs/dyn/connectors_v2.projects.locations.connections.actions.html index 8634b99dae2..245cbeb0304 100644 --- a/docs/dyn/connectors_v2.projects.locations.connections.actions.html +++ b/docs/dyn/connectors_v2.projects.locations.connections.actions.html @@ -226,7 +226,6 @@

Method Details

"resultMetadata": [ # List containing the metadata of result fields. { # Result Metadata message contains metadata about the result returned after executing an Action. "dataType": "A String", # The data type of the metadata field - "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the metadata field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the result, applicable only if parameter is of type `STRUCT` "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema @@ -251,7 +250,6 @@

Method Details

], }, "name": "A String", # Name of the metadata field. - "nullable": True or False, # Specifies whether a null value is allowed. }, ], }
@@ -365,7 +363,6 @@

Method Details

"resultMetadata": [ # List containing the metadata of result fields. { # Result Metadata message contains metadata about the result returned after executing an Action. "dataType": "A String", # The data type of the metadata field - "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the metadata field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the result, applicable only if parameter is of type `STRUCT` "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema @@ -390,7 +387,6 @@

Method Details

], }, "name": "A String", # Name of the metadata field. - "nullable": True or False, # Specifies whether a null value is allowed. }, ], }, diff --git a/docs/dyn/css_v1.accounts.cssProductInputs.html b/docs/dyn/css_v1.accounts.cssProductInputs.html deleted file mode 100644 index a4eb2da60a5..00000000000 --- a/docs/dyn/css_v1.accounts.cssProductInputs.html +++ /dev/null @@ -1,362 +0,0 @@ - - - -

CSS API . accounts . cssProductInputs

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

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

-

Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.

-

- insert(parent, body=None, feedId=None, x__xgafv=None)

-

Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- delete(name, supplementalFeedId=None, x__xgafv=None) -
Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.
-
-Args:
-  name: string, Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input} (required)
-  supplementalFeedId: string, The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.
-  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); }
-}
-
- -
- insert(parent, body=None, feedId=None, x__xgafv=None) -
Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.
-
-Args:
-  parent: string, Required. The account where this CSS Product will be inserted. Format: accounts/{account} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.
-  "attributes": { # Attributes for CSS Product. # A list of CSS Product attributes.
-    "additionalImageLinks": [ # Additional URL of images of the item.
-      "A String",
-    ],
-    "adult": True or False, # Set to true if the item is targeted towards adults.
-    "ageGroup": "A String", # Target age group of the item.
-    "brand": "A String", # Product Related Attributes.[14-36] Brand of the item.
-    "certifications": [ # A list of certificates claimed by the CSS for the given product.
-      { # The certification for the product.
-        "authority": "A String", # Name of the certification body.
-        "code": "A String", # A unique code to identify the certification.
-        "name": "A String", # Name of the certification.
-      },
-    ],
-    "color": "A String", # Color of the item.
-    "cppAdsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
-    "cppLink": "A String", # URL directly linking to your the Product Detail Page of the CSS.
-    "cppMobileLink": "A String", # URL for the mobile-optimized version of the Product Detail Page of the CSS.
-    "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
-    "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
-    "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
-    "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
-    "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
-    "description": "A String", # Description of the item.
-    "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
-      "A String",
-    ],
-    "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
-    "gender": "A String", # Target gender of the item.
-    "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
-    "gtin": "A String", # Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.
-    "headlineOfferCondition": "A String", # Condition of the headline offer.
-    "headlineOfferLink": "A String", # Link to the headline offer.
-    "headlineOfferMobileLink": "A String", # Mobile Link to the headline offer.
-    "headlineOfferPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "headlineOfferShippingPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "highPrice": { # The price represented as a number and currency. # High Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "imageLink": "A String", # URL of an image of the item.
-    "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
-      "A String",
-    ],
-    "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
-    "itemGroupId": "A String", # Shared identifier for all variants of the same product.
-    "lowPrice": { # The price represented as a number and currency. # Low Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "material": "A String", # The material of which the item is made.
-    "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
-    "multipack": "A String", # The number of identical products in a merchant-defined multipack.
-    "numberOfOffers": "A String", # The number of aggregate offers.
-    "pattern": "A String", # The item's pattern (e.g. polka dots).
-    "pause": "A String", # Publication of this item will be temporarily paused.
-    "productDetails": [ # Technical specification or additional product details.
-      { # The product details.
-        "attributeName": "A String", # The name of the product detail.
-        "attributeValue": "A String", # The value of the product detail.
-        "sectionName": "A String", # The section header used to group a set of product details.
-      },
-    ],
-    "productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-    },
-    "productHighlights": [ # Bullet points describing the most relevant highlights of a product.
-      "A String",
-    ],
-    "productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-    },
-    "productTypes": [ # Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).
-      "A String",
-    ],
-    "productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
-      "unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
-      "value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
-    },
-    "productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-    },
-    "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).
-    "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
-    "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
-      "A String",
-    ],
-    "title": "A String", # Title of the item.
-  },
-  "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product.
-  "customAttributes": [ # A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
-    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
-      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
-        # Object with schema name: CustomAttribute
-      ],
-      "name": "A String", # The name of the attribute.
-      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
-    },
-  ],
-  "feedLabel": "A String", # Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.
-  "finalName": "A String", # Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` "
-  "freshnessTime": "A String", # Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.
-  "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`
-  "rawProvidedId": "A String", # Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details.
-}
-
-  feedId: string, Required. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet.
-  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 input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.
-  "attributes": { # Attributes for CSS Product. # A list of CSS Product attributes.
-    "additionalImageLinks": [ # Additional URL of images of the item.
-      "A String",
-    ],
-    "adult": True or False, # Set to true if the item is targeted towards adults.
-    "ageGroup": "A String", # Target age group of the item.
-    "brand": "A String", # Product Related Attributes.[14-36] Brand of the item.
-    "certifications": [ # A list of certificates claimed by the CSS for the given product.
-      { # The certification for the product.
-        "authority": "A String", # Name of the certification body.
-        "code": "A String", # A unique code to identify the certification.
-        "name": "A String", # Name of the certification.
-      },
-    ],
-    "color": "A String", # Color of the item.
-    "cppAdsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
-    "cppLink": "A String", # URL directly linking to your the Product Detail Page of the CSS.
-    "cppMobileLink": "A String", # URL for the mobile-optimized version of the Product Detail Page of the CSS.
-    "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
-    "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
-    "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
-    "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
-    "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
-    "description": "A String", # Description of the item.
-    "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
-      "A String",
-    ],
-    "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
-    "gender": "A String", # Target gender of the item.
-    "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
-    "gtin": "A String", # Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.
-    "headlineOfferCondition": "A String", # Condition of the headline offer.
-    "headlineOfferLink": "A String", # Link to the headline offer.
-    "headlineOfferMobileLink": "A String", # Mobile Link to the headline offer.
-    "headlineOfferPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "headlineOfferShippingPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "highPrice": { # The price represented as a number and currency. # High Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "imageLink": "A String", # URL of an image of the item.
-    "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
-      "A String",
-    ],
-    "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
-    "itemGroupId": "A String", # Shared identifier for all variants of the same product.
-    "lowPrice": { # The price represented as a number and currency. # Low Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "material": "A String", # The material of which the item is made.
-    "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
-    "multipack": "A String", # The number of identical products in a merchant-defined multipack.
-    "numberOfOffers": "A String", # The number of aggregate offers.
-    "pattern": "A String", # The item's pattern (e.g. polka dots).
-    "pause": "A String", # Publication of this item will be temporarily paused.
-    "productDetails": [ # Technical specification or additional product details.
-      { # The product details.
-        "attributeName": "A String", # The name of the product detail.
-        "attributeValue": "A String", # The value of the product detail.
-        "sectionName": "A String", # The section header used to group a set of product details.
-      },
-    ],
-    "productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-    },
-    "productHighlights": [ # Bullet points describing the most relevant highlights of a product.
-      "A String",
-    ],
-    "productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-    },
-    "productTypes": [ # Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).
-      "A String",
-    ],
-    "productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
-      "unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
-      "value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
-    },
-    "productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-    },
-    "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).
-    "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
-    "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
-      "A String",
-    ],
-    "title": "A String", # Title of the item.
-  },
-  "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product.
-  "customAttributes": [ # A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
-    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
-      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
-        # Object with schema name: CustomAttribute
-      ],
-      "name": "A String", # The name of the attribute.
-      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
-    },
-  ],
-  "feedLabel": "A String", # Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.
-  "finalName": "A String", # Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` "
-  "freshnessTime": "A String", # Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.
-  "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`
-  "rawProvidedId": "A String", # Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details.
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/css_v1.accounts.cssProducts.html b/docs/dyn/css_v1.accounts.cssProducts.html deleted file mode 100644 index a6a59944490..00000000000 --- a/docs/dyn/css_v1.accounts.cssProducts.html +++ /dev/null @@ -1,442 +0,0 @@ - - - -

CSS API . accounts . cssProducts

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- get(name, x__xgafv=None)

-

Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

-

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

-

Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.

-

- list_next()

-

Retrieves the next page of results.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- get(name, x__xgafv=None) -
Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.
-
-Args:
-  name: string, Required. The name of the CSS product to retrieve. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The processed CSS Product(a.k.a Aggregate Offer internally).
-  "attributes": { # Attributes for CSS Product. # Output only. A list of product attributes.
-    "additionalImageLinks": [ # Additional URL of images of the item.
-      "A String",
-    ],
-    "adult": True or False, # Set to true if the item is targeted towards adults.
-    "ageGroup": "A String", # Target age group of the item.
-    "brand": "A String", # Product Related Attributes.[14-36] Brand of the item.
-    "certifications": [ # A list of certificates claimed by the CSS for the given product.
-      { # The certification for the product.
-        "authority": "A String", # Name of the certification body.
-        "code": "A String", # A unique code to identify the certification.
-        "name": "A String", # Name of the certification.
-      },
-    ],
-    "color": "A String", # Color of the item.
-    "cppAdsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
-    "cppLink": "A String", # URL directly linking to your the Product Detail Page of the CSS.
-    "cppMobileLink": "A String", # URL for the mobile-optimized version of the Product Detail Page of the CSS.
-    "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
-    "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
-    "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
-    "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
-    "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
-    "description": "A String", # Description of the item.
-    "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
-      "A String",
-    ],
-    "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
-    "gender": "A String", # Target gender of the item.
-    "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
-    "gtin": "A String", # Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.
-    "headlineOfferCondition": "A String", # Condition of the headline offer.
-    "headlineOfferLink": "A String", # Link to the headline offer.
-    "headlineOfferMobileLink": "A String", # Mobile Link to the headline offer.
-    "headlineOfferPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "headlineOfferShippingPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "highPrice": { # The price represented as a number and currency. # High Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "imageLink": "A String", # URL of an image of the item.
-    "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
-      "A String",
-    ],
-    "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
-    "itemGroupId": "A String", # Shared identifier for all variants of the same product.
-    "lowPrice": { # The price represented as a number and currency. # Low Price of the aggregate offer.
-      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-    },
-    "material": "A String", # The material of which the item is made.
-    "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
-    "multipack": "A String", # The number of identical products in a merchant-defined multipack.
-    "numberOfOffers": "A String", # The number of aggregate offers.
-    "pattern": "A String", # The item's pattern (e.g. polka dots).
-    "pause": "A String", # Publication of this item will be temporarily paused.
-    "productDetails": [ # Technical specification or additional product details.
-      { # The product details.
-        "attributeName": "A String", # The name of the product detail.
-        "attributeValue": "A String", # The value of the product detail.
-        "sectionName": "A String", # The section header used to group a set of product details.
-      },
-    ],
-    "productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-    },
-    "productHighlights": [ # Bullet points describing the most relevant highlights of a product.
-      "A String",
-    ],
-    "productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-    },
-    "productTypes": [ # Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).
-      "A String",
-    ],
-    "productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
-      "unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
-      "value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
-    },
-    "productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-    },
-    "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).
-    "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
-    "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
-      "A String",
-    ],
-    "title": "A String", # Title of the item.
-  },
-  "contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
-  "cssProductStatus": { # The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
-    "creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
-    "destinationStatuses": [ # The intended destinations for the product.
-      { # The destination status of the product status.
-        "approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved.
-          "A String",
-        ],
-        "destination": "A String", # The name of the destination
-        "disapprovedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved.
-          "A String",
-        ],
-        "pendingCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval.
-          "A String",
-        ],
-      },
-    ],
-    "googleExpirationDate": "A String", # Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
-    "itemLevelIssues": [ # A list of all issues associated with the product.
-      { # The ItemLevelIssue of the product status.
-        "applicableCountries": [ # List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer.
-          "A String",
-        ],
-        "attribute": "A String", # The attribute's name, if the issue is caused by a single attribute.
-        "code": "A String", # The error code of the issue.
-        "description": "A String", # A short issue description in English.
-        "destination": "A String", # The destination the issue applies to.
-        "detail": "A String", # A detailed issue description in English.
-        "documentation": "A String", # The URL of a web page to help with resolving this issue.
-        "resolution": "A String", # Whether the issue can be resolved by the merchant.
-        "servability": "A String", # How this issue affects serving of the aggregate offer.
-      },
-    ],
-    "lastUpdateDate": "A String", # Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
-  },
-  "customAttributes": [ # Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
-    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
-      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
-        # Object with schema name: CustomAttribute
-      ],
-      "name": "A String", # The name of the attribute.
-      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
-    },
-  ],
-  "feedLabel": "A String", # Output only. The feed label for the product.
-  "name": "A String", # The name of the CSS Product. Format: `"accounts/{account}/cssProducts/{css_product}"`
-  "rawProvidedId": "A String", # Output only. Your unique raw identifier for the product.
-}
-
- -
- list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.
-
-Args:
-  parent: string, Required. The account/domain to list processed CSS Products for. Format: accounts/{account} (required)
-  pageSize: integer, The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned.
-  pageToken: string, A page token, received from a previous `ListCssProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCssProducts` must match the call that provided the page token.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for the ListCssProducts method.
-  "cssProducts": [ # The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds.
-    { # The processed CSS Product(a.k.a Aggregate Offer internally).
-      "attributes": { # Attributes for CSS Product. # Output only. A list of product attributes.
-        "additionalImageLinks": [ # Additional URL of images of the item.
-          "A String",
-        ],
-        "adult": True or False, # Set to true if the item is targeted towards adults.
-        "ageGroup": "A String", # Target age group of the item.
-        "brand": "A String", # Product Related Attributes.[14-36] Brand of the item.
-        "certifications": [ # A list of certificates claimed by the CSS for the given product.
-          { # The certification for the product.
-            "authority": "A String", # Name of the certification body.
-            "code": "A String", # A unique code to identify the certification.
-            "name": "A String", # Name of the certification.
-          },
-        ],
-        "color": "A String", # Color of the item.
-        "cppAdsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
-        "cppLink": "A String", # URL directly linking to your the Product Detail Page of the CSS.
-        "cppMobileLink": "A String", # URL for the mobile-optimized version of the Product Detail Page of the CSS.
-        "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
-        "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
-        "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
-        "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
-        "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
-        "description": "A String", # Description of the item.
-        "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
-          "A String",
-        ],
-        "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
-        "gender": "A String", # Target gender of the item.
-        "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
-        "gtin": "A String", # Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.
-        "headlineOfferCondition": "A String", # Condition of the headline offer.
-        "headlineOfferLink": "A String", # Link to the headline offer.
-        "headlineOfferMobileLink": "A String", # Mobile Link to the headline offer.
-        "headlineOfferPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
-          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-        },
-        "headlineOfferShippingPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
-          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-        },
-        "highPrice": { # The price represented as a number and currency. # High Price of the aggregate offer.
-          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-        },
-        "imageLink": "A String", # URL of an image of the item.
-        "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
-          "A String",
-        ],
-        "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
-        "itemGroupId": "A String", # Shared identifier for all variants of the same product.
-        "lowPrice": { # The price represented as a number and currency. # Low Price of the aggregate offer.
-          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-        },
-        "material": "A String", # The material of which the item is made.
-        "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
-        "multipack": "A String", # The number of identical products in a merchant-defined multipack.
-        "numberOfOffers": "A String", # The number of aggregate offers.
-        "pattern": "A String", # The item's pattern (e.g. polka dots).
-        "pause": "A String", # Publication of this item will be temporarily paused.
-        "productDetails": [ # Technical specification or additional product details.
-          { # The product details.
-            "attributeName": "A String", # The name of the product detail.
-            "attributeValue": "A String", # The value of the product detail.
-            "sectionName": "A String", # The section header used to group a set of product details.
-          },
-        ],
-        "productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-          "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-          "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-        },
-        "productHighlights": [ # Bullet points describing the most relevant highlights of a product.
-          "A String",
-        ],
-        "productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-          "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-          "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-        },
-        "productTypes": [ # Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).
-          "A String",
-        ],
-        "productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
-          "unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
-          "value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
-        },
-        "productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
-          "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
-          "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
-        },
-        "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).
-        "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
-        "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
-          "A String",
-        ],
-        "title": "A String", # Title of the item.
-      },
-      "contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
-      "cssProductStatus": { # The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
-        "creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
-        "destinationStatuses": [ # The intended destinations for the product.
-          { # The destination status of the product status.
-            "approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved.
-              "A String",
-            ],
-            "destination": "A String", # The name of the destination
-            "disapprovedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved.
-              "A String",
-            ],
-            "pendingCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval.
-              "A String",
-            ],
-          },
-        ],
-        "googleExpirationDate": "A String", # Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
-        "itemLevelIssues": [ # A list of all issues associated with the product.
-          { # The ItemLevelIssue of the product status.
-            "applicableCountries": [ # List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer.
-              "A String",
-            ],
-            "attribute": "A String", # The attribute's name, if the issue is caused by a single attribute.
-            "code": "A String", # The error code of the issue.
-            "description": "A String", # A short issue description in English.
-            "destination": "A String", # The destination the issue applies to.
-            "detail": "A String", # A detailed issue description in English.
-            "documentation": "A String", # The URL of a web page to help with resolving this issue.
-            "resolution": "A String", # Whether the issue can be resolved by the merchant.
-            "servability": "A String", # How this issue affects serving of the aggregate offer.
-          },
-        ],
-        "lastUpdateDate": "A String", # Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
-      },
-      "customAttributes": [ # Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
-        { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
-          "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
-            # Object with schema name: CustomAttribute
-          ],
-          "name": "A String", # The name of the attribute.
-          "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
-        },
-      ],
-      "feedLabel": "A String", # Output only. The feed label for the product.
-      "name": "A String", # The name of the CSS Product. Format: `"accounts/{account}/cssProducts/{css_product}"`
-      "rawProvidedId": "A String", # Output only. Your unique raw identifier for the product.
-    },
-  ],
-  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
-}
-
- -
- list_next() -
Retrieves the next page of results.
-
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
-
-        Returns:
-          A request object that you can call 'execute()' on to request the next
-          page. Returns None if there are no more items in the collection.
-        
-
- - \ No newline at end of file diff --git a/docs/dyn/css_v1.accounts.html b/docs/dyn/css_v1.accounts.html deleted file mode 100644 index d91a5b74714..00000000000 --- a/docs/dyn/css_v1.accounts.html +++ /dev/null @@ -1,237 +0,0 @@ - - - -

CSS API . accounts

-

Instance Methods

-

- cssProductInputs() -

-

Returns the cssProductInputs Resource.

- -

- cssProducts() -

-

Returns the cssProducts Resource.

- -

- labels() -

-

Returns the labels Resource.

- -

- close()

-

Close httplib2 connections.

-

- get(name, parent=None, x__xgafv=None)

-

Retrieves a single CSS/MC account by ID.

-

- listChildAccounts(parent, fullName=None, labelId=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.

-

- listChildAccounts_next()

-

Retrieves the next page of results.

-

- updateLabels(name, body=None, x__xgafv=None)

-

Updates labels assigned to CSS/MC accounts by a CSS domain.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- get(name, parent=None, x__xgafv=None) -
Retrieves a single CSS/MC account by ID.
-
-Args:
-  name: string, Required. The name of the managed CSS/MC account. Format: accounts/{account} (required)
-  parent: string, Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Information about CSS/MC account.
-  "accountType": "A String", # Output only. The type of this account.
-  "automaticLabelIds": [ # Automatically created label IDs assigned to the MC account by CSS Center.
-    "A String",
-  ],
-  "displayName": "A String", # The CSS/MC account's short display name.
-  "fullName": "A String", # Output only. Immutable. The CSS/MC account's full name.
-  "homepageUri": "A String", # Output only. Immutable. The CSS/MC account's homepage.
-  "labelIds": [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
-    "A String",
-  ],
-  "name": "A String", # The label resource name. Format: accounts/{account}
-  "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.
-}
-
- -
- listChildAccounts(parent, fullName=None, labelId=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.
-
-Args:
-  parent: string, Required. The parent account. Must be a CSS group or domain. Format: accounts/{account} (required)
-  fullName: string, If set, only the MC accounts with the given name (case sensitive) will be returned.
-  labelId: string, If set, only the MC accounts with the given label ID will be returned.
-  pageSize: integer, Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for the `ListChildAccounts` method.
-  "accounts": [ # The CSS/MC accounts returned for the specified CSS parent account.
-    { # Information about CSS/MC account.
-      "accountType": "A String", # Output only. The type of this account.
-      "automaticLabelIds": [ # Automatically created label IDs assigned to the MC account by CSS Center.
-        "A String",
-      ],
-      "displayName": "A String", # The CSS/MC account's short display name.
-      "fullName": "A String", # Output only. Immutable. The CSS/MC account's full name.
-      "homepageUri": "A String", # Output only. Immutable. The CSS/MC account's homepage.
-      "labelIds": [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
-        "A String",
-      ],
-      "name": "A String", # The label resource name. Format: accounts/{account}
-      "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.
-    },
-  ],
-  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
-}
-
- -
- listChildAccounts_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.
-        
-
- -
- updateLabels(name, body=None, x__xgafv=None) -
Updates labels assigned to CSS/MC accounts by a CSS domain.
-
-Args:
-  name: string, Required. The label resource name. Format: accounts/{account} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The request message for the `UpdateLabels` method.
-  "labelIds": [ # The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.
-    "A String",
-  ],
-  "parent": "A String", # Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Information about CSS/MC account.
-  "accountType": "A String", # Output only. The type of this account.
-  "automaticLabelIds": [ # Automatically created label IDs assigned to the MC account by CSS Center.
-    "A String",
-  ],
-  "displayName": "A String", # The CSS/MC account's short display name.
-  "fullName": "A String", # Output only. Immutable. The CSS/MC account's full name.
-  "homepageUri": "A String", # Output only. Immutable. The CSS/MC account's homepage.
-  "labelIds": [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
-    "A String",
-  ],
-  "name": "A String", # The label resource name. Format: accounts/{account}
-  "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/css_v1.accounts.labels.html b/docs/dyn/css_v1.accounts.labels.html deleted file mode 100644 index 85e7753e100..00000000000 --- a/docs/dyn/css_v1.accounts.labels.html +++ /dev/null @@ -1,236 +0,0 @@ - - - -

CSS API . accounts . labels

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

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

-

Creates a new label, not assigned to any account.

-

- delete(name, x__xgafv=None)

-

Deletes a label and removes it from all accounts to which it was assigned.

-

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

-

Lists the labels assigned to an account.

-

- list_next()

-

Retrieves the next page of results.

-

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

-

Updates a label.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- create(parent, body=None, x__xgafv=None) -
Creates a new label, not assigned to any account.
-
-Args:
-  parent: string, Required. The parent account. Format: accounts/{account} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
-  "accountId": "A String", # Output only. The ID of account this label belongs to.
-  "description": "A String", # The description of this label.
-  "displayName": "A String", # The display name of this label.
-  "labelId": "A String", # Output only. The ID of the label.
-  "labelType": "A String", # Output only. The type of this label.
-  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
-  "accountId": "A String", # Output only. The ID of account this label belongs to.
-  "description": "A String", # The description of this label.
-  "displayName": "A String", # The display name of this label.
-  "labelId": "A String", # Output only. The ID of the label.
-  "labelType": "A String", # Output only. The type of this label.
-  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
-}
-
- -
- delete(name, x__xgafv=None) -
Deletes a label and removes it from all accounts to which it was assigned.
-
-Args:
-  name: string, Required. The name of the label to delete. Format: accounts/{account}/labels/{label} (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
-}
-
- -
- list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the labels assigned to an account.
-
-Args:
-  parent: string, Required. The parent account. Format: accounts/{account} (required)
-  pageSize: integer, The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response message for the `ListAccountLabels` method.
-  "accountLabels": [ # The labels from the specified account.
-    { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
-      "accountId": "A String", # Output only. The ID of account this label belongs to.
-      "description": "A String", # The description of this label.
-      "displayName": "A String", # The display name of this label.
-      "labelId": "A String", # Output only. The ID of the label.
-      "labelType": "A String", # Output only. The type of this label.
-      "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
-    },
-  ],
-  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
-}
-
- -
- list_next() -
Retrieves the next page of results.
-
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
-
-        Returns:
-          A request object that you can call 'execute()' on to request the next
-          page. Returns None if there are no more items in the collection.
-        
-
- -
- patch(name, body=None, x__xgafv=None) -
Updates a label.
-
-Args:
-  name: string, The resource name of the label. Format: accounts/{account}/labels/{label} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
-  "accountId": "A String", # Output only. The ID of account this label belongs to.
-  "description": "A String", # The description of this label.
-  "displayName": "A String", # The display name of this label.
-  "labelId": "A String", # Output only. The ID of the label.
-  "labelType": "A String", # Output only. The type of this label.
-  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
-  "accountId": "A String", # Output only. The ID of account this label belongs to.
-  "description": "A String", # The description of this label.
-  "displayName": "A String", # The display name of this label.
-  "labelId": "A String", # Output only. The ID of the label.
-  "labelType": "A String", # Output only. The type of this label.
-  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/css_v1.html b/docs/dyn/css_v1.html deleted file mode 100644 index e84ee3786b8..00000000000 --- a/docs/dyn/css_v1.html +++ /dev/null @@ -1,111 +0,0 @@ - - - -

CSS API

-

Instance Methods

-

- accounts() -

-

Returns the accounts 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/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index 0ba0fc29ca3..4a27a21b9f5 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -322,14 +322,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -520,14 +513,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -743,14 +729,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -952,14 +931,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1169,14 +1141,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1368,14 +1333,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index db4c5bcc0c5..a5f3e3b088f 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -322,14 +322,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -520,14 +513,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -743,14 +729,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -952,14 +931,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1169,14 +1141,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1368,14 +1333,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2.projects.locations.encryptionSpec.html b/docs/dyn/dialogflow_v2.projects.locations.encryptionSpec.html deleted file mode 100644 index 80b689aa789..00000000000 --- a/docs/dyn/dialogflow_v2.projects.locations.encryptionSpec.html +++ /dev/null @@ -1,134 +0,0 @@ - - - -

Dialogflow API . projects . locations . encryptionSpec

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- initialize(name, body=None, x__xgafv=None)

-

Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- initialize(name, body=None, x__xgafv=None) -
Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
-
-Args:
-  name: string, Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The request to initialize a location-level encryption specification.
-  "encryptionSpec": { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). # Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced.
-    "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
-    "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
-  },
-}
-
-  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/dialogflow_v2.projects.locations.html b/docs/dyn/dialogflow_v2.projects.locations.html index 7a82f7a8c98..11b9e7ab32f 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.html @@ -104,11 +104,6 @@

Instance Methods

Returns the conversations Resource.

-

- encryptionSpec() -

-

Returns the encryptionSpec Resource.

-

generators()

@@ -146,9 +141,6 @@

Instance Methods

getAgent(parent, x__xgafv=None)

Retrieves the specified agent.

-

- getEncryptionSpec(name, x__xgafv=None)

-

Gets location-level encryption key specification.

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

Lists information about the supported locations for this service.

@@ -241,26 +233,6 @@

Method Details

}
-
- getEncryptionSpec(name, x__xgafv=None) -
Gets location-level encryption key specification.
-
-Args:
-  name: string, Required. The name of the encryption spec resource to get. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
-  "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
-  "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
-}
-
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service.
diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
index 10ac769932c..a971b5d5614 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
@@ -262,14 +262,7 @@ 

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index d77cfce5485..4152dd652bc 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -262,14 +262,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index eadbc55ced6..e86cdfd3a64 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -322,14 +322,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -520,14 +513,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -743,14 +729,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -952,14 +931,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1169,14 +1141,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1368,14 +1333,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html index fb3d6d52399..c91af537164 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html @@ -116,38 +116,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. @@ -188,38 +156,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. @@ -273,38 +209,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index 26259690bbb..c3935c1e89b 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -4585,38 +4585,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index 32cdb1c8327..5b283fa9e86 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -322,14 +322,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -520,14 +513,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -743,14 +729,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -952,14 +931,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1169,14 +1141,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1368,14 +1333,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html index e5c821c7e3b..75d6ad4e170 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html @@ -116,38 +116,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. @@ -188,38 +156,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. @@ -273,38 +209,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index e8bec902700..79f806031f5 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -4585,38 +4585,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.encryptionSpec.html b/docs/dyn/dialogflow_v2beta1.projects.locations.encryptionSpec.html deleted file mode 100644 index 7c18d48ab1d..00000000000 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.encryptionSpec.html +++ /dev/null @@ -1,134 +0,0 @@ - - - -

Dialogflow API . projects . locations . encryptionSpec

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- initialize(name, body=None, x__xgafv=None)

-

Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- initialize(name, body=None, x__xgafv=None) -
Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
-
-Args:
-  name: string, Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The request to initialize a location-level encryption specification.
-  "encryptionSpec": { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). # Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced.
-    "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
-    "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
-  },
-}
-
-  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/dialogflow_v2beta1.projects.locations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.html index 4d9ebe608b3..ea91938d5ad 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.html @@ -94,11 +94,6 @@

Instance Methods

Returns the conversations Resource.

-

- encryptionSpec() -

-

Returns the encryptionSpec Resource.

-

generators()

@@ -136,9 +131,6 @@

Instance Methods

getAgent(parent, x__xgafv=None)

Retrieves the specified agent.

-

- getEncryptionSpec(name, x__xgafv=None)

-

Gets location-level encryption key specification.

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

Lists information about the supported locations for this service.

@@ -231,26 +223,6 @@

Method Details

}
-
- getEncryptionSpec(name, x__xgafv=None) -
Gets location-level encryption key specification.
-
-Args:
-  name: string, Required. The name of the encryption spec resource to get. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
-  "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
-  "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
-}
-
-
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service.
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
index 55767346106..b05fde7165a 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
@@ -262,14 +262,7 @@ 

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -309,38 +302,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index 207e2beb9a8..9d723c6d831 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -262,14 +262,7 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. - "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. - "A String", - ], - "audioEncoding": "A String", # Audio encoding of the audio content to process. - "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. - "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. - "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -309,38 +302,6 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. - "responseMessages": [ # Optional. Automated agent responses. - { # Response messages from an automated agent. - "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. - }, - "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. - "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. - "a_key": "", # Properties of the object. - }, - }, - "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. - "segments": [ # Segments this audio response is composed of. - { # Represents one segment of audio. - "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. - "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. - "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. - }, - ], - }, - "payload": { # Returns a response containing a custom, platform-specific payload. - "a_key": "", # Properties of the object. - }, - "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. - "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). - "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. - "A String", - ], - }, - }, - ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. 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 9b21237cb8f..b215ff76f33 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html @@ -466,7 +466,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -802,7 +801,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1285,7 +1283,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1312,7 +1309,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1898,7 +1894,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2234,7 +2229,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2717,7 +2711,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2744,7 +2737,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -3229,7 +3221,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3565,7 +3556,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4459,7 +4449,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4795,7 +4784,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5278,7 +5266,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -5305,7 +5292,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html index 88a395ec5d5..f56af6a979d 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html @@ -173,7 +173,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -700,7 +699,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1296,7 +1294,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1918,7 +1915,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2463,7 +2459,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2991,7 +2986,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level 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 a92bfda41d8..04bcb82fb12 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html @@ -291,7 +291,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -627,7 +626,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1298,7 +1296,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1634,7 +1631,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2331,7 +2327,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2667,7 +2662,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3350,7 +3344,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3686,7 +3679,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4374,7 +4366,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4710,7 +4701,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5382,7 +5372,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5718,7 +5707,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html index f2442a1d2ed..502eb2ab9cc 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html @@ -469,7 +469,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -805,7 +804,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1288,7 +1286,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1315,7 +1312,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1901,7 +1897,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2237,7 +2232,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2720,7 +2714,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2747,7 +2740,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -3232,7 +3224,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3568,7 +3559,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4462,7 +4452,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4798,7 +4787,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5281,7 +5269,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -5308,7 +5295,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html index 233cef3cda8..64486e551ff 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html @@ -560,7 +560,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -745,7 +744,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1410,7 +1408,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1746,7 +1743,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2261,7 +2257,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2926,7 +2921,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3262,7 +3256,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4149,7 +4142,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4485,7 +4477,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5263,7 +5254,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5599,7 +5589,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6142,8 +6131,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -6388,7 +6377,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6724,7 +6712,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7502,7 +7489,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7838,7 +7824,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8381,8 +8366,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -8678,7 +8663,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -9014,7 +8998,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -9792,7 +9775,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10128,7 +10110,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10671,8 +10652,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -10977,7 +10958,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -11313,7 +11293,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12091,7 +12070,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12427,7 +12405,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12970,8 +12947,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -13234,7 +13211,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -13570,7 +13546,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -14348,7 +14323,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -14684,7 +14658,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -15227,8 +15200,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -15474,7 +15447,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -15810,7 +15782,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -16588,7 +16559,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -16924,7 +16894,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -17467,8 +17436,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "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 ad02f8d0928..fd26293be46 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html @@ -333,7 +333,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -669,7 +668,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1465,7 +1463,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1801,7 +1798,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index f25beb9569b..1dd4b87b981 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -249,7 +249,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -888,7 +887,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1601,7 +1599,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1961,7 +1958,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2480,7 +2476,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2507,7 +2502,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2993,7 +2987,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3706,7 +3699,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4066,7 +4058,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4585,7 +4576,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4612,7 +4602,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -5104,7 +5093,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5464,7 +5452,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6127,7 +6114,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6766,7 +6752,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7479,7 +7464,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7839,7 +7823,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8358,7 +8341,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -8385,7 +8367,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -8871,7 +8852,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -9584,7 +9564,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -9944,7 +9923,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10463,7 +10441,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -10490,7 +10467,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -10982,7 +10958,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -11342,7 +11317,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level 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 f00406f9338..ee31241b7de 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -334,7 +334,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1047,7 +1046,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1407,7 +1405,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1926,7 +1923,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1953,7 +1949,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2497,7 +2492,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3210,7 +3204,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3570,7 +3563,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4089,7 +4081,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4116,7 +4107,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4719,7 +4709,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5079,7 +5068,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5877,7 +5865,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6590,7 +6577,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6950,7 +6936,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7469,7 +7454,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -7496,7 +7480,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html index c2fced11d96..9b57f9f76c4 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html @@ -173,7 +173,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -736,7 +735,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1368,7 +1366,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2026,7 +2023,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2607,7 +2603,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3171,7 +3166,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level 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 5ab69e0a597..bc450131c72 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html @@ -303,7 +303,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -663,7 +662,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1382,7 +1380,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1742,7 +1739,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2487,7 +2483,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2847,7 +2842,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3578,7 +3572,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3938,7 +3931,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4674,7 +4666,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5034,7 +5025,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5754,7 +5744,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6114,7 +6103,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html index 09a57263bdf..5a50b5e8863 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html @@ -337,7 +337,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1050,7 +1049,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1410,7 +1408,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1929,7 +1926,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1956,7 +1952,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2500,7 +2495,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3213,7 +3207,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3573,7 +3566,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4092,7 +4084,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4119,7 +4110,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4722,7 +4712,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5082,7 +5071,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5880,7 +5868,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6593,7 +6580,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6953,7 +6939,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7472,7 +7457,6 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -7499,7 +7483,6 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. - "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html index 1a60d6b5b28..6441e5e8850 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html @@ -584,7 +584,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -781,7 +780,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1494,7 +1492,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1854,7 +1851,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2405,7 +2401,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3118,7 +3113,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3478,7 +3472,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4435,7 +4428,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4795,7 +4787,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5631,7 +5622,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5991,7 +5981,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6570,8 +6559,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -6838,7 +6827,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7198,7 +7186,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8034,7 +8021,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8394,7 +8380,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8973,8 +8958,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -9292,7 +9277,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -9652,7 +9636,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10488,7 +10471,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10848,7 +10830,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -11427,8 +11408,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -11755,7 +11736,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12115,7 +12095,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12951,7 +12930,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -13311,7 +13289,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -13890,8 +13867,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -14176,7 +14153,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -14536,7 +14512,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -15372,7 +15347,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -15732,7 +15706,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -16311,8 +16284,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -16580,7 +16553,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -16940,7 +16912,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -17776,7 +17747,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -18136,7 +18106,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -18715,8 +18684,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "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 eca1910f4d4..29ee57e02b2 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html @@ -355,7 +355,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -715,7 +714,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1569,7 +1567,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1929,7 +1926,6 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. - "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 1902cb81a80..014a5ec2a36 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -126,7 +126,6 @@

Method Details

}, "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification. "disable": True or False, # Disable query rephraser. - "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. }, }, "relatedQuestionsSpec": { # Related questions specification. # Related questions specification. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index c1e3772091c..9f57c958e4b 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -126,7 +126,6 @@

Method Details

}, "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification. "disable": True or False, # Disable query rephraser. - "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. }, }, "relatedQuestionsSpec": { # Related questions specification. # Related questions specification. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 26cdb02fa76..a1001f39a47 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -126,7 +126,6 @@

Method Details

}, "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification. "disable": True or False, # Disable query rephraser. - "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. }, }, "relatedQuestionsSpec": { # Related questions specification. # Related questions specification. diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index 271ff97d6d1..3e4b6271e9c 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -166,7 +166,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -382,7 +382,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -622,7 +622,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -849,7 +849,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -1084,7 +1084,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -1301,7 +1301,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index ceac9043216..69af753d38f 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -161,7 +161,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -220,7 +220,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -734,7 +734,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -793,7 +793,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index e511be106c4..b0bcb06a6f7 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -161,7 +161,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -220,7 +220,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -678,7 +678,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -737,7 +737,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index 7b3d8c81b4a..988b0ed7b32 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -166,7 +166,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -382,7 +382,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -622,7 +622,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -849,7 +849,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -1084,7 +1084,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -1301,7 +1301,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index fda2894196b..7f79fb107ab 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -161,7 +161,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -220,7 +220,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -734,7 +734,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -793,7 +793,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index b4dc2193769..4e1441ac5e5 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -161,7 +161,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -220,7 +220,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -678,7 +678,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -737,7 +737,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the folder within an organization to scan. + "folderId": "A String", # The ID of the Folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/essentialcontacts_v1.folders.contacts.html b/docs/dyn/essentialcontacts_v1.folders.contacts.html index 9a7773fd3bc..a2c69092fa5 100644 --- a/docs/dyn/essentialcontacts_v1.folders.contacts.html +++ b/docs/dyn/essentialcontacts_v1.folders.contacts.html @@ -147,7 +147,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -185,7 +185,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } x__xgafv: string, V1 error format. @@ -204,7 +204,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
@@ -248,7 +248,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
@@ -278,7 +278,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -316,7 +316,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -336,7 +336,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
diff --git a/docs/dyn/essentialcontacts_v1.organizations.contacts.html b/docs/dyn/essentialcontacts_v1.organizations.contacts.html index 294ce730264..607c849a3b5 100644 --- a/docs/dyn/essentialcontacts_v1.organizations.contacts.html +++ b/docs/dyn/essentialcontacts_v1.organizations.contacts.html @@ -147,7 +147,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -185,7 +185,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } x__xgafv: string, V1 error format. @@ -204,7 +204,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } @@ -248,7 +248,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } @@ -278,7 +278,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -316,7 +316,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -336,7 +336,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } diff --git a/docs/dyn/essentialcontacts_v1.projects.contacts.html b/docs/dyn/essentialcontacts_v1.projects.contacts.html index dcfe58917a4..2a858c29e80 100644 --- a/docs/dyn/essentialcontacts_v1.projects.contacts.html +++ b/docs/dyn/essentialcontacts_v1.projects.contacts.html @@ -147,7 +147,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -185,7 +185,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } x__xgafv: string, V1 error format. @@ -204,7 +204,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } @@ -248,7 +248,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } @@ -278,7 +278,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -316,7 +316,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -336,7 +336,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } diff --git a/docs/dyn/file_v1beta1.projects.locations.backups.html b/docs/dyn/file_v1beta1.projects.locations.backups.html index ed1bdab6891..598879bfc27 100644 --- a/docs/dyn/file_v1beta1.projects.locations.backups.html +++ b/docs/dyn/file_v1beta1.projects.locations.backups.html @@ -115,7 +115,6 @@

Method Details

"createTime": "A String", # Output only. The time when the backup was created. "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored - "fileSystemProtocol": "A String", # Output only. The file system protocol of the source Filestore instance that this backup is created from. "kmsKeyName": "A String", # Immutable. KMS key name used for data encryption. "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", @@ -217,7 +216,6 @@

Method Details

"createTime": "A String", # Output only. The time when the backup was created. "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored - "fileSystemProtocol": "A String", # Output only. The file system protocol of the source Filestore instance that this backup is created from. "kmsKeyName": "A String", # Immutable. KMS key name used for data encryption. "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", @@ -261,7 +259,6 @@

Method Details

"createTime": "A String", # Output only. The time when the backup was created. "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored - "fileSystemProtocol": "A String", # Output only. The file system protocol of the source Filestore instance that this backup is created from. "kmsKeyName": "A String", # Immutable. KMS key name used for data encryption. "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", @@ -314,7 +311,6 @@

Method Details

"createTime": "A String", # Output only. The time when the backup was created. "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored - "fileSystemProtocol": "A String", # Output only. The file system protocol of the source Filestore instance that this backup is created from. "kmsKeyName": "A String", # Immutable. KMS key name used for data encryption. "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index 84f3c3e86f1..a727ab2d81a 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -117,15 +117,6 @@

Method Details

"createTime": "A String", # Output only. Timestamp when the test was run. "deviceExecutions": [ # Required. The results of the test on each device. { # The results of running an automated test on a particular device. - "aiStepResults": [ # Output only. Results of the AI steps if passed in - { # Captures the results of an AiStep - "state": "A String", # Output only. The current state of the step - "step": { # A step to be accomplished by the AI # Required. The step performed by the AI - "assertion": "A String", # An assertion to be checked by the AI - "goal": "A String", # A goal to be accomplished by the AI - }, - }, - ], "appCrash": { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test. "message": "A String", # Output only. The message associated with the crash. "stackTrace": "A String", # Output only. The raw stack trace. @@ -187,15 +178,6 @@

Method Details

"createTime": "A String", # Output only. Timestamp when the test was run. "deviceExecutions": [ # Required. The results of the test on each device. { # The results of running an automated test on a particular device. - "aiStepResults": [ # Output only. Results of the AI steps if passed in - { # Captures the results of an AiStep - "state": "A String", # Output only. The current state of the step - "step": { # A step to be accomplished by the AI # Required. The step performed by the AI - "assertion": "A String", # An assertion to be checked by the AI - "goal": "A String", # A goal to be accomplished by the AI - }, - }, - ], "appCrash": { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test. "message": "A String", # Output only. The message associated with the crash. "stackTrace": "A String", # Output only. The raw stack trace. @@ -263,15 +245,6 @@

Method Details

"createTime": "A String", # Output only. Timestamp when the test was run. "deviceExecutions": [ # Required. The results of the test on each device. { # The results of running an automated test on a particular device. - "aiStepResults": [ # Output only. Results of the AI steps if passed in - { # Captures the results of an AiStep - "state": "A String", # Output only. The current state of the step - "step": { # A step to be accomplished by the AI # Required. The step performed by the AI - "assertion": "A String", # An assertion to be checked by the AI - "goal": "A String", # A goal to be accomplished by the AI - }, - }, - ], "appCrash": { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test. "message": "A String", # Output only. The message associated with the crash. "stackTrace": "A String", # Output only. The raw stack trace. @@ -344,15 +317,6 @@

Method Details

"createTime": "A String", # Output only. Timestamp when the test was run. "deviceExecutions": [ # Required. The results of the test on each device. { # The results of running an automated test on a particular device. - "aiStepResults": [ # Output only. Results of the AI steps if passed in - { # Captures the results of an AiStep - "state": "A String", # Output only. The current state of the step - "step": { # A step to be accomplished by the AI # Required. The step performed by the AI - "assertion": "A String", # An assertion to be checked by the AI - "goal": "A String", # A goal to be accomplished by the AI - }, - }, - ], "appCrash": { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test. "message": "A String", # Output only. The message associated with the crash. "stackTrace": "A String", # Output only. The raw stack trace. diff --git a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html index 11ad3023ad7..2d4801bf3a6 100644 --- a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html +++ b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html @@ -118,7 +118,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -150,7 +150,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -207,7 +207,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -248,7 +248,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -284,7 +284,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -317,7 +317,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. diff --git a/docs/dyn/gkehub_v1.projects.locations.features.html b/docs/dyn/gkehub_v1.projects.locations.features.html index 5752333b10b..834b94ccf7a 100644 --- a/docs/dyn/gkehub_v1.projects.locations.features.html +++ b/docs/dyn/gkehub_v1.projects.locations.features.html @@ -254,7 +254,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -451,7 +451,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -549,9 +549,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -590,13 +588,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -1191,7 +1187,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1388,7 +1384,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -1486,9 +1482,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -1527,13 +1521,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -2116,7 +2108,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -2313,7 +2305,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -2411,9 +2403,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -2452,13 +2442,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -2997,7 +2985,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -3194,7 +3182,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -3292,9 +3280,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -3333,13 +3319,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, diff --git a/docs/dyn/gkehub_v1.projects.locations.memberships.rbacrolebindings.html b/docs/dyn/gkehub_v1.projects.locations.memberships.rbacrolebindings.html index 13a46da8c33..63e047a130c 100644 --- a/docs/dyn/gkehub_v1.projects.locations.memberships.rbacrolebindings.html +++ b/docs/dyn/gkehub_v1.projects.locations.memberships.rbacrolebindings.html @@ -77,202 +77,18 @@

Instance Methods

close()

Close httplib2 connections.

-

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

-

Creates a Membership RBACRoleBinding.

-

- delete(name, x__xgafv=None)

-

Deletes a Membership RBACRoleBinding.

-

- generateMembershipRBACRoleBindingYAML(parent, body=None, rbacrolebindingId=None, x__xgafv=None)

-

Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.

-

- get(name, x__xgafv=None)

-

Returns the details of a Membership RBACRoleBinding.

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

Lists all Membership RBACRoleBindings.

list_next()

Retrieves the next page of results.

-

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

-

Updates a Membership RBACRoleBinding.

Method Details

close()
Close httplib2 connections.
-
- create(parent, body=None, rbacrolebindingId=None, x__xgafv=None) -
Creates a Membership RBACRoleBinding.
-
-Args:
-  parent: string, Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # RBACRoleBinding represents a rbacrolebinding across the Fleet
-  "createTime": "A String", # Output only. When the rbacrolebinding was created.
-  "deleteTime": "A String", # Output only. When the rbacrolebinding was deleted.
-  "group": "A String", # group is the group, as seen by the kubernetes cluster.
-  "labels": { # Optional. Labels for this RBACRolebinding.
-    "a_key": "A String",
-  },
-  "name": "A String", # The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
-  "role": { # Role is the type for Kubernetes roles # Required. Role to bind to the principal
-    "predefinedRole": "A String", # predefined_role is the Kubernetes default role to use
-  },
-  "state": { # RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. # Output only. State of the rbacrolebinding resource.
-    "code": "A String", # Output only. The current state of the rbacrolebinding resource.
-  },
-  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid.
-  "updateTime": "A String", # Output only. When the rbacrolebinding was last updated.
-  "user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
-}
-
-  rbacrolebindingId: string, Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
-  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, x__xgafv=None) -
Deletes a Membership RBACRoleBinding.
-
-Args:
-  name: string, Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`. (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.
-  },
-}
-
- -
- generateMembershipRBACRoleBindingYAML(parent, body=None, rbacrolebindingId=None, x__xgafv=None) -
Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.
-
-Args:
-  parent: string, Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # RBACRoleBinding represents a rbacrolebinding across the Fleet
-  "createTime": "A String", # Output only. When the rbacrolebinding was created.
-  "deleteTime": "A String", # Output only. When the rbacrolebinding was deleted.
-  "group": "A String", # group is the group, as seen by the kubernetes cluster.
-  "labels": { # Optional. Labels for this RBACRolebinding.
-    "a_key": "A String",
-  },
-  "name": "A String", # The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
-  "role": { # Role is the type for Kubernetes roles # Required. Role to bind to the principal
-    "predefinedRole": "A String", # predefined_role is the Kubernetes default role to use
-  },
-  "state": { # RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. # Output only. State of the rbacrolebinding resource.
-    "code": "A String", # Output only. The current state of the rbacrolebinding resource.
-  },
-  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid.
-  "updateTime": "A String", # Output only. When the rbacrolebinding was last updated.
-  "user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
-}
-
-  rbacrolebindingId: string, Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for GenerateRBACRoleBindingYAML.
-  "roleBindingsYaml": "A String", # a yaml text blob including the RBAC policies.
-}
-
- -
- get(name, x__xgafv=None) -
Returns the details of a Membership RBACRoleBinding.
-
-Args:
-  name: string, Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`. (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # RBACRoleBinding represents a rbacrolebinding across the Fleet
-  "createTime": "A String", # Output only. When the rbacrolebinding was created.
-  "deleteTime": "A String", # Output only. When the rbacrolebinding was deleted.
-  "group": "A String", # group is the group, as seen by the kubernetes cluster.
-  "labels": { # Optional. Labels for this RBACRolebinding.
-    "a_key": "A String",
-  },
-  "name": "A String", # The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
-  "role": { # Role is the type for Kubernetes roles # Required. Role to bind to the principal
-    "predefinedRole": "A String", # predefined_role is the Kubernetes default role to use
-  },
-  "state": { # RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. # Output only. State of the rbacrolebinding resource.
-    "code": "A String", # Output only. The current state of the rbacrolebinding resource.
-  },
-  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid.
-  "updateTime": "A String", # Output only. When the rbacrolebinding was last updated.
-  "user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all Membership RBACRoleBindings.
@@ -331,62 +147,4 @@ 

Method Details

-
- patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a Membership RBACRoleBinding.
-
-Args:
-  name: string, The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # RBACRoleBinding represents a rbacrolebinding across the Fleet
-  "createTime": "A String", # Output only. When the rbacrolebinding was created.
-  "deleteTime": "A String", # Output only. When the rbacrolebinding was deleted.
-  "group": "A String", # group is the group, as seen by the kubernetes cluster.
-  "labels": { # Optional. Labels for this RBACRolebinding.
-    "a_key": "A String",
-  },
-  "name": "A String", # The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
-  "role": { # Role is the type for Kubernetes roles # Required. Role to bind to the principal
-    "predefinedRole": "A String", # predefined_role is the Kubernetes default role to use
-  },
-  "state": { # RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. # Output only. State of the rbacrolebinding resource.
-    "code": "A String", # Output only. The current state of the rbacrolebinding resource.
-  },
-  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid.
-  "updateTime": "A String", # Output only. When the rbacrolebinding was last updated.
-  "user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
-}
-
-  updateMask: string, Required. The fields to be updated.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
-  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- \ No newline at end of file diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index 21bf67f3c32..99d11c5a4ee 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -256,10 +256,9 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec - "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -467,10 +466,9 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec - "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "namespaceactuation": { # **Namespace Actuation**: The membership-specific input for NamespaceActuation feature. # FNS Actuation membership spec }, @@ -582,9 +580,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -623,13 +619,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -1356,10 +1350,9 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec - "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1567,10 +1560,9 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec - "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "namespaceactuation": { # **Namespace Actuation**: The membership-specific input for NamespaceActuation feature. # FNS Actuation membership spec }, @@ -1682,9 +1674,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -1723,13 +1713,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -2444,10 +2432,9 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec - "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -2655,10 +2642,9 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec - "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "namespaceactuation": { # **Namespace Actuation**: The membership-specific input for NamespaceActuation feature. # FNS Actuation membership spec }, @@ -2770,9 +2756,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -2811,13 +2795,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -3488,10 +3470,9 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec - "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -3699,10 +3680,9 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec - "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "namespaceactuation": { # **Namespace Actuation**: The membership-specific input for NamespaceActuation feature. # FNS Actuation membership spec }, @@ -3814,9 +3794,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -3855,13 +3833,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index 7894d571171..d724f1f72a9 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -257,7 +257,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -466,7 +466,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -570,9 +570,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -611,13 +609,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -1230,7 +1226,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1439,7 +1435,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -1543,9 +1539,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -1584,13 +1578,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -2191,7 +2183,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -2400,7 +2392,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -2504,9 +2496,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -2545,13 +2535,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -3108,7 +3096,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -3317,7 +3305,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Optional. Enables automatic Service Mesh management. + "management": "A String", # Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -3421,9 +3409,7 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod - "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod - "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -3462,13 +3448,11 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission-webhook pod + "admissionWebhook": "A String", # Version of the deployed admission_webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod - "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod - "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html index 39ceb9dee30..208dda47cf7 100644 --- a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html +++ b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html @@ -95,6 +95,9 @@

Instance Methods

list(name, keyTypes=None, x__xgafv=None)

Lists every ServiceAccountKey for a service account.

+

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

+

Patches a ServiceAccountKey.

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

Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.

@@ -127,6 +130,9 @@

Method Details

An object of the form: { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. + "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. + "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. + "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -235,6 +241,9 @@

Method Details

An object of the form: { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. + "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. + "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. + "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -277,6 +286,9 @@

Method Details

{ # The service account keys list response. "keys": [ # The public keys for the service account. { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. + "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. + "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. + "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -299,6 +311,73 @@

Method Details

} +
+ patch(name, body=None, x__xgafv=None) +
Patches a ServiceAccountKey.
+
+Args:
+  name: string, The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The service account key patch request.
+  "serviceAccountKey": { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. # Required. The service account key to update.
+    "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
+    "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
+    "description": "A String", # Optional. A user provided description of this service account key.
+    "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
+    "disabled": True or False, # The key status.
+    "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
+      { # Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
+        "key": "A String", # The key for this extended status.
+        "value": "A String", # The value for the extended status.
+      },
+    ],
+    "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
+    "keyOrigin": "A String", # The key origin.
+    "keyType": "A String", # The key type.
+    "name": "A String", # The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
+    "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
+    "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
+    "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
+    "validAfterTime": "A String", # The key can be used after this timestamp.
+    "validBeforeTime": "A String", # The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
+  },
+  "updateMask": "A String", # Required. The update mask to apply to the service account key. Only the following fields are eligible for patching: - contact - description
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.
+  "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
+  "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
+  "description": "A String", # Optional. A user provided description of this service account key.
+  "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
+  "disabled": True or False, # The key status.
+  "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
+    { # Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
+      "key": "A String", # The key for this extended status.
+      "value": "A String", # The value for the extended status.
+    },
+  ],
+  "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
+  "keyOrigin": "A String", # The key origin.
+  "keyType": "A String", # The key type.
+  "name": "A String", # The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
+  "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
+  "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
+  "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
+  "validAfterTime": "A String", # The key can be used after this timestamp.
+  "validBeforeTime": "A String", # The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
+}
+
+
upload(name, body=None, x__xgafv=None)
Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.
@@ -321,6 +400,9 @@ 

Method Details

An object of the form: { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. + "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. + "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. + "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 059ad88ad4f..4adf2c7fb67 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -49,10 +49,6 @@ * [v4.1](http://googleapis.github.io/google-api-python-client/docs/dyn/adsensehost_v4_1.html) -## adsenseplatform -* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/adsenseplatform_v1alpha.html) - - ## advisorynotifications * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/advisorynotifications_v1.html) @@ -414,10 +410,6 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/contentwarehouse_v1.html) -## css -* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/css_v1.html) - - ## customsearch * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/customsearch_v1.html) diff --git a/docs/dyn/integrations_v1.projects.locations.templates.html b/docs/dyn/integrations_v1.projects.locations.templates.html index c16221890c7..36c3679e2f4 100644 --- a/docs/dyn/integrations_v1.projects.locations.templates.html +++ b/docs/dyn/integrations_v1.projects.locations.templates.html @@ -6546,14 +6546,77 @@

Method Details

The object takes the form of: { # Request to Import template - "integration": "A String", # Required. Name of the integration where template needs to be imported. - "integrationRegion": "A String", # Required. The region of the Integration to be created. - "subIntegrations": { # Optional. Sub Integration which would be created via templates. - "a_key": { # Sub Integration which would be created via templates. - "integration": "A String", # Required. Name of the sub integration which would be created via templates. - "integrationDescription": "A String", # Optional. Description of the sub integration which would be created via templates. + "configParameters": [ # Optional. Config parameters which would be used to configure template bundles. + { # Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes. + "parameter": { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition. # Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables. + "containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage. + "dataType": "A String", # Type of the parameter. + "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object. + "booleanArray": { # This message only contains a field of boolean array. # Boolean Array. + "booleanValues": [ # Boolean array. + True or False, + ], + }, + "booleanValue": True or False, # Boolean. + "doubleArray": { # This message only contains a field of double number array. # Double Number Array. + "doubleValues": [ # Double number array. + 3.14, + ], + }, + "doubleValue": 3.14, # Double Number. + "intArray": { # This message only contains a field of integer array. # Integer Array. + "intValues": [ # Integer array. + "A String", + ], + }, + "intValue": "A String", # Integer. + "jsonValue": "A String", # Json. + "stringArray": { # This message only contains a field of string array. # String Array. + "stringValues": [ # String array. + "A String", + ], + }, + "stringValue": "A String", # String. + }, + "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. + "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter. + "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. + "masked": True or False, # True if this parameter should be masked in the logs + "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param. + "searchable": True or False, # Searchable in the execution log or not. + }, + "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object. + "booleanArray": { # This message only contains a field of boolean array. # Boolean Array. + "booleanValues": [ # Boolean array. + True or False, + ], + }, + "booleanValue": True or False, # Boolean. + "doubleArray": { # This message only contains a field of double number array. # Double Number Array. + "doubleValues": [ # Double number array. + 3.14, + ], + }, + "doubleValue": 3.14, # Double Number. + "intArray": { # This message only contains a field of integer array. # Integer Array. + "intValues": [ # Integer array. + "A String", + ], + }, + "intValue": "A String", # Integer. + "jsonValue": "A String", # Json. + "stringArray": { # This message only contains a field of string array. # String Array. + "stringValues": [ # String array. + "A String", + ], + }, + "stringValue": "A String", # String. + }, }, - }, + ], + "integration": "A String", # Required. Name of the integration where template needs to be imported. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html b/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html index a16cf51d337..5ed7f9d922d 100644 --- a/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html +++ b/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Returns all data associated with the requested query.

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

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

Lists the SavedQueries that were created by the user making the request.

list_next()

@@ -220,12 +220,11 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the SavedQueries that were created by the user making the request.
 
 Args:
   parent: string, Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-"  (required)
-  filter: string, Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED
   pageSize: integer, Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/logging_v2.folders.html b/docs/dyn/logging_v2.folders.html
index a691dc9e063..1b66347b404 100644
--- a/docs/dyn/logging_v2.folders.html
+++ b/docs/dyn/logging_v2.folders.html
@@ -177,7 +177,7 @@ 

Method Details

Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.UpdateSettings fails when any of the following are true: The value of storage_location either isn't supported by Logging or violates the location OrgPolicy. The default_sink_config field is set, but it has an unspecified filter write mode. The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Configure default settings for organizations and folders (https://cloud.google.com/logging/docs/default-settings) for more information.
 
 Args:
-  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" (required)
+  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/logging_v2.folders.locations.savedQueries.html b/docs/dyn/logging_v2.folders.locations.savedQueries.html
index a72dc4c39d4..48b0adf2ddc 100644
--- a/docs/dyn/logging_v2.folders.locations.savedQueries.html
+++ b/docs/dyn/logging_v2.folders.locations.savedQueries.html
@@ -87,7 +87,7 @@ 

Instance Methods

get(name, x__xgafv=None)

Returns all data associated with the requested query.

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

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

Lists the SavedQueries that were created by the user making the request.

list_next()

@@ -220,12 +220,11 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the SavedQueries that were created by the user making the request.
 
 Args:
   parent: string, Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-"  (required)
-  filter: string, Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED
   pageSize: integer, Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/logging_v2.organizations.html b/docs/dyn/logging_v2.organizations.html
index eb8ceba9a80..40bf00de094 100644
--- a/docs/dyn/logging_v2.organizations.html
+++ b/docs/dyn/logging_v2.organizations.html
@@ -213,7 +213,7 @@ 

Method Details

Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.UpdateSettings fails when any of the following are true: The value of storage_location either isn't supported by Logging or violates the location OrgPolicy. The default_sink_config field is set, but it has an unspecified filter write mode. The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Configure default settings for organizations and folders (https://cloud.google.com/logging/docs/default-settings) for more information.
 
 Args:
-  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" (required)
+  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/logging_v2.organizations.locations.savedQueries.html b/docs/dyn/logging_v2.organizations.locations.savedQueries.html
index ddd0afb28c7..48d7ba47e9a 100644
--- a/docs/dyn/logging_v2.organizations.locations.savedQueries.html
+++ b/docs/dyn/logging_v2.organizations.locations.savedQueries.html
@@ -87,7 +87,7 @@ 

Instance Methods

get(name, x__xgafv=None)

Returns all data associated with the requested query.

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

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

Lists the SavedQueries that were created by the user making the request.

list_next()

@@ -220,12 +220,11 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the SavedQueries that were created by the user making the request.
 
 Args:
   parent: string, Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-"  (required)
-  filter: string, Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED
   pageSize: integer, Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/logging_v2.projects.locations.savedQueries.html b/docs/dyn/logging_v2.projects.locations.savedQueries.html
index 2c885c08053..d596c676c16 100644
--- a/docs/dyn/logging_v2.projects.locations.savedQueries.html
+++ b/docs/dyn/logging_v2.projects.locations.savedQueries.html
@@ -87,7 +87,7 @@ 

Instance Methods

get(name, x__xgafv=None)

Returns all data associated with the requested query.

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

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

Lists the SavedQueries that were created by the user making the request.

list_next()

@@ -220,12 +220,11 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the SavedQueries that were created by the user making the request.
 
 Args:
   parent: string, Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-"  (required)
-  filter: string, Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED
   pageSize: integer, Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/logging_v2.v2.html b/docs/dyn/logging_v2.v2.html
index dd8429b5ae7..0e46f8aa473 100644
--- a/docs/dyn/logging_v2.v2.html
+++ b/docs/dyn/logging_v2.v2.html
@@ -193,7 +193,7 @@ 

Method Details

Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.UpdateSettings fails when any of the following are true: The value of storage_location either isn't supported by Logging or violates the location OrgPolicy. The default_sink_config field is set, but it has an unspecified filter write mode. The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Configure default settings for organizations and folders (https://cloud.google.com/logging/docs/default-settings) for more information.
 
 Args:
-  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" (required)
+  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/meet_v2.spaces.html b/docs/dyn/meet_v2.spaces.html
index d7f913b2575..9512ee26de6 100644
--- a/docs/dyn/meet_v2.spaces.html
+++ b/docs/dyn/meet_v2.spaces.html
@@ -82,13 +82,13 @@ 

Instance Methods

Creates a space.

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

-

Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).

+

Ends an active conference (if there's one).

get(name, x__xgafv=None)

-

Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).

+

Gets a space by `space_id` or `meeting_code`.

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

-

Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).

+

Updates a space.

Method Details

close() @@ -111,9 +111,9 @@

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). + "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` } x__xgafv: string, V1 error format. @@ -132,18 +132,18 @@

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). + "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` }
endActiveConference(name, body=None, x__xgafv=None) -
Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).
+  
Ends an active conference (if there's one).
 
 Args:
-  name: string, Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
+  name: string, Required. Resource name of the space. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -164,10 +164,10 @@ 

Method Details

get(name, x__xgafv=None) -
Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).
+  
Gets a space by `space_id` or `meeting_code`.
 
 Args:
-  name: string, Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
+  name: string, Required. Resource name of the space. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -184,18 +184,18 @@ 

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). + "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` }
patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).
+  
Updates a space.
 
 Args:
-  name: string, Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
+  name: string, Immutable. Resource name of the space. Format: `spaces/{space}` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -207,9 +207,9 @@ 

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). + "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` } updateMask: string, Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided, it defaults to '*' and updates all fields provided in the request, including deleting fields not set in the request. @@ -229,9 +229,9 @@

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). + "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` }
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html deleted file mode 100644 index 5094ee14455..00000000000 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html +++ /dev/null @@ -1,186 +0,0 @@ - - - -

Merchant API . accounts . businessIdentity

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- getBusinessIdentity(name, x__xgafv=None)

-

Retrieves the business identity of an account.

-

- updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None)

-

Updates the business identity of an account. Executing this method requires admin access.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- getBusinessIdentity(name, x__xgafv=None) -
Retrieves the business identity of an account.
-
-Args:
-  name: string, Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
-  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
-  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
-  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-}
-
- -
- updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None) -
Updates the business identity of an account. Executing this method requires admin access.
-
-Args:
-  name: string, Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
-  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
-  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
-  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-}
-
-  updateMask: string, Required. List of fields being updated.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
-  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
-  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
-  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html deleted file mode 100644 index 3e031b011e9..00000000000 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html +++ /dev/null @@ -1,252 +0,0 @@ - - - -

Merchant API . accounts . businessInfo

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- getBusinessInfo(name, x__xgafv=None)

-

Retrieves the business info of an account.

-

- updateBusinessInfo(name, body=None, updateMask=None, x__xgafv=None)

-

Updates the business info of an account. Executing this method requires admin access.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- getBusinessInfo(name, x__xgafv=None) -
Retrieves the business info of an account.
-
-Args:
-  name: string, Required. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Collection of information related to a business.
-  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
-    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
-      "A String",
-    ],
-    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
-    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
-    "organization": "A String", # Optional. The name of the organization at the address.
-    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
-    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
-      "A String",
-    ],
-    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
-    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
-    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
-  },
-  "customerService": { # Customer service information. # Optional. The customer service of the business.
-    "email": "A String", # Optional. The email address where customer service may be reached.
-    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
-      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-      },
-    },
-    "uri": "A String", # Optional. The URI where customer service may be found.
-  },
-  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
-  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
-    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-    },
-  },
-  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
-}
-
- -
- updateBusinessInfo(name, body=None, updateMask=None, x__xgafv=None) -
Updates the business info of an account. Executing this method requires admin access.
-
-Args:
-  name: string, Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Collection of information related to a business.
-  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
-    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
-      "A String",
-    ],
-    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
-    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
-    "organization": "A String", # Optional. The name of the organization at the address.
-    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
-    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
-      "A String",
-    ],
-    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
-    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
-    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
-  },
-  "customerService": { # Customer service information. # Optional. The customer service of the business.
-    "email": "A String", # Optional. The email address where customer service may be reached.
-    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
-      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-      },
-    },
-    "uri": "A String", # Optional. The URI where customer service may be found.
-  },
-  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
-  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
-    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-    },
-  },
-  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
-}
-
-  updateMask: string, Required. List of fields being updated.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Collection of information related to a business.
-  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
-    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
-      "A String",
-    ],
-    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
-    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
-    "organization": "A String", # Optional. The name of the organization at the address.
-    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
-    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
-      "A String",
-    ],
-    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
-    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
-    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
-  },
-  "customerService": { # Customer service information. # Optional. The customer service of the business.
-    "email": "A String", # Optional. The email address where customer service may be reached.
-    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
-      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-      },
-    },
-    "uri": "A String", # Optional. The URI where customer service may be found.
-  },
-  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
-  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
-    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-    },
-  },
-  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.emailpreferences.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.emailpreferences.html deleted file mode 100644 index daa5e117b22..00000000000 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.emailpreferences.html +++ /dev/null @@ -1,141 +0,0 @@ - - - -

Merchant API . accounts . emailpreferences

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- getEmailPreferences(name, x__xgafv=None)

-

Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

-

- updateEmailPreferences(name, body=None, updateMask=None, x__xgafv=None)

-

Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- getEmailPreferences(name, x__xgafv=None) -
Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
-
-Args:
-  name: string, Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
-  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
-  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
-}
-
- -
- updateEmailPreferences(name, body=None, updateMask=None, x__xgafv=None) -
Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.
-
-Args:
-  name: string, Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
-  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
-  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
-}
-
-  updateMask: string, Required. List of fields being updated.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
-  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
-  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html index fc15b04da3c..d0ed0259382 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html @@ -80,15 +80,9 @@

Instance Methods

close()

Close httplib2 connections.

-

- getHomepage(name, x__xgafv=None)

-

Retrieves a store's homepage.

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

Unclaims a store's homepage. Executing this method requires admin access.

-

- updateHomepage(name, body=None, updateMask=None, x__xgafv=None)

-

Updates a store's homepage. Executing this method requires admin access.

Method Details

claim(name, body=None, x__xgafv=None) @@ -122,27 +116,6 @@

Method Details

Close httplib2 connections.
-
- getHomepage(name, x__xgafv=None) -
Retrieves a store's homepage.
-
-Args:
-  name: string, Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A store's homepage.
-  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
-  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
-  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
-}
-
-
unclaim(name, body=None, x__xgafv=None)
Unclaims a store's homepage. Executing this method requires admin access.
@@ -170,35 +143,4 @@ 

Method Details

}
-
- updateHomepage(name, body=None, updateMask=None, x__xgafv=None) -
Updates a store's homepage. Executing this method requires admin access.
-
-Args:
-  name: string, Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # A store's homepage.
-  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
-  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
-  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
-}
-
-  updateMask: string, Required. List of fields being updated.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A store's homepage.
-  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
-  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
-  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
-}
-
- \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html index 5e4448c974a..fc6bd5833a4 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html @@ -79,21 +79,6 @@

Instance Methods

Returns the accounttax Resource.

-

- businessIdentity() -

-

Returns the businessIdentity Resource.

- -

- businessInfo() -

-

Returns the businessInfo Resource.

- -

- emailpreferences() -

-

Returns the emailpreferences Resource.

-

homepage()

@@ -146,6 +131,18 @@

Instance Methods

get(name, x__xgafv=None)

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

+

+ getBusinessIdentity(name, x__xgafv=None)

+

Retrieves the business identity of an account.

+

+ getBusinessInfo(name, x__xgafv=None)

+

Retrieves the business info of an account.

+

+ getHomepage(name, x__xgafv=None)

+

Retrieves a store's homepage.

+

+ getShippingSettings(name, x__xgafv=None)

+

Retrieve shipping setting information.

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

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.

@@ -161,6 +158,15 @@

Instance Methods

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

Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.

+

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

+

Updates the business identity of an account. Executing this method requires admin access.

+

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

+

Updates the business info of an account. Executing this method requires admin access.

+

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

+

Updates a store's homepage. Executing this method requires admin access.

Method Details

close() @@ -282,6 +288,442 @@

Method Details

}
+
+ getBusinessIdentity(name, x__xgafv=None) +
Retrieves the business identity of an account.
+
+Args:
+  name: string, Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
+  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
+  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
+  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+}
+
+ +
+ getBusinessInfo(name, x__xgafv=None) +
Retrieves the business info of an account.
+
+Args:
+  name: string, Required. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of information related to a business.
+  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+  },
+  "customerService": { # Customer service information. # Optional. The customer service of the business.
+    "email": "A String", # Optional. The email address where customer service may be reached.
+    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
+      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+      },
+    },
+    "uri": "A String", # Optional. The URI where customer service may be found.
+  },
+  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
+  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
+    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+    },
+  },
+  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
+}
+
+ +
+ getHomepage(name, x__xgafv=None) +
Retrieves a store's homepage.
+
+Args:
+  name: string, Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A store's homepage.
+  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
+  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
+  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
+}
+
+ +
+ getShippingSettings(name, x__xgafv=None) +
Retrieve shipping setting information.
+
+Args:
+  name: string, Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284).
+  "etag": "A String", # Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps: 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.
+  "name": "A String", # Identifier. The resource name of the shipping setting. Format: `accounts/{account}/shippingSetting`
+  "services": [ # Optional. The target account's list of services.
+    { # Shipping service.
+      "active": True or False, # Required. A boolean exposing the active status of the shipping service.
+      "currencyCode": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
+      "deliveryCountries": [ # Required. The CLDR territory code of the countries to which the service applies.
+        "A String",
+      ],
+      "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. # Required. Time spent in various aspects from order to the delivery of the product.
+        "cutoffTime": { # Business days cutoff time definition. # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
+          "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.
+          "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.
+          "timeZone": "A String", # Required. [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example "Europe/Zurich".
+        },
+        "handlingBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
+          "businessDays": [ # Required. Regular business days. May not be empty.
+            "A String",
+          ],
+        },
+        "maxHandlingDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`.
+        "maxTransitDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `min_transit_days`.
+        "minHandlingDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
+        "minTransitDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `min_transit_days`, `max_transit_days` or `transit_time_table` must be set, but not both.
+        "transitBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
+          "businessDays": [ # Required. Regular business days. May not be empty.
+            "A String",
+          ],
+        },
+        "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both. # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both.
+          "postalCodeGroupNames": [ # Required. A list of region names Region.name . The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
+            "A String",
+          ],
+          "rows": [ # Required. If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
+            { # If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
+              "values": [ # Required. Transit time range (min-max) in business days.
+                { # Transit time range (min-max) in business days.
+                  "maxTransitDays": 42, # Must be greater than or equal to `min_transit_days`.
+                  "minTransitDays": 42, # Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery.
+                },
+              ],
+            },
+          ],
+          "transitTimeLabels": [ # Required. A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
+            "A String",
+          ],
+        },
+        "warehouseBasedDeliveryTimes": [ # Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery time should be set.
+          { # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in `delivery_time` should be set.
+            "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`.
+            "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The name of the service must be in the eddSupportedServices list.
+            "warehouse": "A String", # Required. Warehouse name. This should match warehouse
+          },
+        ],
+      },
+      "loyaltyPrograms": [ # Optional. Loyalty programs that this shipping service is limited to.
+        { # [Loyalty program](https://support.google.com/merchants/answer/12922446) provided by a merchant.
+          "loyaltyProgramTiers": [ # Optional. Loyalty program tier of this shipping service.
+            { # Subset of a merchants loyalty program.
+              "tierLabel": "A String", # The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier.
+            },
+          ],
+          "programLabel": "A String", # This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers.
+        },
+      ],
+      "minimumOrderValue": { # The price represented as a number and currency. # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
+        "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+        "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+      },
+      "minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
+        "storeCodeSetWithMovs": [ # Required. A list of store code sets sharing the same minimum order value (MOV). At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
+          { # A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
+            "storeCodes": [ # Optional. A list of unique store codes or empty for the catch all.
+              "A String",
+            ],
+            "value": { # The price represented as a number and currency. # The minimum order value for the given stores.
+              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+            },
+          },
+        ],
+      },
+      "rateGroups": [ # Optional. Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
+        { # Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
+          "applicableShippingLabels": [ # Required. A list of [shipping labels](https://support.google.com/merchants/answer/6324504) defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service.
+            "A String",
+          ],
+          "carrierRates": [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
+            { # A list of carrier rates that can be referred to by `main_table` or `single_value`.
+              "carrier": "A String", # Required. Carrier service, such as `"UPS"` or `"Fedex"`.
+              "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`.
+              "flatAdjustment": { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ "amount_micros": 1, "currency_code" : "USD" }` adds $1 to the rate, `{ "amount_micros": -3, "currency_code" : "USD" }` removes $3 from the rate.
+                "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+              },
+              "name": "A String", # Required. Name of the carrier rate. Must be unique per rate group.
+              "originPostalCode": "A String", # Required. Shipping origin for this carrier rate.
+              "percentageAdjustment": "A String", # Optional. Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%.
+            },
+          ],
+          "mainTable": { # A table defining the rate group, when `single_value` is not expressive enough. # A table defining the rate group, when `single_value` is not expressive enough. Can only be set if `single_value` is not set.
+            "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
+              "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                  "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
+                    "A String",
+                  ],
+                },
+              ],
+              "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
+                "A String",
+              ],
+              "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
+                "A String",
+              ],
+              "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                { # The price represented as a number and currency.
+                  "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                  "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                },
+              ],
+              "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                { # The weight represented as the value in string and the unit.
+                  "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
+                  "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
+                },
+              ],
+            },
+            "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
+            "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
+              "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                  "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
+                    "A String",
+                  ],
+                },
+              ],
+              "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
+                "A String",
+              ],
+              "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
+                "A String",
+              ],
+              "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                { # The price represented as a number and currency.
+                  "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                  "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                },
+              ],
+              "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                { # The weight represented as the value in string and the unit.
+                  "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
+                  "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
+                },
+              ],
+            },
+            "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
+              { # Include a list of cells.
+                "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables.
+                  { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
+                    "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
+                    "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
+                      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                    },
+                    "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
+                    "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
+                    "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
+                  },
+                ],
+              },
+            ],
+          },
+          "name": "A String", # Optional. Name of the rate group. If set has to be unique within shipping service.
+          "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. # The value of the rate group (For example flat rate $10). Can only be set if `main_table` and `subtables` are not set.
+            "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
+            "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
+              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+            },
+            "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
+            "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
+            "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
+          },
+          "subtables": [ # Optional. A list of subtables referred to by `main_table`. Can only be set if `main_table` is set.
+            { # A table defining the rate group, when `single_value` is not expressive enough.
+              "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
+                "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                  { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                    "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
+                      "A String",
+                    ],
+                  },
+                ],
+                "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
+                  "A String",
+                ],
+                "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
+                  "A String",
+                ],
+                "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                  { # The price represented as a number and currency.
+                    "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                    "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                  },
+                ],
+                "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                  { # The weight represented as the value in string and the unit.
+                    "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
+                    "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
+                  },
+                ],
+              },
+              "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
+              "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
+                "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                  { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                    "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
+                      "A String",
+                    ],
+                  },
+                ],
+                "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
+                  "A String",
+                ],
+                "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
+                  "A String",
+                ],
+                "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                  { # The price represented as a number and currency.
+                    "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                    "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                  },
+                ],
+                "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                  { # The weight represented as the value in string and the unit.
+                    "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
+                    "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
+                  },
+                ],
+              },
+              "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
+                { # Include a list of cells.
+                  "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables.
+                    { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
+                      "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
+                      "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
+                        "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                        "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                      },
+                      "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
+                      "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
+                      "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+      "serviceName": "A String", # Required. Free-form name of the service. Must be unique within target account.
+      "shipmentType": "A String", # Type of locations this service ships orders to.
+      "storeConfig": { # A list of stores your products are delivered from. This is only valid for the local delivery shipment type. # A list of stores your products are delivered from. This is only valid for the local delivery shipment type.
+        "cutoffConfig": { # Configs related to local delivery ends for the day. # Configs related to local delivery ends for the day.
+          "localCutoffTime": { # Time that local delivery ends for the day. # Time that local delivery ends for the day.
+            "hour": "A String", # Hour local delivery orders must be placed by to process the same day.
+            "minute": "A String", # Minute local delivery orders must be placed by to process the same day.
+          },
+          "noDeliveryPostCutoff": True or False, # Merchants can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery.
+          "storeCloseOffsetHours": "A String", # Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with `local_cutoff_time`.
+        },
+        "serviceRadius": { # Maximum delivery radius. This is only required for the local delivery shipment type. # Maximum delivery radius. This is only required for the local delivery shipment type.
+          "unit": "A String", # Unit can differ based on country, it is parameterized to include miles and kilometers.
+          "value": "A String", # Integer value of distance.
+        },
+        "storeCodes": [ # Optional. A list of store codes that provide local delivery. If empty, then `all_stores` must be true.
+          "A String",
+        ],
+        "storeServiceType": "A String", # Indicates whether all stores, or selected stores, listed by this merchant provide local delivery.
+      },
+    },
+  ],
+  "warehouses": [ # Optional. A list of warehouses which can be referred to in `services`.
+    { # A fulfillment warehouse, which stores and handles inventory. Next tag: 7
+      "businessDayConfig": { # Business days of the warehouse. # Business days of the warehouse. If not set, will be Monday to Friday by default.
+        "businessDays": [ # Required. Regular business days. May not be empty.
+          "A String",
+        ],
+      },
+      "cutoffTime": { # The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.
+        "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse.
+        "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse.
+      },
+      "handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item.
+      "name": "A String", # Required. The name of the warehouse. Must be unique within account.
+      "shippingAddress": { # Shipping address of the warehouse. # Required. Shipping address of the warehouse.
+        "administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+        "city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).
+        "postalCode": "A String", # Required. Postal code or ZIP (For example "94043").
+        "regionCode": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (For example "US").
+        "streetAddress": "A String", # Street-level part of the address. For example: `111w 31st Street`.
+      },
+    },
+  ],
+}
+
+
list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.
@@ -425,4 +867,197 @@ 

Method Details

}
+
+ updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None) +
Updates the business identity of an account. Executing this method requires admin access.
+
+Args:
+  name: string, Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
+  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
+  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
+  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+}
+
+  updateMask: string, Required. List of fields being updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
+  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
+  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
+  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+}
+
+ +
+ updateBusinessInfo(name, body=None, updateMask=None, x__xgafv=None) +
Updates the business info of an account. Executing this method requires admin access.
+
+Args:
+  name: string, Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Collection of information related to a business.
+  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+  },
+  "customerService": { # Customer service information. # Optional. The customer service of the business.
+    "email": "A String", # Optional. The email address where customer service may be reached.
+    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
+      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+      },
+    },
+    "uri": "A String", # Optional. The URI where customer service may be found.
+  },
+  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
+  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
+    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+    },
+  },
+  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
+}
+
+  updateMask: string, Required. List of fields being updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of information related to a business.
+  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+  },
+  "customerService": { # Customer service information. # Optional. The customer service of the business.
+    "email": "A String", # Optional. The email address where customer service may be reached.
+    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
+      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+      },
+    },
+    "uri": "A String", # Optional. The URI where customer service may be found.
+  },
+  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
+  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
+    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+    },
+  },
+  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
+}
+
+ +
+ updateHomepage(name, body=None, updateMask=None, x__xgafv=None) +
Updates a store's homepage. Executing this method requires admin access.
+
+Args:
+  name: string, Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A store's homepage.
+  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
+  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
+  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
+}
+
+  updateMask: string, Required. List of fields being updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A store's homepage.
+  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
+  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
+  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html index 0b50e7dc2ee..7409eb3ccd2 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html @@ -77,9 +77,6 @@

Instance Methods

close()

Close httplib2 connections.

-

- getShippingSettings(name, x__xgafv=None)

-

Retrieve shipping setting information.

insert(parent, body=None, x__xgafv=None)

Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.

@@ -89,329 +86,6 @@

Method Details

Close httplib2 connections.
-
- getShippingSettings(name, x__xgafv=None) -
Retrieve shipping setting information.
-
-Args:
-  name: string, Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284).
-  "etag": "A String", # Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps: 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.
-  "name": "A String", # Identifier. The resource name of the shipping setting. Format: `accounts/{account}/shippingSetting`
-  "services": [ # Optional. The target account's list of services.
-    { # Shipping service.
-      "active": True or False, # Required. A boolean exposing the active status of the shipping service.
-      "currencyCode": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
-      "deliveryCountries": [ # Required. The CLDR territory code of the countries to which the service applies.
-        "A String",
-      ],
-      "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. # Required. Time spent in various aspects from order to the delivery of the product.
-        "cutoffTime": { # Business days cutoff time definition. # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
-          "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.
-          "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.
-          "timeZone": "A String", # Required. [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example "Europe/Zurich".
-        },
-        "handlingBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
-          "businessDays": [ # Required. Regular business days. May not be empty.
-            "A String",
-          ],
-        },
-        "maxHandlingDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`.
-        "maxTransitDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `min_transit_days`.
-        "minHandlingDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
-        "minTransitDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `min_transit_days`, `max_transit_days` or `transit_time_table` must be set, but not both.
-        "transitBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
-          "businessDays": [ # Required. Regular business days. May not be empty.
-            "A String",
-          ],
-        },
-        "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both. # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both.
-          "postalCodeGroupNames": [ # Required. A list of region names Region.name . The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
-            "A String",
-          ],
-          "rows": [ # Required. If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
-            { # If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
-              "values": [ # Required. Transit time range (min-max) in business days.
-                { # Transit time range (min-max) in business days.
-                  "maxTransitDays": 42, # Must be greater than or equal to `min_transit_days`.
-                  "minTransitDays": 42, # Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery.
-                },
-              ],
-            },
-          ],
-          "transitTimeLabels": [ # Required. A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
-            "A String",
-          ],
-        },
-        "warehouseBasedDeliveryTimes": [ # Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery time should be set.
-          { # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in `delivery_time` should be set.
-            "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`.
-            "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The name of the service must be in the eddSupportedServices list.
-            "warehouse": "A String", # Required. Warehouse name. This should match warehouse
-          },
-        ],
-      },
-      "loyaltyPrograms": [ # Optional. Loyalty programs that this shipping service is limited to.
-        { # [Loyalty program](https://support.google.com/merchants/answer/12922446) provided by a merchant.
-          "loyaltyProgramTiers": [ # Optional. Loyalty program tier of this shipping service.
-            { # Subset of a merchants loyalty program.
-              "tierLabel": "A String", # The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier.
-            },
-          ],
-          "programLabel": "A String", # This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers.
-        },
-      ],
-      "minimumOrderValue": { # The price represented as a number and currency. # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
-        "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-        "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-      },
-      "minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
-        "storeCodeSetWithMovs": [ # Required. A list of store code sets sharing the same minimum order value (MOV). At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
-          { # A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
-            "storeCodes": [ # Optional. A list of unique store codes or empty for the catch all.
-              "A String",
-            ],
-            "value": { # The price represented as a number and currency. # The minimum order value for the given stores.
-              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-            },
-          },
-        ],
-      },
-      "rateGroups": [ # Optional. Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
-        { # Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
-          "applicableShippingLabels": [ # Required. A list of [shipping labels](https://support.google.com/merchants/answer/6324504) defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service.
-            "A String",
-          ],
-          "carrierRates": [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
-            { # A list of carrier rates that can be referred to by `main_table` or `single_value`.
-              "carrier": "A String", # Required. Carrier service, such as `"UPS"` or `"Fedex"`.
-              "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`.
-              "flatAdjustment": { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ "amount_micros": 1, "currency_code" : "USD" }` adds $1 to the rate, `{ "amount_micros": -3, "currency_code" : "USD" }` removes $3 from the rate.
-                "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-              },
-              "name": "A String", # Required. Name of the carrier rate. Must be unique per rate group.
-              "originPostalCode": "A String", # Required. Shipping origin for this carrier rate.
-              "percentageAdjustment": "A String", # Optional. Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%.
-            },
-          ],
-          "mainTable": { # A table defining the rate group, when `single_value` is not expressive enough. # A table defining the rate group, when `single_value` is not expressive enough. Can only be set if `single_value` is not set.
-            "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
-              "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                  "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
-                    "A String",
-                  ],
-                },
-              ],
-              "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
-                "A String",
-              ],
-              "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
-                "A String",
-              ],
-              "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                { # The price represented as a number and currency.
-                  "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                  "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                },
-              ],
-              "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                { # The weight represented as the value in string and the unit.
-                  "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
-                  "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
-                },
-              ],
-            },
-            "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
-            "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
-              "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                  "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
-                    "A String",
-                  ],
-                },
-              ],
-              "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
-                "A String",
-              ],
-              "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
-                "A String",
-              ],
-              "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                { # The price represented as a number and currency.
-                  "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                  "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                },
-              ],
-              "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                { # The weight represented as the value in string and the unit.
-                  "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
-                  "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
-                },
-              ],
-            },
-            "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
-              { # Include a list of cells.
-                "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables.
-                  { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
-                    "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
-                    "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
-                      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                    },
-                    "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
-                    "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
-                    "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
-                  },
-                ],
-              },
-            ],
-          },
-          "name": "A String", # Optional. Name of the rate group. If set has to be unique within shipping service.
-          "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. # The value of the rate group (For example flat rate $10). Can only be set if `main_table` and `subtables` are not set.
-            "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
-            "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
-              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-            },
-            "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
-            "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
-            "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
-          },
-          "subtables": [ # Optional. A list of subtables referred to by `main_table`. Can only be set if `main_table` is set.
-            { # A table defining the rate group, when `single_value` is not expressive enough.
-              "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
-                "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                  { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                    "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
-                      "A String",
-                    ],
-                  },
-                ],
-                "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
-                  "A String",
-                ],
-                "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
-                  "A String",
-                ],
-                "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                  { # The price represented as a number and currency.
-                    "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                    "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                  },
-                ],
-                "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                  { # The weight represented as the value in string and the unit.
-                    "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
-                    "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
-                  },
-                ],
-              },
-              "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
-              "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
-                "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                  { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                    "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
-                      "A String",
-                    ],
-                  },
-                ],
-                "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
-                  "A String",
-                ],
-                "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
-                  "A String",
-                ],
-                "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                  { # The price represented as a number and currency.
-                    "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                    "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                  },
-                ],
-                "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                  { # The weight represented as the value in string and the unit.
-                    "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
-                    "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
-                  },
-                ],
-              },
-              "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
-                { # Include a list of cells.
-                  "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables.
-                    { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
-                      "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
-                      "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
-                        "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                        "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                      },
-                      "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
-                      "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
-                      "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
-                    },
-                  ],
-                },
-              ],
-            },
-          ],
-        },
-      ],
-      "serviceName": "A String", # Required. Free-form name of the service. Must be unique within target account.
-      "shipmentType": "A String", # Type of locations this service ships orders to.
-      "storeConfig": { # A list of stores your products are delivered from. This is only valid for the local delivery shipment type. # A list of stores your products are delivered from. This is only valid for the local delivery shipment type.
-        "cutoffConfig": { # Configs related to local delivery ends for the day. # Configs related to local delivery ends for the day.
-          "localCutoffTime": { # Time that local delivery ends for the day. # Time that local delivery ends for the day.
-            "hour": "A String", # Hour local delivery orders must be placed by to process the same day.
-            "minute": "A String", # Minute local delivery orders must be placed by to process the same day.
-          },
-          "noDeliveryPostCutoff": True or False, # Merchants can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery.
-          "storeCloseOffsetHours": "A String", # Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with `local_cutoff_time`.
-        },
-        "serviceRadius": { # Maximum delivery radius. This is only required for the local delivery shipment type. # Maximum delivery radius. This is only required for the local delivery shipment type.
-          "unit": "A String", # Unit can differ based on country, it is parameterized to include miles and kilometers.
-          "value": "A String", # Integer value of distance.
-        },
-        "storeCodes": [ # Optional. A list of store codes that provide local delivery. If empty, then `all_stores` must be true.
-          "A String",
-        ],
-        "storeServiceType": "A String", # Indicates whether all stores, or selected stores, listed by this merchant provide local delivery.
-      },
-    },
-  ],
-  "warehouses": [ # Optional. A list of warehouses which can be referred to in `services`.
-    { # A fulfillment warehouse, which stores and handles inventory. Next tag: 7
-      "businessDayConfig": { # Business days of the warehouse. # Business days of the warehouse. If not set, will be Monday to Friday by default.
-        "businessDays": [ # Required. Regular business days. May not be empty.
-          "A String",
-        ],
-      },
-      "cutoffTime": { # The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.
-        "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse.
-        "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse.
-      },
-      "handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item.
-      "name": "A String", # Required. The name of the warehouse. Must be unique within account.
-      "shippingAddress": { # Shipping address of the warehouse. # Required. Shipping address of the warehouse.
-        "administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
-        "city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).
-        "postalCode": "A String", # Required. Postal code or ZIP (For example "94043").
-        "regionCode": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (For example "US").
-        "streetAddress": "A String", # Street-level part of the address. For example: `111w 31st Street`.
-      },
-    },
-  ],
-}
-
-
insert(parent, body=None, x__xgafv=None)
Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html
index dfb4ac59f9e..1e395b2dce6 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html
@@ -94,7 +94,7 @@ 

Method Details

Returns the state of a terms of service agreement.
 
 Args:
-  name: string, Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` (required)
+  name: string, Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -113,7 +113,7 @@ 

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US` + "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` "regionCode": "A String", # Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. "required": { # Describes the terms of service which are required to be accepted. # The required terms of service "termsOfService": "A String", # The [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) that need to be accepted. @@ -147,7 +147,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US` + "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` "regionCode": "A String", # Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. "required": { # Describes the terms of service which are required to be accepted. # The required terms of service "termsOfService": "A String", # The [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) that need to be accepted. diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html index 004831fec66..90d23dfe607 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html @@ -86,6 +86,9 @@

Instance Methods

get(name, x__xgafv=None)

Retrieves a Merchant Center account user.

+

+ getEmailPreferences(name, x__xgafv=None)

+

Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

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

Lists all users of a Merchant Center account.

@@ -95,6 +98,9 @@

Instance Methods

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

Updates a Merchant Center account user. Executing this method requires admin access.

+

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

+

Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

Method Details

close() @@ -177,6 +183,26 @@

Method Details

}
+
+ getEmailPreferences(name, x__xgafv=None) +
Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
+
+Args:
+  name: string, Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
+  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
+  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all users of a Merchant Center account.
@@ -256,4 +282,33 @@ 

Method Details

}
+
+ updateEmailPreferences(name, body=None, updateMask=None, x__xgafv=None) +
Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.
+
+Args:
+  name: string, Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
+  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
+  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
+}
+
+  updateMask: string, Required. List of fields being updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
+  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
+  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html index f8f1d6769c9..ef9db821e35 100644 --- a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html +++ b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html @@ -206,22 +206,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -444,22 +428,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -670,22 +638,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.html b/docs/dyn/metastore_v1alpha.projects.locations.services.html index 39d831814c6..512cb874a8a 100644 --- a/docs/dyn/metastore_v1alpha.projects.locations.services.html +++ b/docs/dyn/metastore_v1alpha.projects.locations.services.html @@ -422,22 +422,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -694,22 +678,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -911,22 +879,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -1131,22 +1083,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.backups.html b/docs/dyn/metastore_v1beta.projects.locations.services.backups.html index e08c36112c7..4777840b24a 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.services.backups.html +++ b/docs/dyn/metastore_v1beta.projects.locations.services.backups.html @@ -206,22 +206,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -444,22 +428,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -670,22 +638,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.html b/docs/dyn/metastore_v1beta.projects.locations.services.html index b5b648630d6..7f46f24a75e 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.services.html +++ b/docs/dyn/metastore_v1beta.projects.locations.services.html @@ -422,22 +422,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -694,22 +678,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -911,22 +879,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -1131,22 +1083,6 @@

Method Details

}, ], }, - "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. - "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. - { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. - "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. - "expirationTime": "A String", # The certificate expiration time in timestamp format. - }, - ], - "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. - "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. - "A String", - ], - }, - }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html index 4487d8d0463..608e6c4f7ba 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html @@ -176,19 +176,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -220,19 +220,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, @@ -393,19 +393,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -437,19 +437,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, @@ -550,19 +550,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -594,19 +594,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, @@ -715,19 +715,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -759,19 +759,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html index c8f77e4d0a8..e65c71379de 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html @@ -405,19 +405,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -449,19 +449,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, @@ -579,19 +579,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -623,19 +623,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, @@ -1156,19 +1156,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -1200,19 +1200,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, @@ -1330,19 +1330,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -1374,19 +1374,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, @@ -1848,19 +1848,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -1892,19 +1892,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, @@ -2022,19 +2022,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -2066,19 +2066,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). + "licenseType": "A String", # Optional. License type of the OS image. }, }, }, diff --git a/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html b/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html index ff98d807eb8..cea5dc763c5 100644 --- a/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html +++ b/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html @@ -86,6 +86,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single EndpointPolicy.

+

+ 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.

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

Lists EndpointPolicies in a given project and location.

@@ -95,6 +98,12 @@

Instance Methods

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

Updates the parameters of a single EndpointPolicy.

+

+ 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() @@ -250,6 +259,54 @@

Method Details

}
+
+ 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).
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists EndpointPolicies in a given project and location.
@@ -385,4 +442,119 @@ 

Method Details

}
+
+ 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/networkservices_v1.projects.locations.gateways.html b/docs/dyn/networkservices_v1.projects.locations.gateways.html index 3c81899ebe9..f0d653098d9 100644 --- a/docs/dyn/networkservices_v1.projects.locations.gateways.html +++ b/docs/dyn/networkservices_v1.projects.locations.gateways.html @@ -86,6 +86,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Gateway.

+

+ 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.

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

Lists Gateways in a given project and location.

@@ -95,6 +98,12 @@

Instance Methods

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

Updates the parameters of a single Gateway.

+

+ 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() @@ -246,6 +255,54 @@

Method Details

}
+
+ 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).
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Gateways in a given project and location.
@@ -380,4 +437,119 @@ 

Method Details

}
+
+ 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/networkservices_v1.projects.locations.meshes.html b/docs/dyn/networkservices_v1.projects.locations.meshes.html index d4b09936e66..34c2e6e57cb 100644 --- a/docs/dyn/networkservices_v1.projects.locations.meshes.html +++ b/docs/dyn/networkservices_v1.projects.locations.meshes.html @@ -86,6 +86,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Mesh.

+

+ 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.

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

Lists Meshes in a given project and location.

@@ -95,6 +98,12 @@

Instance Methods

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

Updates the parameters of a single Mesh.

+

+ 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() @@ -216,6 +225,54 @@

Method Details

}
+
+ 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).
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Meshes in a given project and location.
@@ -317,4 +374,119 @@ 

Method Details

}
+
+ 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/networkservices_v1.projects.locations.serviceBindings.html b/docs/dyn/networkservices_v1.projects.locations.serviceBindings.html index f96470b83c2..9db0ca9c948 100644 --- a/docs/dyn/networkservices_v1.projects.locations.serviceBindings.html +++ b/docs/dyn/networkservices_v1.projects.locations.serviceBindings.html @@ -86,12 +86,21 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single ServiceBinding.

+

+ 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.

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

Lists ServiceBinding in a given project and location.

list_next()

Retrieves the next page of results.

+

+ 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() @@ -211,6 +220,54 @@

Method Details

}
+
+ 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).
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists ServiceBinding in a given project and location.
@@ -259,4 +316,119 @@ 

Method Details

+
+ 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/networkservices_v1beta1.projects.locations.endpointPolicies.html b/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html index 367a133c97a..8f6f510d65f 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html @@ -86,6 +86,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single EndpointPolicy.

+

+ 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.

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

Lists EndpointPolicies in a given project and location.

@@ -95,6 +98,12 @@

Instance Methods

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

Updates the parameters of a single EndpointPolicy.

+

+ 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() @@ -250,6 +259,54 @@

Method Details

}
+
+ 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).
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists EndpointPolicies in a given project and location.
@@ -385,4 +442,119 @@ 

Method Details

}
+
+ 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/networkservices_v1beta1.projects.locations.gateways.html b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html index 008fd4f7caa..78a329154e0 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html @@ -86,6 +86,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Gateway.

+

+ 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.

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

Lists Gateways in a given project and location.

@@ -95,6 +98,12 @@

Instance Methods

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

Updates the parameters of a single Gateway.

+

+ 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() @@ -246,6 +255,54 @@

Method Details

}
+
+ 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).
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Gateways in a given project and location.
@@ -380,4 +437,119 @@ 

Method Details

}
+
+ 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/networkservices_v1beta1.projects.locations.meshes.html b/docs/dyn/networkservices_v1beta1.projects.locations.meshes.html index a55dcfa173c..0f96c6fe493 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.meshes.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.meshes.html @@ -86,6 +86,9 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Mesh.

+

+ 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.

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

Lists Meshes in a given project and location.

@@ -95,6 +98,12 @@

Instance Methods

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

Updates the parameters of a single Mesh.

+

+ 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() @@ -216,6 +225,54 @@

Method Details

}
+
+ 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).
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Meshes in a given project and location.
@@ -317,4 +374,119 @@ 

Method Details

}
+
+ 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/networkservices_v1beta1.projects.locations.serviceBindings.html b/docs/dyn/networkservices_v1beta1.projects.locations.serviceBindings.html index f21a85d2175..aff85683d41 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.serviceBindings.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.serviceBindings.html @@ -86,12 +86,21 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single ServiceBinding.

+

+ 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.

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

Lists ServiceBinding in a given project and location.

list_next()

Retrieves the next page of results.

+

+ 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() @@ -211,6 +220,54 @@

Method Details

}
+
+ 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).
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists ServiceBinding in a given project and location.
@@ -259,4 +316,119 @@ 

Method Details

+
+ 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/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html index 7a4e3309c90..b94ed1dfdcb 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html @@ -545,6 +545,11 @@

Method Details

"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was. "sbomState": "A String", # The progress of the SBOM generation. }, + "vulnerabilityAttestation": { # The status of an vulnerability attestation generation. # The status of an vulnerability attestation generation. + "error": "A String", # If failure, the error reason for why the attestation generation failed. + "lastAttemptTime": "A String", # The last time we attempted to generate an attestation. + "state": "A String", # The success/failure state of the latest attestation attempt. + }, }, "dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse. "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html index 0b8e033cdeb..bdbb6fe687d 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html @@ -545,6 +545,11 @@

Method Details

"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was. "sbomState": "A String", # The progress of the SBOM generation. }, + "vulnerabilityAttestation": { # The status of an vulnerability attestation generation. # The status of an vulnerability attestation generation. + "error": "A String", # If failure, the error reason for why the attestation generation failed. + "lastAttemptTime": "A String", # The last time we attempted to generate an attestation. + "state": "A String", # The success/failure state of the latest attestation attempt. + }, }, "dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse. "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. diff --git a/docs/dyn/playintegrity_v1.deviceRecall.html b/docs/dyn/playintegrity_v1.deviceRecall.html deleted file mode 100644 index 7de25202f97..00000000000 --- a/docs/dyn/playintegrity_v1.deviceRecall.html +++ /dev/null @@ -1,119 +0,0 @@ - - - -

Google Play Integrity API . deviceRecall

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- write(packageName, body=None, x__xgafv=None)

-

Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP).

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- write(packageName, body=None, x__xgafv=None) -
Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP).
-
-Args:
-  packageName: string, Required. Package name of the app the attached integrity token belongs to. (required)
-  body: object, The request body.
-    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.
-  "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.
-    "bitThird": True or False, # Required. Third recall bit value.
-  },
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response for the Write Device Recall action. Currently empty.
-}
-
- - \ No newline at end of file diff --git a/docs/dyn/playintegrity_v1.html b/docs/dyn/playintegrity_v1.html index d04b6287ee9..9463e229481 100644 --- a/docs/dyn/playintegrity_v1.html +++ b/docs/dyn/playintegrity_v1.html @@ -74,11 +74,6 @@

Google Play Integrity API

Instance Methods

-

- deviceRecall() -

-

Returns the deviceRecall Resource.

-

v1()

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html index 97a9a896f73..e66a6c125af 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html @@ -120,6 +120,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -179,6 +187,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -259,6 +275,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -320,6 +344,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -380,6 +412,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.html b/docs/dyn/retail_v2.projects.locations.catalogs.html index 35c504818ea..f9e75738e57 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.html @@ -203,7 +203,7 @@

Method Details

}, ], "recentSearchResults": [ # Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens. - { # Deprecated: Recent search of this user. + { # Recent search of this user. "recentSearch": "A String", # The recent search query. }, ], @@ -302,6 +302,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -563,6 +571,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -625,6 +641,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html index 59b262049aa..cfb1907f379 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html @@ -123,6 +123,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -183,6 +191,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -297,6 +313,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -359,6 +383,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -420,6 +452,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html index c9bc22895f3..6b42b1e244b 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html @@ -136,6 +136,9 @@

Method Details

"scope": "A String", # [ProductCountScope] of the [counts]. }, ], + "productCounts": { # Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view. + "a_key": "A String", + }, "qualityMetrics": [ # Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in BranchView.BASIC view. { # Metric measured on a group of Products against a certain quality requirement. Contains the number of products that pass the check and the number of products that don't. "qualifiedProductCount": 42, # Number of products passing the quality requirement check. We only check searchable products. @@ -347,6 +350,9 @@

Method Details

"scope": "A String", # [ProductCountScope] of the [counts]. }, ], + "productCounts": { # Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view. + "a_key": "A String", + }, "qualityMetrics": [ # Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in BranchView.BASIC view. { # Metric measured on a group of Products against a certain quality requirement. Contains the number of products that pass the check and the number of products that don't. "qualifiedProductCount": 42, # Number of products passing the quality requirement check. We only check searchable products. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html index 604ad9b8bfc..b6ed7003bda 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html @@ -236,7 +236,7 @@

Method Details

}, ], "recentSearchResults": [ # Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens. - { # Deprecated: Recent search of this user. + { # Recent search of this user. "recentSearch": "A String", # The recent search query. }, ], @@ -335,6 +335,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -654,6 +662,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -717,6 +733,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html index 09eb2b74275..4821a3066cc 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html @@ -123,6 +123,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -183,6 +191,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -297,6 +313,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -359,6 +383,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -420,6 +452,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.html index 3d0c44e06ab..c1e3e2ff801 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.html @@ -203,7 +203,7 @@

Method Details

}, ], "recentSearchResults": [ # Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens. - { # Deprecated: Recent search of this user. + { # Recent search of this user. "recentSearch": "A String", # The recent search query. }, ], @@ -302,6 +302,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -621,6 +629,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -684,6 +700,14 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. + "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. + { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. + "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. + "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. + "A String", + ], + }, + ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index af860d9eaaf..1f0ad7dd322 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -276,7 +276,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, @@ -602,7 +602,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, @@ -915,7 +915,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, @@ -1185,7 +1185,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index 92c71f53320..800009e2442 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -238,7 +238,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -545,7 +545,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -767,7 +767,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index 4fcdc845e6d..a1e199964e9 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -362,7 +362,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -584,7 +584,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html index 1ee99e8e782..110c63bd3b4 100644 --- a/docs/dyn/sheets_v4.spreadsheets.html +++ b/docs/dyn/sheets_v4.spreadsheets.html @@ -2152,7 +2152,7 @@

Method Details

], }, }, - "addDataSource": { # Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source. # Adds a data source. + "addDataSource": { # Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope. # Adds a data source. "dataSource": { # Information about an external data source in the spreadsheet. # The data source to add. "calculatedColumns": [ # All calculated columns in the data source. { # A column in a data source. @@ -3322,7 +3322,7 @@

Method Details

"startIndex": 42, # The start (inclusive) of the span, or not set if unbounded. }, }, - "cancelDataSourceRefresh": { # Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source. # Cancels refreshes of one or multiple data sources and associated dbobjects. + "cancelDataSourceRefresh": { # Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. # Cancels refreshes of one or multiple data sources and associated dbobjects. "dataSourceId": "A String", # Reference to a DataSource. If specified, cancels all associated data source object refreshes for this data source. "isAll": True or False, # Cancels all existing data source object refreshes for all data sources in the spreadsheet. "references": { # A list of references to data source objects. # References to data source objects whose refreshes are to be cancelled. @@ -3587,7 +3587,7 @@

Method Details

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded. }, }, - "refreshDataSource": { # Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly. # Refreshes one or multiple data sources and associated dbobjects. + "refreshDataSource": { # Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly. # Refreshes one or multiple data sources and associated dbobjects. "dataSourceId": "A String", # Reference to a DataSource. If specified, refreshes all associated data source objects for the data source. "force": True or False, # Refreshes the data source objects regardless of the current state. If not set and a referenced data source object was in error state, the refresh will fail immediately. "isAll": True or False, # Refreshes all existing data source objects in the spreadsheet. @@ -7426,7 +7426,7 @@

Method Details

}, "sheetId": 42, # The sheet of the rule to move. Required if new_index is set, unused otherwise. }, - "updateDataSource": { # Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source. # Updates a data source. + "updateDataSource": { # Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope. # Updates a data source. "dataSource": { # Information about an external data source in the spreadsheet. # The data source to update. "calculatedColumns": [ # All calculated columns in the data source. { # A column in a data source. diff --git a/docs/dyn/spanner_v1.projects.instanceConfigOperations.html b/docs/dyn/spanner_v1.projects.instanceConfigOperations.html index 5c1d002828c..e8517aafc5a 100644 --- a/docs/dyn/spanner_v1.projects.instanceConfigOperations.html +++ b/docs/dyn/spanner_v1.projects.instanceConfigOperations.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.

+

Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.

list_next()

Retrieves the next page of results.

@@ -91,11 +91,11 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.
+  
Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.
 
 Args:
-  parent: string, Required. The project of the instance configuration operations. Values are of the form `projects/`. (required)
-  filter: string, An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance configuration name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
+  parent: string, Required. The project of the instance config operations. Values are of the form `projects/`. (required)
+  filter: string, An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
   pageSize: integer, Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
   pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigOperationsResponse to the same `parent` and with the same `filter`.
   x__xgafv: string, V1 error format.
@@ -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 config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. { # 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..f1fbb4a4df8 100644 --- a/docs/dyn/spanner_v1.projects.instanceConfigs.html +++ b/docs/dyn/spanner_v1.projects.instanceConfigs.html @@ -89,22 +89,22 @@

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 config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.

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 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.

get(name, x__xgafv=None)

Gets information about a particular instance configuration.

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

-

Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.

+

Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.

list_next()

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 config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.

Method Details

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

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 config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.
 
 Args:
   parent: string, Required. The name of the project in which to create the instance config. Values are of the form `projects/`. (required)
@@ -121,11 +121,11 @@ 

Method Details

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. - "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. + "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 config is a Google 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. + "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config. "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", @@ -133,8 +133,8 @@

Method Details

"leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], - "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. - "optionalReplicas": [ # Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. + "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. { "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". @@ -142,18 +142,18 @@

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. - "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`. + "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. + "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". "type": "A String", # The type of replica. }, ], - "state": "A String", # Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. + "state": "A String", # Output only. The current instance config state. Applicable only for USER_MANAGED configs. "storageLimitPerProcessingUnit": "A String", # Output only. The storage limit in bytes per processing unit. }, - "instanceConfigId": "A String", # Required. The ID of the instance configuration to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google-managed configurations. + "instanceConfigId": "A String", # Required. The ID of the instance config to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google managed configurations. "validateOnly": True or False, # An option to validate, but not actually execute, a request, and provide the same response. } @@ -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 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.
 
 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 config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.
   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
@@ -221,10 +221,10 @@ 

Method Details

An object of the form: { # 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. + "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 config is a Google 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. + "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config. "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", @@ -232,8 +232,8 @@

Method Details

"leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], - "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. - "optionalReplicas": [ # Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. + "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. { "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". @@ -241,22 +241,22 @@

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. - "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`. + "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. + "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". "type": "A String", # The type of replica. }, ], - "state": "A String", # Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. + "state": "A String", # Output only. The current instance config state. Applicable only for USER_MANAGED configs. "storageLimitPerProcessingUnit": "A String", # Output only. The storage limit in bytes per processing unit. }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.
+  
Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.
 
 Args:
   parent: string, Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`. (required)
@@ -273,10 +273,10 @@ 

Method Details

{ # The response for ListInstanceConfigs. "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. + "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 config is a Google 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. + "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config. "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", @@ -284,8 +284,8 @@

Method Details

"leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], - "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. - "optionalReplicas": [ # Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. + "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. { "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". @@ -293,15 +293,15 @@

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. - "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`. + "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. + "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". "type": "A String", # The type of replica. }, ], - "state": "A String", # Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. + "state": "A String", # Output only. The current instance config state. Applicable only for USER_MANAGED configs. "storageLimitPerProcessingUnit": "A String", # Output only. The storage limit in bytes per processing unit. }, ], @@ -325,19 +325,19 @@

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 config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.
 
 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)
+  name: string, A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # 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.
+  "instanceConfig": { # A possible configuration for a Cloud Spanner instance. Configurations define the geographic placement of nodes and their replication. # Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used.
+    "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 config is a Google 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.
+    "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
     "freeInstanceAvailability": "A String", # Output only. Describes whether free instances are available to be created in this instance config.
     "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",
@@ -345,8 +345,8 @@ 

Method Details

"leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], - "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. - "optionalReplicas": [ # Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. + "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. { "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". @@ -354,15 +354,15 @@

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. - "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`. + "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. + "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". "type": "A String", # The type of replica. }, ], - "state": "A String", # Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. + "state": "A String", # Output only. The current instance config state. Applicable only for USER_MANAGED configs. "storageLimitPerProcessingUnit": "A String", # Output only. The storage limit in bytes per processing unit. }, "updateMask": "A String", # Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated. diff --git a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html deleted file mode 100644 index 076f6e0e5af..00000000000 --- a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html +++ /dev/null @@ -1,226 +0,0 @@ - - - -

Cloud Spanner API . projects . instances . databases . backupSchedules

-

Instance Methods

-

- close()

-

Close httplib2 connections.

-

- getIamPolicy(resource, body=None, x__xgafv=None)

-

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.

-

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

-

Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.

-

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

-

Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.

-

Method Details

-
- close() -
Close httplib2 connections.
-
- -
- getIamPolicy(resource, body=None, x__xgafv=None) -
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.
-
-Args:
-  resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for `GetIamPolicy` method.
-  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
-    "requestedPolicyVersion": 42, # 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/).
-  "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 a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.
-
-Args:
-  resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. (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.
-    "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).
-  },
-}
-
-  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/).
-  "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 the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
-
-Args:
-  resource: string, REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Request message for `TestIamPermissions` method.
-  "permissions": [ # REQUIRED: The set of permissions to check for 'resource'. Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.
-    "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/spanner_v1.projects.instances.databases.html b/docs/dyn/spanner_v1.projects.instances.databases.html index e7f8a6c4b3e..df83bdeb249 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.html @@ -74,11 +74,6 @@

Cloud Spanner API . projects . instances . databases

Instance Methods

-

- backupSchedules() -

-

Returns the backupSchedules Resource.

-

databaseRoles()

@@ -102,7 +97,7 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

+

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

dropDatabase(database, x__xgafv=None)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

@@ -197,7 +192,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.
+  
Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.
 
 Args:
   parent: string, Required. The name of the instance that will serve the new database. Values are of the form `projects//instances/`. (required)
@@ -216,7 +211,7 @@ 

Method Details

"extraStatements": [ # Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created. "A String", ], - "protoDescriptors": "A String", # Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). + "protoDescriptors": "A String", # Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). } x__xgafv: string, V1 error format. @@ -803,7 +798,7 @@

Method Details

"encryptionConfig": { # Encryption configuration for the restored database. # Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. "encryptionType": "A String", # Required. The encryption type of the restored database. "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. - "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configurations, specify a single regional location KMS key. * For multi-regional database instance configurations of type `GOOGLE_MANAGED`, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For a database instance configuration of type `USER_MANAGED`, please specify only regional location KMS keys to cover each region in the instance configuration. Multi-regional location KMS keys are not supported for USER_MANAGED instance configurations. + "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. "A String", ], }, diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html index b372d120764..e77c1e56289 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html @@ -1186,7 +1186,7 @@

Method Details

"maxPartitions": "A String", # **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request. "partitionSizeBytes": "A String", # **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request. }, - "sql": "A String", # Required. The query request to generate partitions for. The request fails if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a PartitionedDml transaction for large, partition-friendly DML operations. + "sql": "A String", # Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. "transaction": { # This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions. # Read only snapshot transactions are supported, read/write and single use transactions are not. "begin": { # Transactions: Each session can have at most one active transaction at a time (note that standalone reads and queries use a transaction internally and do count towards the one transaction limit). After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. Transaction modes: Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. Snapshot read-only transactions provide guaranteed consistency across several reads, but do not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past, or configured to perform a strong read (where Spanner will select a timestamp such that the read is guaranteed to see the effects of all transactions that have committed before the start of the read). Snapshot read-only transactions do not need to be committed. Queries on change streams must be performed with the snapshot read-only transaction mode, specifying a strong read. See TransactionOptions.ReadOnly.strong for more details. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read-write data in a single database. They may, however, read-write data in different tables within that database. Locking read-write transactions: Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. Semantics: Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. Retrying aborted transactions: When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Note that the lock priority is preserved per session (not per transaction). Lock priority is set by the first read or write in the first attempt of a read-write transaction. If the application starts a new session to retry the whole transaction, the transaction loses its original lock priority. Moreover, the lock priority is only preserved if the transaction fails with an `ABORTED` error. Under some circumstances (for example, many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of time spent retrying. Idle transactions: A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. If an idle transaction is aborted, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (for example, `SELECT 1`) prevents the transaction from becoming idle. Snapshot read-only transactions: Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transactions, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. Strong: Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. Queries on change streams (see below for more details) must also specify the strong read timestamp bound. See TransactionOptions.ReadOnly.strong. Exact staleness: These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp less than or equal to the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. Bounded staleness: Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. Old read timestamps and garbage collection: Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. You can configure and extend the `VERSION_RETENTION_PERIOD` of a database up to a period as long as one week, which allows Cloud Spanner to perform reads up to one week in the past. Querying change Streams: A Change Stream is a schema object that can be configured to watch data changes on the entire database, a set of tables, or a set of columns in a database. When a change stream is created, Spanner automatically defines a corresponding SQL Table-Valued Function (TVF) that can be used to query the change records in the associated change stream using the ExecuteStreamingSql API. The name of the TVF for a change stream is generated from the name of the change stream: READ_. All queries on change stream TVFs must be executed using the ExecuteStreamingSql API with a single-use read-only transaction with a strong read-only timestamp_bound. The change stream TVF allows users to specify the start_timestamp and end_timestamp for the time range of interest. All change records within the retention period is accessible using the strong read-only timestamp_bound. All other TransactionOptions are invalid for change stream queries. In addition, if TransactionOptions.read_only.return_read_timestamp is set to true, a special value of 2^63 - 2 will be returned in the Transaction message that describes the transaction, instead of a valid read timestamp. This special value should be discarded and not used for any subsequent queries. Please see https://cloud.google.com/spanner/docs/change-streams for more details on how to query the change stream TVFs. Partitioned DML transactions: Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement is applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table. # Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in ResultSetMetadata.transaction, which is a Transaction. "excludeTxnFromChangeStreams": True or False, # When `exclude_txn_from_change_streams` is set to `true`: * Modifications from this transaction will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from this transaction will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from this transaction will be recorded in all change streams that are tracking columns modified by these transactions. `exclude_txn_from_change_streams` may only be specified for read-write or partitioned-dml transactions, otherwise the API will return an `INVALID_ARGUMENT` error. diff --git a/docs/dyn/spanner_v1.projects.instances.html b/docs/dyn/spanner_v1.projects.instances.html index baf6f2c1def..25f61acaa6a 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 the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).

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.

@@ -159,7 +159,7 @@

Method Details

{ # The request for CreateInstance. "instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to create. The name may be omitted, but if specified must be `/instances/`. - "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -187,8 +187,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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "processingUnits": 42, # The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. "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. }, @@ -258,7 +258,7 @@

Method Details

An object of the form: { # An isolated set of Cloud Spanner resources on which databases can be hosted. - "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -286,8 +286,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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "processingUnits": 42, # The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. "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. }
@@ -357,7 +357,7 @@

Method Details

{ # The response for ListInstances. "instances": [ # The list of requested instances. { # An isolated set of Cloud Spanner resources on which databases can be hosted. - "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -385,8 +385,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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "processingUnits": 42, # The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. "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 +414,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 the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).
 
 Args:
   name: string, Required. The instance to move. Values are of the form `projects//instances/`. (required)
@@ -422,7 +422,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 config for the instance to move. Values are of the form `projects//instanceConfigs/`. } x__xgafv: string, V1 error format. @@ -466,7 +466,7 @@

Method Details

{ # The request for UpdateInstance. "fieldMask": "A String", # Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them. "instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included. - "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -494,8 +494,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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "processingUnits": 42, # The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. "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/spanner_v1.projects.instances.instancePartitions.html b/docs/dyn/spanner_v1.projects.instances.instancePartitions.html index 5cb44455949..43ba05f6d0a 100644 --- a/docs/dyn/spanner_v1.projects.instances.instancePartitions.html +++ b/docs/dyn/spanner_v1.projects.instances.instancePartitions.html @@ -122,8 +122,8 @@

Method Details

"displayName": "A String", # Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. "etag": "A String", # Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly. "name": "A String", # Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. - "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. - "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. + "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. "referencingBackups": [ # Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. "A String", ], @@ -204,8 +204,8 @@

Method Details

"displayName": "A String", # Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. "etag": "A String", # Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly. "name": "A String", # Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. - "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. - "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. + "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. "referencingBackups": [ # Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. "A String", ], @@ -242,8 +242,8 @@

Method Details

"displayName": "A String", # Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. "etag": "A String", # Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly. "name": "A String", # Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. - "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. - "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. + "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. "referencingBackups": [ # Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. "A String", ], @@ -292,8 +292,8 @@

Method Details

"displayName": "A String", # Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. "etag": "A String", # Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly. "name": "A String", # Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. - "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. - "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. + "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. "referencingBackups": [ # Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. "A String", ], diff --git a/docs/dyn/sqladmin_v1.connect.html b/docs/dyn/sqladmin_v1.connect.html index 8f31c2a469d..8389132b0d2 100644 --- a/docs/dyn/sqladmin_v1.connect.html +++ b/docs/dyn/sqladmin_v1.connect.html @@ -170,7 +170,6 @@

Method Details

"selfLink": "A String", # The URI of this resource. "sha1Fingerprint": "A String", # Sha1 Fingerprint. }, - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. }
diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index c1d5691082f..87a30d36af2 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -79,7 +79,7 @@

Instance Methods

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

addServerCa(project, instance, x__xgafv=None)

-

Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.

+

Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.

clone(project, instance, body=None, x__xgafv=None)

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

@@ -142,7 +142,7 @@

Instance Methods

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

rotateServerCa(project, instance, body=None, x__xgafv=None)

-

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.

+

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

startReplica(project, instance, x__xgafv=None)

Starts the replication in the read replica instance.

@@ -193,7 +193,7 @@

Method Details

addServerCa(project, instance, x__xgafv=None) -
Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.
+  
Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -1443,7 +1443,6 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1490,7 +1489,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -1886,7 +1884,6 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1933,7 +1930,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2287,7 +2283,6 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2334,7 +2329,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2614,7 +2608,6 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2661,7 +2654,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -3502,7 +3494,7 @@

Method Details

rotateServerCa(project, instance, body=None, x__xgafv=None) -
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.
+  
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -4390,7 +4382,6 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -4437,7 +4428,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. diff --git a/docs/dyn/sqladmin_v1beta4.connect.html b/docs/dyn/sqladmin_v1beta4.connect.html index c56b9f5ea14..02ff6136d38 100644 --- a/docs/dyn/sqladmin_v1beta4.connect.html +++ b/docs/dyn/sqladmin_v1beta4.connect.html @@ -170,7 +170,6 @@

Method Details

"selfLink": "A String", # The URI of this resource. "sha1Fingerprint": "A String", # Sha1 Fingerprint. }, - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. }
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index 0abf5d5b90c..7ade086e208 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -79,7 +79,7 @@

Instance Methods

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

addServerCa(project, instance, x__xgafv=None)

-

Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.

+

Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.

clone(project, instance, body=None, x__xgafv=None)

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

@@ -142,7 +142,7 @@

Instance Methods

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

rotateServerCa(project, instance, body=None, x__xgafv=None)

-

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.

+

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

startReplica(project, instance, x__xgafv=None)

Starts the replication in the read replica instance.

@@ -193,7 +193,7 @@

Method Details

addServerCa(project, instance, x__xgafv=None) -
Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.
+  
Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -1443,7 +1443,6 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1490,7 +1489,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -1886,7 +1884,6 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1933,7 +1930,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2287,7 +2283,6 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2334,7 +2329,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2614,7 +2608,6 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2661,7 +2654,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -3502,7 +3494,7 @@

Method Details

rotateServerCa(project, instance, body=None, x__xgafv=None) -
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.
+  
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -4390,7 +4382,6 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. - "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -4437,7 +4428,6 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], - "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. diff --git a/docs/dyn/sts_v1.v1.html b/docs/dyn/sts_v1.v1.html index 49ee357a4c3..e03c788bc2b 100644 --- a/docs/dyn/sts_v1.v1.html +++ b/docs/dyn/sts_v1.v1.html @@ -113,7 +113,6 @@

Method Details

An object of the form: { # Response message for ExchangeToken. - "access_boundary_session_key": "A String", # The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`. "access_token": "A String", # An OAuth 2.0 security token, issued by Google, in response to the token exchange request. Tokens can vary in size, depending in part on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time. "expires_in": 42, # The amount of time, in seconds, between the time when the access token was issued and the time when the access token will expire. This field is absent when the `subject_token` in the request is a Google-issued, short-lived access token. In this case, the access token has the same expiration time as the `subject_token`. "issued_token_type": "A String", # The token type. Always matches the value of `requested_token_type` from the request. 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 90252c842f7..251fec45225 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html @@ -204,7 +204,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -345,7 +345,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -462,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. 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 b81a6797723..e74babd2590 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -204,7 +204,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -455,7 +455,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -682,7 +682,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index ee89aec584b..6853eb5a93c 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -238,7 +238,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -292,7 +292,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -496,7 +496,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -593,7 +593,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -993,7 +993,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -1047,7 +1047,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1251,7 +1251,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1348,7 +1348,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1648,7 +1648,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -1702,7 +1702,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1906,7 +1906,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2003,7 +2003,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2307,7 +2307,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -2361,7 +2361,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2565,7 +2565,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2662,7 +2662,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. 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 7ab21ae760c..c553b89e89a 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html @@ -205,7 +205,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -257,7 +257,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -336,7 +336,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -453,7 +453,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -505,7 +505,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -584,7 +584,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -677,7 +677,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -729,7 +729,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -808,7 +808,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. 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 e85ec57d634..a25631f6e0b 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -205,7 +205,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -257,7 +257,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -449,7 +449,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -566,7 +566,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -618,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -810,7 +810,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -903,7 +903,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -955,7 +955,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1147,7 +1147,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index 753aa2c294b..5a29e3f3386 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -239,7 +239,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -294,7 +294,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -346,7 +346,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -554,7 +554,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -606,7 +606,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -685,7 +685,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -758,7 +758,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -810,7 +810,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1002,7 +1002,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1060,7 +1060,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1321,7 +1321,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -1376,7 +1376,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1428,7 +1428,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1636,7 +1636,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1688,7 +1688,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1767,7 +1767,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1840,7 +1840,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1892,7 +1892,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2084,7 +2084,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2142,7 +2142,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2303,7 +2303,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -2358,7 +2358,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2410,7 +2410,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2618,7 +2618,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2670,7 +2670,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2749,7 +2749,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2822,7 +2822,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2874,7 +2874,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3066,7 +3066,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3124,7 +3124,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3289,7 +3289,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -3344,7 +3344,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3396,7 +3396,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3604,7 +3604,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3656,7 +3656,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3735,7 +3735,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3808,7 +3808,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3860,7 +3860,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -4052,7 +4052,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -4110,7 +4110,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. - "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + "subnetwork": "A String", # The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html index 39b9434e4ee..8c77eba924f 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html @@ -135,8 +135,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -144,13 +144,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -261,8 +261,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -270,13 +270,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -327,8 +327,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -336,13 +336,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -396,8 +396,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -405,13 +405,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index 61da7cce064..8b80260dd8f 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -131,12 +131,6 @@

Method Details

The object takes the form of: { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. - "first": 42, # Required. Starting port number for the current range of ports. - "last": 42, # Required. Ending port number for the current range of ports. - }, - ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, @@ -338,12 +332,6 @@

Method Details

An object of the form: { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. - "first": 42, # Required. Starting port number for the current range of ports. - "last": 42, # Required. Ending port number for the current range of ports. - }, - ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, @@ -533,12 +521,6 @@

Method Details

], "workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. - "first": 42, # Required. Starting port number for the current range of ports. - "last": 42, # Required. Ending port number for the current range of ports. - }, - ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, @@ -682,12 +664,6 @@

Method Details

], "workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. - "first": 42, # Required. Starting port number for the current range of ports. - "last": 42, # Required. Ending port number for the current range of ports. - }, - ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, @@ -846,12 +822,6 @@

Method Details

The object takes the form of: { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. - "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. - "first": 42, # Required. Starting port number for the current range of ports. - "last": 42, # Required. Ending port number for the current range of ports. - }, - ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html index aaecfbe4439..b3805f1a36f 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html @@ -135,8 +135,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -144,17 +144,15 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. @@ -263,8 +261,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -272,17 +270,15 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. @@ -331,8 +327,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -340,17 +336,15 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. @@ -402,8 +396,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. + "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Whether Workstations endpoint is private. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -411,17 +405,15 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. - "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. + "privateClusterConfig": { # Optional. Configuration for private workstation cluster. + "allowedProjects": [ "A String", ], - "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. - "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. - "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). + "clusterHostname": "A String", + "enablePrivateEndpoint": True or False, + "serviceAttachmentUri": "A String", }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index 4039768cf8d..5dba36444b3 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -132,7 +132,7 @@

Method Details

{ # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -268,8 +268,6 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. } @@ -359,7 +357,7 @@

Method Details

{ # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -495,8 +493,6 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }
@@ -574,7 +570,7 @@

Method Details

"workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -710,8 +706,6 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }, @@ -743,7 +737,7 @@

Method Details

"workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -879,8 +873,6 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }, @@ -927,7 +919,7 @@

Method Details

{ # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -1063,8 +1055,6 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. } diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html index 226d08d664a..5769e5036d9 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -152,8 +152,6 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. @@ -290,8 +288,6 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. @@ -388,8 +384,6 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. @@ -440,8 +434,6 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. @@ -507,8 +499,6 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. - "satisfiesPzi": True or False, # Output only. Reserved for future use. - "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. diff --git a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json index 9960cffb3a4..fa48f72fea6 100644 --- a/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json +++ b/googleapiclient/discovery_cache/documents/acceleratedmobilepageurl.v1.json @@ -115,7 +115,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", "schemas": { "AmpUrl": { diff --git a/googleapiclient/discovery_cache/documents/accessapproval.v1.json b/googleapiclient/discovery_cache/documents/accessapproval.v1.json index bdf5d008f8f..0e2ab5e6770 100644 --- a/googleapiclient/discovery_cache/documents/accessapproval.v1.json +++ b/googleapiclient/discovery_cache/documents/accessapproval.v1.json @@ -913,7 +913,7 @@ } } }, -"revision": "20240712", +"revision": "20240705", "rootUrl": "https://accessapproval.googleapis.com/", "schemas": { "AccessApprovalServiceAccount": { diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 9c72c3a8fc6..8a974b5ed6b 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1290,7 +1290,7 @@ } } }, -"revision": "20240708", +"revision": "20240623", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1332,7 +1332,6 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", -"readOnly": true, "type": "string" }, "name": { @@ -1742,7 +1741,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "EgressSource" }, @@ -1771,7 +1770,7 @@ "id": "EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -2549,7 +2548,7 @@ "properties": { "vpcSubnetwork": { "$ref": "VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/acmedns.v1.json b/googleapiclient/discovery_cache/documents/acmedns.v1.json index 535ecbea925..4fa5bf8f829 100644 --- a/googleapiclient/discovery_cache/documents/acmedns.v1.json +++ b/googleapiclient/discovery_cache/documents/acmedns.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://acmedns.googleapis.com/", "schemas": { "AcmeChallengeSet": { diff --git a/googleapiclient/discovery_cache/documents/addressvalidation.v1.json b/googleapiclient/discovery_cache/documents/addressvalidation.v1.json index 376c58700fb..a49bcb5c32b 100644 --- a/googleapiclient/discovery_cache/documents/addressvalidation.v1.json +++ b/googleapiclient/discovery_cache/documents/addressvalidation.v1.json @@ -151,7 +151,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://addressvalidation.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { diff --git a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json index 41c6a5d19f9..a9e53dd8760 100644 --- a/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/adexchangebuyer2.v2beta1.json @@ -3115,7 +3115,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://adexchangebuyer.googleapis.com/", "schemas": { "AbsoluteDateRange": { diff --git a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json index c9f315bdef1..6b5692623f8 100644 --- a/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.datatransfer_v1.json @@ -272,7 +272,7 @@ } } }, -"revision": "20240709", +"revision": "20240618", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index b4dad8e4008..58ee6d6a441 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -3931,7 +3931,7 @@ ] }, "insert": { -"description": "Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.", +"description": "Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case.", "flatPath": "admin/directory/v1/users", "httpMethod": "POST", "id": "directory.users.insert", @@ -4671,7 +4671,7 @@ } } }, -"revision": "20240709", +"revision": "20240618", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json index 922064a1895..d19fec1ccc7 100644 --- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json @@ -626,7 +626,7 @@ } } }, -"revision": "20240709", +"revision": "20240618", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1.json b/googleapiclient/discovery_cache/documents/admob.v1.json index 5d2bd9f1da9..1c72a76f446 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1.json +++ b/googleapiclient/discovery_cache/documents/admob.v1.json @@ -321,7 +321,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdUnit": { diff --git a/googleapiclient/discovery_cache/documents/admob.v1beta.json b/googleapiclient/discovery_cache/documents/admob.v1beta.json index cfe2a883ab3..83426ae473d 100644 --- a/googleapiclient/discovery_cache/documents/admob.v1beta.json +++ b/googleapiclient/discovery_cache/documents/admob.v1beta.json @@ -758,7 +758,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdSource": { diff --git a/googleapiclient/discovery_cache/documents/adsense.v2.json b/googleapiclient/discovery_cache/documents/adsense.v2.json index 141b3a4f67b..08d6597bed7 100644 --- a/googleapiclient/discovery_cache/documents/adsense.v2.json +++ b/googleapiclient/discovery_cache/documents/adsense.v2.json @@ -1912,7 +1912,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://adsense.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json b/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json deleted file mode 100644 index 189e2f3bae2..00000000000 --- a/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json +++ /dev/null @@ -1,721 +0,0 @@ -{ -"auth": { -"oauth2": { -"scopes": { -"https://www.googleapis.com/auth/adsense": { -"description": "View and manage your AdSense data" -}, -"https://www.googleapis.com/auth/adsense.readonly": { -"description": "View your AdSense data" -} -} -} -}, -"basePath": "", -"baseUrl": "https://adsenseplatform.googleapis.com/", -"batchPath": "batch", -"canonicalName": "AdSense Platform", -"description": "", -"discoveryVersion": "v1", -"documentationLink": "https://developers.google.com/adsense/platforms/", -"fullyEncodeReservedExpansion": true, -"icons": { -"x16": "http://www.google.com/images/icons/product/search-16.gif", -"x32": "http://www.google.com/images/icons/product/search-32.gif" -}, -"id": "adsenseplatform:v1alpha", -"kind": "discovery#restDescription", -"mtlsRootUrl": "https://adsenseplatform.mtls.googleapis.com/", -"name": "adsenseplatform", -"ownerDomain": "google.com", -"ownerName": "Google", -"parameters": { -"$.xgafv": { -"description": "V1 error format.", -"enum": [ -"1", -"2" -], -"enumDescriptions": [ -"v1 error format", -"v2 error format" -], -"location": "query", -"type": "string" -}, -"access_token": { -"description": "OAuth access token.", -"location": "query", -"type": "string" -}, -"alt": { -"default": "json", -"description": "Data format for response.", -"enum": [ -"json", -"media", -"proto" -], -"enumDescriptions": [ -"Responses with Content-Type of application/json", -"Media download with context-dependent Content-Type", -"Responses with Content-Type of application/x-protobuf" -], -"location": "query", -"type": "string" -}, -"callback": { -"description": "JSONP", -"location": "query", -"type": "string" -}, -"fields": { -"description": "Selector specifying which fields to include in a partial response.", -"location": "query", -"type": "string" -}, -"key": { -"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", -"location": "query", -"type": "string" -}, -"oauth_token": { -"description": "OAuth 2.0 token for the current user.", -"location": "query", -"type": "string" -}, -"prettyPrint": { -"default": "true", -"description": "Returns response with indentations and line breaks.", -"location": "query", -"type": "boolean" -}, -"quotaUser": { -"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", -"location": "query", -"type": "string" -}, -"uploadType": { -"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", -"location": "query", -"type": "string" -}, -"upload_protocol": { -"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", -"location": "query", -"type": "string" -} -}, -"protocol": "rest", -"resources": { -"platforms": { -"resources": { -"accounts": { -"methods": { -"close": { -"description": "Closes a sub-account.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}:close", -"httpMethod": "POST", -"id": "adsenseplatform.platforms.accounts.close", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Account to close. Format: platforms/{platform}/accounts/{account_id}", -"location": "path", -"pattern": "^platforms/[^/]+/accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+name}:close", -"request": { -"$ref": "CloseAccountRequest" -}, -"response": { -"$ref": "CloseAccountResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense" -] -}, -"create": { -"description": "Creates a sub-account.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts", -"httpMethod": "POST", -"id": "adsenseplatform.platforms.accounts.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. Platform to create an account for. Format: platforms/{platform}", -"location": "path", -"pattern": "^platforms/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/accounts", -"request": { -"$ref": "Account" -}, -"response": { -"$ref": "Account" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense" -] -}, -"get": { -"description": "Gets information about the selected sub-account.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}", -"httpMethod": "GET", -"id": "adsenseplatform.platforms.accounts.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id}", -"location": "path", -"pattern": "^platforms/[^/]+/accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+name}", -"response": { -"$ref": "Account" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense", -"https://www.googleapis.com/auth/adsense.readonly" -] -}, -"list": { -"description": "Lists a partial view of sub-accounts for a specific parent account.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts", -"httpMethod": "GET", -"id": "adsenseplatform.platforms.accounts.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Platform who parents the accounts. Format: platforms/{platform}", -"location": "path", -"pattern": "^platforms/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/accounts", -"response": { -"$ref": "ListAccountsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense", -"https://www.googleapis.com/auth/adsense.readonly" -] -}, -"lookup": { -"description": "Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts:lookup", -"httpMethod": "GET", -"id": "adsenseplatform.platforms.accounts.lookup", -"parameterOrder": [ -"parent" -], -"parameters": { -"creationRequestId": { -"description": "Optional. The creation_request_id provided when calling createAccount.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. Platform who parents the account. Format: platforms/{platform}", -"location": "path", -"pattern": "^platforms/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/accounts:lookup", -"response": { -"$ref": "LookupAccountResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense", -"https://www.googleapis.com/auth/adsense.readonly" -] -} -}, -"resources": { -"events": { -"methods": { -"create": { -"description": "Creates an account event.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/events", -"httpMethod": "POST", -"id": "adsenseplatform.platforms.accounts.events.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. Account to log events about. Format: platforms/{platform}/accounts/{account}", -"location": "path", -"pattern": "^platforms/[^/]+/accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/events", -"request": { -"$ref": "Event" -}, -"response": { -"$ref": "Event" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense" -] -} -} -}, -"sites": { -"methods": { -"create": { -"description": "Creates a site for a specified account.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites", -"httpMethod": "POST", -"id": "adsenseplatform.platforms.accounts.sites.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. Account to create site. Format: platforms/{platform}/accounts/{account_id}", -"location": "path", -"pattern": "^platforms/[^/]+/accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/sites", -"request": { -"$ref": "Site" -}, -"response": { -"$ref": "Site" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense" -] -}, -"delete": { -"description": "Deletes a site from a specified account.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", -"httpMethod": "DELETE", -"id": "adsenseplatform.platforms.accounts.sites.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site}", -"location": "path", -"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+name}", -"response": { -"$ref": "Empty" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense" -] -}, -"get": { -"description": "Gets a site from a specified sub-account.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", -"httpMethod": "GET", -"id": "adsenseplatform.platforms.accounts.sites.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site}", -"location": "path", -"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+name}", -"response": { -"$ref": "Site" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense", -"https://www.googleapis.com/auth/adsense.readonly" -] -}, -"list": { -"description": "Lists sites for a specific account.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites", -"httpMethod": "GET", -"id": "adsenseplatform.platforms.accounts.sites.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account}", -"location": "path", -"pattern": "^platforms/[^/]+/accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/sites", -"response": { -"$ref": "ListSitesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense", -"https://www.googleapis.com/auth/adsense.readonly" -] -}, -"requestReview": { -"description": "Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.", -"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}:requestReview", -"httpMethod": "POST", -"id": "adsenseplatform.platforms.accounts.sites.requestReview", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site}", -"location": "path", -"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+name}:requestReview", -"response": { -"$ref": "RequestSiteReviewResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/adsense" -] -} -} -} -} -} -} -} -}, -"revision": "20240715", -"rootUrl": "https://adsenseplatform.googleapis.com/", -"schemas": { -"Account": { -"description": "Representation of an Account.", -"id": "Account", -"properties": { -"createTime": { -"description": "Output only. Creation time of the account.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"creationRequestId": { -"description": "Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.", -"type": "string" -}, -"displayName": { -"description": "Display name of this account.", -"type": "string" -}, -"name": { -"description": "Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+", -"readOnly": true, -"type": "string" -}, -"regionCode": { -"description": "Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.", -"type": "string" -}, -"state": { -"description": "Output only. Approval state of the account.", -"enum": [ -"STATE_UNSPECIFIED", -"UNCHECKED", -"APPROVED", -"DISAPPROVED" -], -"enumDescriptions": [ -"Unspecified.", -"Unchecked.", -"The account is ready to serve ads.", -"The account has been blocked from serving ads." -], -"readOnly": true, -"type": "string" -}, -"timeZone": { -"$ref": "TimeZone", -"description": "Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts." -} -}, -"type": "object" -}, -"Address": { -"description": "Address data.", -"id": "Address", -"properties": { -"address1": { -"description": "First line of address. Max length 64 bytes or 30 characters.", -"type": "string" -}, -"address2": { -"description": "Second line of address. Max length 64 bytes or 30 characters.", -"type": "string" -}, -"city": { -"description": "City. Max length 60 bytes or 30 characters.", -"type": "string" -}, -"company": { -"description": "Name of the company. Max length 255 bytes or 34 characters.", -"type": "string" -}, -"contact": { -"description": "Contact name of the company. Max length 128 bytes or 34 characters.", -"type": "string" -}, -"fax": { -"description": "Fax number with international code (i.e. +441234567890).", -"type": "string" -}, -"phone": { -"description": "Phone number with international code (i.e. +441234567890).", -"type": "string" -}, -"regionCode": { -"description": "Country/Region code. The region is specified as a CLDR region code (e.g. \"US\", \"FR\").", -"type": "string" -}, -"state": { -"description": "State. Max length 60 bytes or 30 characters.", -"type": "string" -}, -"zip": { -"description": "Zip/post code. Max length 10 bytes or 10 characters.", -"type": "string" -} -}, -"type": "object" -}, -"CloseAccountRequest": { -"description": "Request definition for the account close rpc.", -"id": "CloseAccountRequest", -"properties": {}, -"type": "object" -}, -"CloseAccountResponse": { -"description": "Response definition for the account close rpc.", -"id": "CloseAccountResponse", -"properties": {}, -"type": "object" -}, -"Empty": { -"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", -"id": "Empty", -"properties": {}, -"type": "object" -}, -"Event": { -"description": "A platform sub-account event to record spam signals.", -"id": "Event", -"properties": { -"eventInfo": { -"$ref": "EventInfo", -"description": "Required. Information associated with the event." -}, -"eventTime": { -"description": "Required. Event timestamp.", -"format": "google-datetime", -"type": "string" -}, -"eventType": { -"description": "Required. Event type.", -"enum": [ -"EVENT_TYPE_UNSPECIFIED", -"LOG_IN_VIA_PLATFORM", -"SIGN_UP_VIA_PLATFORM" -], -"enumDescriptions": [ -"Do not use. You must set an event type explicitly.", -"Log in via platform.", -"Sign up via platform." -], -"type": "string" -} -}, -"type": "object" -}, -"EventInfo": { -"description": "Private information for partner recorded events (PII).", -"id": "EventInfo", -"properties": { -"billingAddress": { -"$ref": "Address", -"description": "The billing address of the publisher associated with this event, if available." -}, -"email": { -"description": "Required. The email address that is associated with the publisher when performing the event.", -"type": "string" -} -}, -"type": "object" -}, -"ListAccountsResponse": { -"description": "Response definition for the list accounts rpc.", -"id": "ListAccountsResponse", -"properties": { -"accounts": { -"description": "The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.", -"items": { -"$ref": "Account" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", -"type": "string" -} -}, -"type": "object" -}, -"ListSitesResponse": { -"description": "Response definition for the site list rpc.", -"id": "ListSitesResponse", -"properties": { -"nextPageToken": { -"description": "Continuation token used to page through sites. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", -"type": "string" -}, -"sites": { -"description": "The sites returned in this list response.", -"items": { -"$ref": "Site" -}, -"type": "array" -} -}, -"type": "object" -}, -"LookupAccountResponse": { -"description": "Response definition for the lookup account rpc.", -"id": "LookupAccountResponse", -"properties": { -"name": { -"description": "The name of the Account Format: platforms/{platform}/accounts/{account_id}", -"type": "string" -} -}, -"type": "object" -}, -"RequestSiteReviewResponse": { -"description": "Response definition for the site request review rpc.", -"id": "RequestSiteReviewResponse", -"properties": {}, -"type": "object" -}, -"Site": { -"description": "Representation of a Site.", -"id": "Site", -"properties": { -"domain": { -"description": "Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.", -"type": "string" -}, -"name": { -"description": "Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}", -"readOnly": true, -"type": "string" -}, -"state": { -"description": "Output only. State of a site.", -"enum": [ -"STATE_UNSPECIFIED", -"REQUIRES_REVIEW", -"GETTING_READY", -"READY", -"NEEDS_ATTENTION" -], -"enumDescriptions": [ -"State unspecified.", -"Either: - The site hasn't been checked yet. - The site is inactive and needs another review before it can show ads again. Learn how to [request a review for an inactive site](https://support.google.com/adsense/answer/9393996).", -"Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks.", -"The site is ready to show ads. Learn how to [set up ads on the site](https://support.google.com/adsense/answer/7037624).", -"Publisher needs to fix some issues before the site is ready to show ads. Learn what to do [if a new site isn't ready](https://support.google.com/adsense/answer/9061852)." -], -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"TimeZone": { -"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", -"id": "TimeZone", -"properties": { -"id": { -"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", -"type": "string" -}, -"version": { -"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", -"type": "string" -} -}, -"type": "object" -} -}, -"servicePath": "", -"title": "AdSense Platform API", -"version": "v1alpha", -"version_module": true -} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index bd5a74b1133..a597576b035 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -11179,167 +11179,6 @@ } }, "notebookExecutionJobs": { -"methods": { -"create": { -"description": "Creates a NotebookExecutionJob.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", -"httpMethod": "POST", -"id": "aiplatform.projects.locations.notebookExecutionJobs.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"notebookExecutionJobId": { -"description": "Optional. User specified ID for the NotebookExecutionJob.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/notebookExecutionJobs", -"request": { -"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a NotebookExecutionJob.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", -"httpMethod": "DELETE", -"id": "aiplatform.projects.locations.notebookExecutionJobs.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the NotebookExecutionJob resource to be deleted.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Gets a NotebookExecutionJob.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.notebookExecutionJobs.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the NotebookExecutionJob resource.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", -"required": true, -"type": "string" -}, -"view": { -"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", -"enum": [ -"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", -"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", -"NOTEBOOK_EXECUTION_JOB_VIEW_FULL" -], -"enumDescriptions": [ -"When unspecified, the API defaults to the BASIC view.", -"Includes all fields except for direct notebook inputs.", -"Includes all fields." -], -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"list": { -"description": "Lists NotebookExecutionJobs in a Location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", -"httpMethod": "GET", -"id": "aiplatform.projects.locations.notebookExecutionJobs.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -}, -"view": { -"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", -"enum": [ -"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", -"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", -"NOTEBOOK_EXECUTION_JOB_VIEW_FULL" -], -"enumDescriptions": [ -"When unspecified, the API defaults to the BASIC view.", -"Includes all fields except for direct notebook inputs.", -"Includes all fields." -], -"location": "query", -"type": "string" -} -}, -"path": "v1/{+parent}/notebookExecutionJobs", -"response": { -"$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -} -}, "resources": { "operations": { "methods": { @@ -16971,7 +16810,7 @@ } } }, -"revision": "20240704", +"revision": "20240703", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -18605,12 +18444,6 @@ }, "readOnly": true, "type": "array" -}, -"score": { -"description": "Output only. Confidence score of the candidate.", -"format": "double", -"readOnly": true, -"type": "number" } }, "type": "object" @@ -18822,21 +18655,21 @@ "id": "GoogleCloudAiplatformV1ComputeTokensRequest", "properties": { "contents": { -"description": "Optional. Input content.", +"description": "Required. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1Content" }, "type": "array" }, "instances": { -"description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", +"description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", +"description": "Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", "type": "string" } }, @@ -19038,33 +18871,22 @@ "id": "GoogleCloudAiplatformV1CountTokensRequest", "properties": { "contents": { -"description": "Optional. Input content.", +"description": "Required. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1Content" }, "type": "array" }, "instances": { -"description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", +"description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", +"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" -}, -"systemInstruction": { -"$ref": "GoogleCloudAiplatformV1Content", -"description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." -}, -"tools": { -"description": "Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.", -"items": { -"$ref": "GoogleCloudAiplatformV1Tool" -}, -"type": "array" } }, "type": "object" @@ -19267,21 +19089,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata": { -"description": "Metadata information for NotebookService.CreateNotebookExecutionJob.", -"id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata", -"properties": { -"genericMetadata": { -"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", -"description": "The operation generic information." -}, -"progressMessage": { -"description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": { "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.", "id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata", @@ -23739,6 +23546,45 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1GroundingAttribution": { +"description": "Grounding attribution.", +"id": "GoogleCloudAiplatformV1GroundingAttribution", +"properties": { +"confidenceScore": { +"description": "Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"segment": { +"$ref": "GoogleCloudAiplatformV1Segment", +"description": "Output only. Segment of the content this attribution belongs to.", +"readOnly": true +}, +"web": { +"$ref": "GoogleCloudAiplatformV1GroundingAttributionWeb", +"description": "Optional. Attribution from the web." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1GroundingAttributionWeb": { +"description": "Attribution from the web.", +"id": "GoogleCloudAiplatformV1GroundingAttributionWeb", +"properties": { +"title": { +"description": "Output only. Title of the attribution.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. URI reference of the attribution.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1GroundingChunk": { "description": "Grounding chunk.", "id": "GoogleCloudAiplatformV1GroundingChunk", @@ -23788,6 +23634,13 @@ "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1GroundingMetadata", "properties": { +"groundingAttributions": { +"description": "Optional. List of grounding attributions.", +"items": { +"$ref": "GoogleCloudAiplatformV1GroundingAttribution" +}, +"type": "array" +}, "groundingChunks": { "description": "List of supporting references retrieved from specified grounding source.", "items": { @@ -25229,24 +25082,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse": { -"description": "Response message for [NotebookService.CreateNotebookExecutionJob]", -"id": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse", -"properties": { -"nextPageToken": { -"description": "A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page.", -"type": "string" -}, -"notebookExecutionJobs": { -"description": "List of NotebookExecutionJobs in the requested page.", -"items": { -"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse": { "description": "Response message for NotebookService.ListNotebookRuntimeTemplates.", "id": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse", @@ -27889,159 +27724,6 @@ false }, "type": "object" }, -"GoogleCloudAiplatformV1NotebookExecutionJob": { -"description": "NotebookExecutionJob represents an instance of a notebook execution.", -"id": "GoogleCloudAiplatformV1NotebookExecutionJob", -"properties": { -"createTime": { -"description": "Output only. Timestamp when this NotebookExecutionJob was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"dataformRepositorySource": { -"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", -"description": "The Dataform Repository pointing to a single file notebook repository." -}, -"directNotebookSource": { -"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", -"description": "The contents of an input notebook file." -}, -"displayName": { -"description": "The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.", -"type": "string" -}, -"executionTimeout": { -"description": "Max running time of the execution job in seconds (default 86400s / 24 hrs).", -"format": "google-duration", -"type": "string" -}, -"executionUser": { -"description": "The user email to run the execution as. Only supported by Colab runtimes.", -"type": "string" -}, -"gcsNotebookSource": { -"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", -"description": "The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`" -}, -"gcsOutputUri": { -"description": "The Cloud Storage location to upload the result to. Format: `gs://bucket-name`", -"type": "string" -}, -"jobState": { -"description": "Output only. The state of the NotebookExecutionJob.", -"enum": [ -"JOB_STATE_UNSPECIFIED", -"JOB_STATE_QUEUED", -"JOB_STATE_PENDING", -"JOB_STATE_RUNNING", -"JOB_STATE_SUCCEEDED", -"JOB_STATE_FAILED", -"JOB_STATE_CANCELLING", -"JOB_STATE_CANCELLED", -"JOB_STATE_PAUSED", -"JOB_STATE_EXPIRED", -"JOB_STATE_UPDATING", -"JOB_STATE_PARTIALLY_SUCCEEDED" -], -"enumDescriptions": [ -"The job state is unspecified.", -"The job has been just created or resumed and processing has not yet begun.", -"The service is preparing to run the job.", -"The job is in progress.", -"The job completed successfully.", -"The job failed.", -"The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", -"The job has been cancelled.", -"The job has been stopped, and can be resumed.", -"The job has expired.", -"The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", -"The job is partially succeeded, some results may be missing due to errors." -], -"readOnly": true, -"type": "string" -}, -"labels": { -"additionalProperties": { -"type": "string" -}, -"description": "The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", -"type": "object" -}, -"name": { -"description": "Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`", -"readOnly": true, -"type": "string" -}, -"notebookRuntimeTemplateResourceName": { -"description": "The NotebookRuntimeTemplate to source compute configuration from.", -"type": "string" -}, -"scheduleResourceName": { -"description": "Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", -"readOnly": true, -"type": "string" -}, -"serviceAccount": { -"description": "The service account to run the execution as.", -"type": "string" -}, -"status": { -"$ref": "GoogleRpcStatus", -"description": "Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.", -"readOnly": true -}, -"updateTime": { -"description": "Output only. Timestamp when this NotebookExecutionJob was most recently updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource": { -"description": "The Dataform Repository containing the input notebook.", -"id": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", -"properties": { -"commitSha": { -"description": "The commit SHA to read repository with. If unset, the file will be read at HEAD.", -"type": "string" -}, -"dataformRepositoryResourceName": { -"description": "The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource": { -"description": "The content of the input notebook in ipynb format.", -"id": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", -"properties": { -"content": { -"description": "The base64-encoded contents of the input notebook file.", -"format": "byte", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource": { -"description": "The Cloud Storage uri for the input notebook.", -"id": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", -"properties": { -"generation": { -"description": "The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.", -"type": "string" -}, -"uri": { -"description": "The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1NotebookIdleShutdownConfig": { "description": "The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.", "id": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig", @@ -30263,17 +29945,6 @@ false }, "type": "object" }, -"GoogleCloudAiplatformV1RayLogsSpec": { -"description": "Configuration for the Ray OSS Logs.", -"id": "GoogleCloudAiplatformV1RayLogsSpec", -"properties": { -"disabled": { -"description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1RayMetricSpec", @@ -30297,10 +29968,6 @@ false "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, -"rayLogsSpec": { -"$ref": "GoogleCloudAiplatformV1RayLogsSpec", -"description": "Optional. OSS Ray logging configurations." -}, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1RayMetricSpec", "description": "Optional. Ray metrics configurations." diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 075339d5f06..2fbc3dbb0ff 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -20447,7 +20447,7 @@ } } }, -"revision": "20240704", +"revision": "20240703", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { @@ -22339,12 +22339,6 @@ }, "readOnly": true, "type": "array" -}, -"score": { -"description": "Output only. Confidence score of the candidate.", -"format": "double", -"readOnly": true, -"type": "number" } }, "type": "object" @@ -22556,21 +22550,21 @@ "id": "GoogleCloudAiplatformV1beta1ComputeTokensRequest", "properties": { "contents": { -"description": "Optional. Input content.", +"description": "Required. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { -"description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", +"description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", +"description": "Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", "type": "string" } }, @@ -22772,33 +22766,22 @@ "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", "properties": { "contents": { -"description": "Optional. Input content.", +"description": "Required. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { -"description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", +"description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", +"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" -}, -"systemInstruction": { -"$ref": "GoogleCloudAiplatformV1beta1Content", -"description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." -}, -"tools": { -"description": "Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1Tool" -}, -"type": "array" } }, "type": "object" @@ -27937,6 +27920,66 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GroundingAttribution": { +"description": "Grounding attribution.", +"id": "GoogleCloudAiplatformV1beta1GroundingAttribution", +"properties": { +"confidenceScore": { +"description": "Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.", +"format": "float", +"readOnly": true, +"type": "number" +}, +"retrievedContext": { +"$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", +"description": "Optional. Attribution from context retrieved by the retrieval tools." +}, +"segment": { +"$ref": "GoogleCloudAiplatformV1beta1Segment", +"description": "Output only. Segment of the content this attribution belongs to.", +"readOnly": true +}, +"web": { +"$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", +"description": "Optional. Attribution from the web." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext": { +"description": "Attribution from context retrieved by the retrieval tools.", +"id": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", +"properties": { +"title": { +"description": "Output only. Title of the attribution.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. URI reference of the attribution.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GroundingAttributionWeb": { +"description": "Attribution from the web.", +"id": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", +"properties": { +"title": { +"description": "Output only. Title of the attribution.", +"readOnly": true, +"type": "string" +}, +"uri": { +"description": "Output only. URI reference of the attribution.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GroundingChunk": { "description": "Grounding chunk.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", @@ -27986,6 +28029,13 @@ "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { +"groundingAttributions": { +"description": "Optional. List of grounding attributions.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1GroundingAttribution" +}, +"type": "array" +}, "groundingChunks": { "description": "List of supporting references retrieved from specified grounding source.", "items": { @@ -35746,17 +35796,6 @@ false }, "type": "object" }, -"GoogleCloudAiplatformV1beta1RayLogsSpec": { -"description": "Configuration for the Ray OSS Logs.", -"id": "GoogleCloudAiplatformV1beta1RayLogsSpec", -"properties": { -"disabled": { -"description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", -"type": "boolean" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1beta1RayMetricSpec", @@ -35780,10 +35819,6 @@ false "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, -"rayLogsSpec": { -"$ref": "GoogleCloudAiplatformV1beta1RayLogsSpec", -"description": "Optional. OSS Ray logging configurations." -}, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1RayMetricSpec", "description": "Optional. Ray metrics configurations." diff --git a/googleapiclient/discovery_cache/documents/airquality.v1.json b/googleapiclient/discovery_cache/documents/airquality.v1.json index 46186a09dfc..a9ce78f8dda 100644 --- a/googleapiclient/discovery_cache/documents/airquality.v1.json +++ b/googleapiclient/discovery_cache/documents/airquality.v1.json @@ -250,7 +250,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://airquality.googleapis.com/", "schemas": { "AdditionalInfo": { diff --git a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json index 4a91dad0ea1..b9a25ca5369 100644 --- a/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/alertcenter.v1beta1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20240708", +"revision": "20240701", "rootUrl": "https://alertcenter.googleapis.com/", "schemas": { "AbuseDetected": { diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 245f8b6be37..6d0d012cdbe 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1489,7 +1489,7 @@ } } }, -"revision": "20240703", +"revision": "20240627", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 737b0921ed2..097329a18a6 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1489,7 +1489,7 @@ } } }, -"revision": "20240703", +"revision": "20240627", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1578,22 +1578,19 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15", -"POSTGRES_16" +"POSTGRES_15" ], "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." +"The database version is Postgres 15." ], "readOnly": true, "type": "string" @@ -1842,22 +1839,19 @@ false "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15", -"POSTGRES_16" +"POSTGRES_15" ], "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." +"The database version is Postgres 15." ], "type": "string" }, @@ -4660,22 +4654,19 @@ false "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15", -"POSTGRES_16" +"POSTGRES_15" ], "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." +"The database version is Postgres 15." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 075b0bfcc0b..0722f1a31ac 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1486,7 +1486,7 @@ } } }, -"revision": "20240703", +"revision": "20240627", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1575,22 +1575,19 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15", -"POSTGRES_16" +"POSTGRES_15" ], "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." +"The database version is Postgres 15." ], "readOnly": true, "type": "string" @@ -1828,22 +1825,19 @@ false "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15", -"POSTGRES_16" +"POSTGRES_15" ], "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." +"The database version is Postgres 15." ], "type": "string" }, @@ -4636,22 +4630,19 @@ false "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15", -"POSTGRES_16" +"POSTGRES_15" ], "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." +"The database version is Postgres 15." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 7718488d17e..93e1b0aae25 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -3103,6 +3103,35 @@ } } }, +"eventEditRules": { +"methods": { +"reorder": { +"description": "Changes the processing order of event edit rules on the specified stream.", +"flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", +"httpMethod": "POST", +"id": "analyticsadmin.properties.dataStreams.eventEditRules.reorder", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Example format: properties/123/dataStreams/456", +"location": "path", +"pattern": "^properties/[^/]+/dataStreams/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/eventEditRules:reorder", +"request": { +"$ref": "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +} +} +} +}, "measurementProtocolSecrets": { "methods": { "create": { @@ -4704,7 +4733,7 @@ } } }, -"revision": "20240712", +"revision": "20240707", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -8297,6 +8326,20 @@ }, "type": "object" }, +"GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest": { +"description": "Request message for ReorderEventEditRules RPC.", +"id": "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest", +"properties": { +"eventEditRules": { +"description": "Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink": { "description": "A link that references a source property under the parent rollup property.", "id": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink", diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json index 566d64262ba..c5994be2a5c 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -1253,6 +1253,35 @@ } }, "resources": { +"eventEditRules": { +"methods": { +"reorder": { +"description": "Changes the processing order of event edit rules on the specified stream.", +"flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", +"httpMethod": "POST", +"id": "analyticsadmin.properties.dataStreams.eventEditRules.reorder", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Example format: properties/123/dataStreams/456", +"location": "path", +"pattern": "^properties/[^/]+/dataStreams/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/eventEditRules:reorder", +"request": { +"$ref": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest" +}, +"response": { +"$ref": "GoogleProtobufEmpty" +} +} +} +}, "measurementProtocolSecrets": { "methods": { "create": { @@ -1788,7 +1817,7 @@ } } }, -"revision": "20240712", +"revision": "20240707", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { @@ -3323,6 +3352,20 @@ }, "type": "object" }, +"GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest": { +"description": "Request message for ReorderEventEditRules RPC.", +"id": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest", +"properties": { +"eventEditRules": { +"description": "Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleAnalyticsAdminV1betaRunAccessReportRequest": { "description": "The request for a Data Access Record Report.", "id": "GoogleAnalyticsAdminV1betaRunAccessReportRequest", diff --git a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json index 5cbfa86867a..0d56d36c517 100644 --- a/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsdata.v1beta.json @@ -440,7 +440,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index a1d141001ce..6f031ee5277 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1022,7 +1022,7 @@ } } }, -"revision": "20240708", +"revision": "20240630", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AnalyticsHubSubscriptionInfo": { diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json index d23d58d82a0..5cd9f66a907 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1beta1.json @@ -695,7 +695,7 @@ } } }, -"revision": "20240708", +"revision": "20240630", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json index 96b911a6f21..46e4d7ae9c9 100644 --- a/googleapiclient/discovery_cache/documents/androidenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/androidenterprise.v1.json @@ -2654,7 +2654,7 @@ } } }, -"revision": "20240711", +"revision": "20240704", "rootUrl": "https://androidenterprise.googleapis.com/", "schemas": { "Administrator": { diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 46aa77e69ec..8f92c22e6d5 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1168,7 +1168,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index 381268f3f40..f47d55e07e9 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -277,6 +277,36 @@ "https://www.googleapis.com/auth/androidpublisher" ] }, +"appRecoveries": { +"description": "List all app recovery action resources associated with a particular package name and app version.", +"flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", +"httpMethod": "POST", +"id": "androidpublisher.apprecovery.appRecoveries", +"parameterOrder": [ +"packageName" +], +"parameters": { +"packageName": { +"description": "Required. Package name of the app for which list of recovery actions is requested.", +"location": "path", +"required": true, +"type": "string" +}, +"versionCode": { +"description": "Required. Version code targeted by the list of recovery actions.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "androidpublisher/v3/applications/{packageName}/appRecoveries", +"response": { +"$ref": "ListAppRecoveriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] +}, "cancel": { "description": "Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.", "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:cancel", @@ -373,36 +403,6 @@ "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] -}, -"list": { -"description": "List all app recovery action resources associated with a particular package name and app version.", -"flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", -"httpMethod": "GET", -"id": "androidpublisher.apprecovery.list", -"parameterOrder": [ -"packageName" -], -"parameters": { -"packageName": { -"description": "Required. Package name of the app for which list of recovery actions is requested.", -"location": "path", -"required": true, -"type": "string" -}, -"versionCode": { -"description": "Required. Version code targeted by the list of recovery actions.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "androidpublisher/v3/applications/{packageName}/appRecoveries", -"response": { -"$ref": "ListAppRecoveriesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/androidpublisher" -] } } }, @@ -4731,7 +4731,7 @@ } } }, -"revision": "20240715", +"revision": "20240627", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6299,7 +6299,7 @@ "readOnly": true }, "transactionProgramCode": { -"description": "Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions.", +"description": "Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1.json b/googleapiclient/discovery_cache/documents/apigateway.v1.json index 29362fa7366..f8d81e7d891 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1.json @@ -1083,7 +1083,7 @@ } } }, -"revision": "20240701", +"revision": "20240617", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json index 7caf96ed772..8f873cafedf 100644 --- a/googleapiclient/discovery_cache/documents/apigateway.v1beta.json +++ b/googleapiclient/discovery_cache/documents/apigateway.v1beta.json @@ -1083,7 +1083,7 @@ } } }, -"revision": "20240701", +"revision": "20240617", "rootUrl": "https://apigateway.googleapis.com/", "schemas": { "ApigatewayApi": { diff --git a/googleapiclient/discovery_cache/documents/apigee.v1.json b/googleapiclient/discovery_cache/documents/apigee.v1.json index bae551be5c0..b6bf7f88f19 100644 --- a/googleapiclient/discovery_cache/documents/apigee.v1.json +++ b/googleapiclient/discovery_cache/documents/apigee.v1.json @@ -10045,7 +10045,7 @@ } } }, -"revision": "20240708", +"revision": "20240701", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { diff --git a/googleapiclient/discovery_cache/documents/apikeys.v2.json b/googleapiclient/discovery_cache/documents/apikeys.v2.json index a13dd654b41..fb9a07d5593 100644 --- a/googleapiclient/discovery_cache/documents/apikeys.v2.json +++ b/googleapiclient/discovery_cache/documents/apikeys.v2.json @@ -396,7 +396,7 @@ } } }, -"revision": "20240707", +"revision": "20240623", "rootUrl": "https://apikeys.googleapis.com/", "schemas": { "Operation": { diff --git a/googleapiclient/discovery_cache/documents/apim.v1alpha.json b/googleapiclient/discovery_cache/documents/apim.v1alpha.json index 66b953cff8a..03cb5ee4a9d 100644 --- a/googleapiclient/discovery_cache/documents/apim.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apim.v1alpha.json @@ -751,7 +751,7 @@ } } }, -"revision": "20240702", +"revision": "20240701", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index 445b0b81bbb..639b7837f6f 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1718,7 +1718,7 @@ } } }, -"revision": "20240711", +"revision": "20240708", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json index 925ec820d23..16202d10d76 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1alpha.json @@ -946,7 +946,7 @@ } } }, -"revision": "20240711", +"revision": "20240708", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "AuthorizedCertificate": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index 9a6dbe92eb4..5b318ec88ad 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1918,7 +1918,7 @@ } } }, -"revision": "20240711", +"revision": "20240708", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { diff --git a/googleapiclient/discovery_cache/documents/apphub.v1.json b/googleapiclient/discovery_cache/documents/apphub.v1.json index d4c397e46a8..5fe19b04d15 100644 --- a/googleapiclient/discovery_cache/documents/apphub.v1.json +++ b/googleapiclient/discovery_cache/documents/apphub.v1.json @@ -1346,7 +1346,7 @@ } } }, -"revision": "20240701", +"revision": "20240628", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json index 39cdef62da9..14fbc860caa 100644 --- a/googleapiclient/discovery_cache/documents/apphub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apphub.v1alpha.json @@ -1438,7 +1438,7 @@ } } }, -"revision": "20240701", +"revision": "20240628", "rootUrl": "https://apphub.googleapis.com/", "schemas": { "Application": { diff --git a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json index 64b24abfa02..1c383fac562 100644 --- a/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/area120tables.v1alpha1.json @@ -586,7 +586,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://area120tables.googleapis.com/", "schemas": { "BatchCreateRowsRequest": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index e998ab9e8e0..b92735bb985 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -2013,7 +2013,7 @@ } } }, -"revision": "20240708", +"revision": "20240704", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -3355,12 +3355,6 @@ false }, "type": "object" }, -"PromoteArtifactMetadata": { -"description": "The metadata for promote artifact long running operation.", -"id": "PromoteArtifactMetadata", -"properties": {}, -"type": "object" -}, "PythonPackage": { "description": "PythonPackage represents a python artifact.", "id": "PythonPackage", @@ -3741,7 +3735,7 @@ false "type": "string" }, "packageId": { -"description": "The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` should start and end with a letter or number, only contain letters, numbers, hyphens, underscores, and periods, and not exceed 256 characters.", +"description": "The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters.", "type": "string" }, "versionId": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json index 97086fe89dc..d289b85a595 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -1146,7 +1146,7 @@ } } }, -"revision": "20240708", +"revision": "20240704", "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 848eda20fa3..57e1457810b 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -1414,7 +1414,7 @@ } } }, -"revision": "20240708", +"revision": "20240704", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 9cccf6b3651..0d7ad8c52fc 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240703", +"revision": "20240627", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -683,19 +683,25 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", +"REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", +"REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -706,19 +712,25 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", +"Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", +"Assured Workloads For EU Regions and Support controls", +"Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", +"Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", +"Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", +"Assured Workloads for Japan Regions", "KSA R5 Controls.", "Assured Workloads for Regional Controls" ], @@ -1166,19 +1178,25 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", +"REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", +"REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -1189,19 +1207,25 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", +"Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", +"Assured Workloads For EU Regions and Support controls", +"Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", +"Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", +"Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", +"Assured Workloads for Japan Regions", "KSA R5 Controls.", "Assured Workloads for Regional Controls" ], diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index 36f40905192..7df193da679 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -588,7 +588,7 @@ } } }, -"revision": "20240703", +"revision": "20240627", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -680,19 +680,25 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", +"REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", +"REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -703,19 +709,25 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", +"Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", +"Assured Workloads For EU Regions and Support controls", +"Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", +"Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", +"Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", +"Assured Workloads for Japan Regions", "KSA R5 Controls.", "Assured Workloads for Regional Controls" ], @@ -1161,19 +1173,25 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", +"REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", +"REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", +"REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -1184,19 +1202,25 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", +"Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", +"Assured Workloads For EU Regions and Support controls", +"Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", +"Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", +"Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", +"Assured Workloads for Japan Regions", "KSA R5 Controls.", "Assured Workloads for Regional Controls" ], diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json index f250c5f2b26..c27ff921b7f 100644 --- a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1.json @@ -1367,7 +1367,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", "schemas": { "AcceptProposalRequest": { diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 8a9854497d8..45821ea16fd 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -1256,7 +1256,7 @@ } } }, -"revision": "20240703", +"revision": "20240626", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { diff --git a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json index b14a26f5277..c956338b1b8 100644 --- a/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json +++ b/googleapiclient/discovery_cache/documents/baremetalsolution.v2.json @@ -1722,7 +1722,7 @@ } } }, -"revision": "20240708", +"revision": "20240626", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "AllowedClient": { diff --git a/googleapiclient/discovery_cache/documents/batch.v1.json b/googleapiclient/discovery_cache/documents/batch.v1.json index e84991d1f4b..8939ac983f7 100644 --- a/googleapiclient/discovery_cache/documents/batch.v1.json +++ b/googleapiclient/discovery_cache/documents/batch.v1.json @@ -561,7 +561,7 @@ } } }, -"revision": "20240703", +"revision": "20240620", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -2010,7 +2010,7 @@ "type": "object" }, "StatusEvent": { -"description": "Status event.", +"description": "Status event", "id": "StatusEvent", "properties": { "description": { @@ -2024,10 +2024,10 @@ }, "taskExecution": { "$ref": "TaskExecution", -"description": "Task Execution. This field is only defined for task-level status events where the task fails." +"description": "Task Execution" }, "taskState": { -"description": "Task State. This field is only defined for task-level status events.", +"description": "Task State", "enum": [ "STATE_UNSPECIFIED", "PENDING", @@ -2223,11 +2223,11 @@ "type": "object" }, "TaskStatus": { -"description": "Status of a task.", +"description": "Status of a task", "id": "TaskStatus", "properties": { "state": { -"description": "Task state.", +"description": "Task state", "enum": [ "STATE_UNSPECIFIED", "PENDING", diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json index 8847ab787ea..5bbbf420ce7 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1.json @@ -1804,7 +1804,7 @@ } } }, -"revision": "20240626", +"revision": "20240619", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index f8fb052d3fb..801bb286084 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -1028,7 +1028,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", +"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -3534,7 +3534,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", +"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -4080,7 +4080,7 @@ } } }, -"revision": "20240626", +"revision": "20240619", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { diff --git a/googleapiclient/discovery_cache/documents/biglake.v1.json b/googleapiclient/discovery_cache/documents/biglake.v1.json index 583561c8a8c..ec27041a31c 100644 --- a/googleapiclient/discovery_cache/documents/biglake.v1.json +++ b/googleapiclient/discovery_cache/documents/biglake.v1.json @@ -616,7 +616,7 @@ } } }, -"revision": "20240710", +"revision": "20240703", "rootUrl": "https://biglake.googleapis.com/", "schemas": { "Catalog": { diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 9b3ab346278..eb2d1dbe1f3 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1935,7 +1935,7 @@ } } }, -"revision": "20240629", +"revision": "20240623", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2605,7 +2605,7 @@ "id": "BigtableColumnFamily", "properties": { "columns": { -"description": "Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field.", +"description": "Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field.", "items": { "$ref": "BigtableColumn" }, @@ -3121,7 +3121,7 @@ "type": "string" }, "role": { -"description": "An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", +"description": "An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", "type": "string" }, "routine": { @@ -3129,7 +3129,7 @@ "description": "[Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation." }, "specialGroup": { -"description": "[Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", +"description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", "type": "string" }, "userByEmail": { @@ -6415,7 +6415,7 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", -"Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." +"Model to capture the manual preprocessing logic in the transform clause." ], "readOnly": true, "type": "string" @@ -6586,7 +6586,7 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", -"Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." +"Model to capture the manual preprocessing logic in the transform clause." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json index 23e908867b1..e369a1ae5f0 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json @@ -366,7 +366,7 @@ } } }, -"revision": "20240629", +"revision": "20240623", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json index 2eb5b970c05..fdc2533ca08 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1beta1.json @@ -395,7 +395,7 @@ } } }, -"revision": "20240629", +"revision": "20240623", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json index 23d98ec1124..c48dd228202 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatapolicy.v1.json @@ -395,7 +395,7 @@ } } }, -"revision": "20240708", +"revision": "20240630", "rootUrl": "https://bigquerydatapolicy.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json index f568b815052..d974813d7fd 100644 --- a/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/bigquerydatatransfer.v1.json @@ -1403,7 +1403,7 @@ } } }, -"revision": "20240706", +"revision": "20240630", "rootUrl": "https://bigquerydatatransfer.googleapis.com/", "schemas": { "CheckValidCredsRequest": { diff --git a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json index 00f1cc2915b..a907f3a51e8 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryreservation.v1.json @@ -885,7 +885,7 @@ } } }, -"revision": "20240706", +"revision": "20240629", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index 8bc2f67471a..a095a4dafac 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -2194,7 +2194,7 @@ } } }, -"revision": "20240708", +"revision": "20240703", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { diff --git a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json index dfb74208f77..ef1d87d9118 100644 --- a/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/binaryauthorization.v1beta1.json @@ -551,7 +551,7 @@ } } }, -"revision": "20240705", +"revision": "20240701", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v2.json b/googleapiclient/discovery_cache/documents/blogger.v2.json index d0a3fe0dd09..f60f10181b8 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v2.json +++ b/googleapiclient/discovery_cache/documents/blogger.v2.json @@ -401,7 +401,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/blogger.v3.json b/googleapiclient/discovery_cache/documents/blogger.v3.json index b9c9b593b71..67ec6675870 100644 --- a/googleapiclient/discovery_cache/documents/blogger.v3.json +++ b/googleapiclient/discovery_cache/documents/blogger.v3.json @@ -1710,7 +1710,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://blogger.googleapis.com/", "schemas": { "Blog": { diff --git a/googleapiclient/discovery_cache/documents/books.v1.json b/googleapiclient/discovery_cache/documents/books.v1.json index 4e7bec7b471..3bea337c4ac 100644 --- a/googleapiclient/discovery_cache/documents/books.v1.json +++ b/googleapiclient/discovery_cache/documents/books.v1.json @@ -2677,7 +2677,7 @@ } } }, -"revision": "20240711", +"revision": "20240625", "rootUrl": "https://books.googleapis.com/", "schemas": { "Annotation": { diff --git a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json index dbb0bc916df..d29eb233025 100644 --- a/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json +++ b/googleapiclient/discovery_cache/documents/businessprofileperformance.v1.json @@ -417,7 +417,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://businessprofileperformance.googleapis.com/", "schemas": { "DailyMetricTimeSeries": { diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index 8efb4643508..75c57023925 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -1763,7 +1763,7 @@ } } }, -"revision": "20240705", +"revision": "20240621", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -2591,7 +2591,7 @@ "type": "string" }, "reminders": { -"description": "Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.", +"description": "Information about the event's reminders for the authenticated user.", "properties": { "overrides": { "description": "If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.", @@ -2651,7 +2651,7 @@ "type": "string" }, "updated": { -"description": "Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only.", +"description": "Last modification time of the event (as a RFC3339 timestamp). Read-only.", "format": "date-time", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 4c5d519d4ae..23b06637db9 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -433,7 +433,7 @@ "type": "string" }, "updateMask": { -"description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", +"description": "Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error. If you receive the error message `ALREADY_EXISTS` when updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error). `space_type` is not supported with admin access. - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.) `space_history_state` is not supported with admin access. - `access_settings.audience` (Supports changing the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1241,7 +1241,7 @@ } } }, -"revision": "20240709", +"revision": "20240701", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1257,14 +1257,14 @@ ], "enumDescriptions": [ "Access state is unknown or not supported in this API.", -"Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.", -"A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience)." +"Space is discoverable by added or invited members or groups.", +"Space is discoverable by the selected [target audience](https://support.google.com/a/answer/9934697), as well as added or invited members or groups." ], "readOnly": true, "type": "string" }, "audience": { -"description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", +"description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", "type": "string" } }, @@ -1850,7 +1850,7 @@ "type": "object" }, "DeprecatedEvent": { -"description": "A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", +"description": "A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/workspace/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", "id": "DeprecatedEvent", "properties": { "action": { @@ -1859,7 +1859,7 @@ }, "common": { "$ref": "CommonEventObject", -"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." +"description": "Represents informatmessage_visibilityion about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card." }, "configCompleteRedirectUrl": { "description": "The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/workspace/chat/connect-web-services-tools).", @@ -1896,7 +1896,7 @@ }, "space": { "$ref": "Space", -"description": "The space in which the user interacted with the Chat app." +"description": "The space in which the interaction event occurred." }, "threadKey": { "description": "The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.", @@ -1907,7 +1907,7 @@ "type": "string" }, "type": { -"description": "The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.", +"description": "The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events).", "enum": [ "UNSPECIFIED", "MESSAGE", @@ -1918,17 +1918,17 @@ ], "enumDescriptions": [ "Default value for the enum. DO NOT USE.", -"A user sends the Chat app a message, or invokes the Chat app in a space, such as any of the following examples: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its slash commands. * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.", -"A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. Chat apps typically respond to this interaction event by posting a welcome message in the space. When administrators install Chat apps, the `space.adminInstalled` field is set to `true` and users can't uninstall them. To learn about Chat apps installed by administrators, see Google Workspace Admin Help's documentation, [Install Marketplace apps in your domain](https://support.google.com/a/answer/172482).", -"A user removes the Chat app from a space, or a Google Workspace administrator uninstalls the Chat app for a user in their organization. Chat apps can't respond with messages to this event, because they have already been removed. When administrators uninstall Chat apps, the `space.adminInstalled` field is set to `false`. If a user installed the Chat app before the administrator, the Chat app remains installed for the user and the Chat app doesn't receive a `REMOVED_FROM_SPACE` interaction event.", -"A user clicks an interactive element of a card or dialog from a Chat app, such as a button. To receive an interaction event, the button must trigger another interaction with the Chat app. For example, a Chat app doesn't receive a `CARD_CLICKED` interaction event if a user clicks a button that opens a link to a website, but receives interaction events in the following examples: * The user clicks a `Send feedback` button on a card, which opens a dialog for the user to input information. * The user clicks a `Submit` button after inputting information into a card or dialog. If a user clicks a button to open, submit, or cancel a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", +"A user sends the Chat app a message, or invokes the Chat app in a space.", +"A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization.", +"A user removes the Chat app from a space.", +"A user clicks an interactive element of a card or dialog from a Chat app, such as a button. If a user interacts with a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", "A user updates a widget in a card message or dialog." ], "type": "string" }, "user": { "$ref": "User", -"description": "The user that interacted with the Chat app." +"description": "The user that triggered the interaction event." } }, "type": "object" @@ -4098,7 +4098,7 @@ "type": "string" }, "externalUserAllowed": { -"description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.", +"description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only.", "type": "boolean" }, "importMode": { diff --git a/googleapiclient/discovery_cache/documents/checks.v1alpha.json b/googleapiclient/discovery_cache/documents/checks.v1alpha.json index 9da179aca4a..95942cc43e5 100644 --- a/googleapiclient/discovery_cache/documents/checks.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/checks.v1alpha.json @@ -414,7 +414,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://checks.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 0d99f37a8e9..036e56cb06f 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -591,12 +591,12 @@ "type": "string" }, "filter": { -"description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions", +"description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id", "location": "query", "type": "string" }, "orderBy": { -"description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions", +"description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id", "location": "query", "type": "string" }, @@ -1172,7 +1172,7 @@ } } }, -"revision": "20240713", +"revision": "20240702", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { diff --git a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json index ae839e9cebe..eb9db9de9f5 100644 --- a/googleapiclient/discovery_cache/documents/chromepolicy.v1.json +++ b/googleapiclient/discovery_cache/documents/chromepolicy.v1.json @@ -557,7 +557,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { diff --git a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json index 92dde68a649..0fca1a5dc1e 100644 --- a/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json +++ b/googleapiclient/discovery_cache/documents/chromeuxreport.v1.json @@ -131,7 +131,7 @@ } } }, -"revision": "20240711", +"revision": "20240702", "rootUrl": "https://chromeuxreport.googleapis.com/", "schemas": { "Bin": { diff --git a/googleapiclient/discovery_cache/documents/civicinfo.v2.json b/googleapiclient/discovery_cache/documents/civicinfo.v2.json index cf59c37ff59..84fdf3ecb27 100644 --- a/googleapiclient/discovery_cache/documents/civicinfo.v2.json +++ b/googleapiclient/discovery_cache/documents/civicinfo.v2.json @@ -362,7 +362,7 @@ } } }, -"revision": "20240715", +"revision": "20240620", "rootUrl": "https://civicinfo.googleapis.com/", "schemas": { "AdministrationRegion": { diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index ab8f87b185c..e8fdd4b8fad 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -3695,7 +3695,7 @@ } } }, -"revision": "20240708", +"revision": "20240701", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index 928861946ff..c7ce5e4c567 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -1095,7 +1095,7 @@ } } }, -"revision": "20240705", +"revision": "20240629", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index 2a6ece0a5b8..94b32728da7 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20240705", +"revision": "20240629", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index 61954b1a94c..7f5415feaf7 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20240705", +"revision": "20240629", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index 080a977b8eb..9a6c03f94b8 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20240705", +"revision": "20240629", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index 8146f9252a3..e96628409df 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, -"revision": "20240705", +"revision": "20240629", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json index 319dcb8c108..fcaecff400d 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1.json @@ -751,7 +751,7 @@ } } }, -"revision": "20240710", +"revision": "20240614", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "AggregationInfo": { diff --git a/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json b/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json index 0a7a16d317b..45696e94593 100644 --- a/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json +++ b/googleapiclient/discovery_cache/documents/cloudbilling.v1beta.json @@ -761,7 +761,7 @@ } } }, -"revision": "20240710", +"revision": "20240614", "rootUrl": "https://cloudbilling.googleapis.com/", "schemas": { "CacheFillRegions": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index a310ee5549f..bb9b46c18ce 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2346,7 +2346,7 @@ } } }, -"revision": "20240704", +"revision": "20240627", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -4295,7 +4295,7 @@ false "id": "HttpConfig", "properties": { "proxySecretVersionName": { -"description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", +"description": "SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port].", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json index 804598c9561..7f055e49e79 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json @@ -844,7 +844,7 @@ } } }, -"revision": "20240704", +"revision": "20240627", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -1806,14 +1806,12 @@ "enum": [ "TYPE_UNSPECIFIED", "STRING", -"ARRAY", -"OBJECT" +"ARRAY" ], "enumDescriptions": [ "Default enum type; should not be used.", "Default", -"Array type.", -"Object type." +"Arrary type." ], "type": "string" } @@ -1831,13 +1829,6 @@ }, "type": "array" }, -"objectVal": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. Value of the parameter if type is object.", -"type": "object" -}, "stringVal": { "description": "Value of the parameter if type is string.", "type": "string" @@ -1847,14 +1838,12 @@ "enum": [ "TYPE_UNSPECIFIED", "STRING", -"ARRAY", -"OBJECT" +"ARRAY" ], "enumDescriptions": [ "Default enum type; should not be used.", "Default", -"Array type", -"Object type" +"Array type" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json index e2e58fafd9d..5dbc7a457a9 100644 --- a/googleapiclient/discovery_cache/documents/cloudchannel.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudchannel.v1.json @@ -2183,7 +2183,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json index e0435f5753c..b97f33623b8 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json @@ -484,7 +484,7 @@ } } }, -"revision": "20240701", +"revision": "20240626", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json index 845ae582bc0..083e2781044 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json @@ -484,7 +484,7 @@ } } }, -"revision": "20240701", +"revision": "20240626", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { diff --git a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json index c11334f5701..60999c6578b 100644 --- a/googleapiclient/discovery_cache/documents/clouddeploy.v1.json +++ b/googleapiclient/discovery_cache/documents/clouddeploy.v1.json @@ -2065,7 +2065,7 @@ } } }, -"revision": "20240701", +"revision": "20240626", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json index 54e1a63deed..92464a677bf 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -552,7 +552,7 @@ } } }, -"revision": "20240704", +"revision": "20240627", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json index cebc4e94e5a..6b392721abb 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2.json @@ -716,7 +716,7 @@ } } }, -"revision": "20240704", +"revision": "20240627", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json index c2d116f9b9a..4b7d983d4b2 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2alpha.json @@ -716,7 +716,7 @@ } } }, -"revision": "20240704", +"revision": "20240627", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json index 0232e10a518..23d6e1e690a 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v2beta.json @@ -716,7 +716,7 @@ } } }, -"revision": "20240704", +"revision": "20240627", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AbortFunctionUpgradeRequest": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json index 04608eb29f3..797b0c976cc 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1.json @@ -1990,7 +1990,7 @@ } } }, -"revision": "20240709", +"revision": "20240702", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json index 6dc465cb722..67f9f5f5d3c 100644 --- a/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudidentity.v1beta1.json @@ -2015,7 +2015,7 @@ } } }, -"revision": "20240709", +"revision": "20240702", "rootUrl": "https://cloudidentity.googleapis.com/", "schemas": { "AddIdpCredentialOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json index 64d3ed022f8..e5bfc583ad7 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1.json @@ -1171,7 +1171,7 @@ } } }, -"revision": "20240708", +"revision": "20240707", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json index 2f8e5d80fb9..690fc9841d0 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v1beta1.json @@ -568,7 +568,7 @@ } } }, -"revision": "20240708", +"revision": "20240707", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "Ancestor": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json index 3cec1dc81c1..0efb1968ce9 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2.json @@ -450,7 +450,7 @@ } } }, -"revision": "20240708", +"revision": "20240707", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json index f182264fdf2..9665c6fd810 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v2beta1.json @@ -450,7 +450,7 @@ } } }, -"revision": "20240708", +"revision": "20240707", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json index 63ad46c934a..5786bc32fd5 100644 --- a/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json +++ b/googleapiclient/discovery_cache/documents/cloudresourcemanager.v3.json @@ -1805,7 +1805,7 @@ } } }, -"revision": "20240708", +"revision": "20240707", "rootUrl": "https://cloudresourcemanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json index 4e04f9954c9..a4e5c3f9694 100644 --- a/googleapiclient/discovery_cache/documents/cloudsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudsearch.v1.json @@ -2115,7 +2115,7 @@ } } }, -"revision": "20240626", +"revision": "20240612", "rootUrl": "https://cloudsearch.googleapis.com/", "schemas": { "Action": { @@ -2187,24 +2187,6 @@ }, "type": "object" }, -"BandWidthRangeKbps": { -"id": "BandWidthRangeKbps", -"properties": { -"percentile10": { -"format": "int32", -"type": "integer" -}, -"percentile50": { -"format": "int32", -"type": "integer" -}, -"percentile90": { -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, "BooleanOperatorOptions": { "description": "Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", "id": "BooleanOperatorOptions", @@ -2237,1925 +2219,1572 @@ }, "type": "object" }, -"ClientOptInContext": { -"description": "Represents the user's current opt-in status on the current device related to features such as Google Now, App and Web History, Device State and Content. Each opt-in status includes an eligibility status, which depends on the type of account (Dasher, etc.), country, language, and device specifics. Next id: 38 Note: if the proto is changed, please also update the code that converts it to corresponding logs proto (they are in the same name but incompatible so manual conversion is needed). LINT.IfChange", -"id": "ClientOptInContext", +"CompositeFilter": { +"id": "CompositeFilter", "properties": { -"ambientEnrollmentStatus": { -"description": "Enrollment status for Ambient Mode feature go/assistant-ambient-mode", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" -}, -"ambientPhotoEnrollmentStatus": { -"description": "Enrollment status for PhotoFrame feature in Ambient Mode. This is different from PhotoFrame enrollment in other features such as Dreamliner. go/assistant-ambient-mode", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" -}, -"assistantOnLockscreenStatus": { -"description": "Whether the user has opted into enabling Assistant on Lockscreen. go/iris-newperm-prd", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" -}, -"audioHistoryStatus": { -"$ref": "OptInStatus", -"description": "Audio History. Used to improve speech recognition and hotword triggering. https://sites.google.com/a/google.com/android-speech/projects/audio-history" -}, -"bluetoothAudioRecordingStatus": { -"description": "Whether the user has opted into bluetooth audio recording setting.", +"logicOperator": { +"description": "The logic operator of the sub filter.", "enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" +"AND", +"OR", +"NOT" ], "enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." +"Logical operators, which can only be applied to sub filters.", +"", +"NOT can only be applied on a single sub filter." ], "type": "string" }, -"chromeSyncStatus": { -"$ref": "OptInStatus", -"description": "Set to true iff the user is signed into Chrome with the same account as GSA and has Chrome sync enabled (as reported by Chrome to GSA). This can be used to serve personalized suggestions based on the user's browsing history." -}, -"deviceAppsStatus": { -"$ref": "OptInStatus", -"description": "Allows Google to upload device app information." -}, -"deviceContactsStatus": { -"$ref": "OptInStatus", -"description": "Allows Google to upload contact information from device." -}, -"deviceStateAndContentStatus": { -"$ref": "OptInStatus", -"description": "User allows Google to upload state (aka settings) and content (documents and media) from their device. See https://goto.google.com/device-consents" -}, -"disabledIcingSourceApps": { -"description": "List of Android package names the user disabled from appearing in the autocomplete suggestions on their device. ", +"subFilters": { +"description": "Sub filters.", "items": { -"type": "string" +"$ref": "Filter" }, "type": "array" +} +}, +"type": "object" }, -"disabledIcingSources": { -"description": "List of Android packages and corpora that the user disabled. This replaces disabled_icing_source_apps and allows disabling a single corpus for a particular package.", +"Content": { +"id": "Content", +"properties": { +"actions": { +"description": "[Optional] Actions for this card.", "items": { -"$ref": "DisabledIcingPackageCorpus" +"$ref": "Action" }, "type": "array" }, -"headphonePersonalResultsStatus": { -"description": "Whether the user has opted into headphone personal results setting. go/enable-pr-with-headset", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" -}, -"hotwordEnrollmentStatus": { -"$ref": "OptInStatus", -"description": "Enrollment status for Hotword any-screen/always-on. This information is sent to the server-side to know that the user can run Hotword. For example, in go/gsa-voice-feature-tips using this information, the user will be shown Voice Tips that will take the user directly to the enrollment and guide them to move to the next level of Voice Features experience." +"description": { +"$ref": "SafeHtmlProto", +"description": "[Optional] Description of the card." }, -"locationHistoryStatus": { -"$ref": "OptInStatus", -"description": "User allows Google to upload location history from their device. See https://goto.google.com/gcore-ulr" +"subtitle": { +"$ref": "BackgroundColoredText", +"description": "[Optional] Subtitle of the card." }, -"lockscreenPersonalResponseStatus": { -"description": "Whether the user has opted into showing personal response on Lockscreen.", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" +"title": { +"$ref": "BackgroundColoredText", +"description": "[Optional] Title of the card." +} }, -"lockscreenSearchBluetoothStatus": { -"description": "Whether the user has opted into lockscreen queries via bluetooth headsets setting.", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" +"type": "object" }, -"lockscreenSearchWiredHeadsetStatus": { -"description": "Whether the user has opted into lockscreen queries via wired headsets setting.", +"Context": { +"id": "Context", +"properties": { +"app": { +"description": "[Optional] App where the card should be shown. If missing, the card will be shown in TOPAZ.", +"items": { "enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" +"UNKNOWN_APP", +"TOPAZ", +"MOMA" ], "enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." +"", +"", +"" ], "type": "string" }, -"nowNotificationStatus": { -"$ref": "OptInStatus", -"description": "Google Now push notifications." -}, -"nowStatus": { -"$ref": "OptInStatus", -"description": "Google Now activation." +"type": "array" }, -"nowTosVersion": { -"description": "Google Now marks each release with a TOS version, so it can ask users to opt in again if the terms change from release to release.", +"dayOfWeek": { +"description": "[Optional] Day of week when the card should be shown, where 0 is Monday.", +"items": { "format": "int32", "type": "integer" }, -"opaEligibility": { -"description": "User's eligibility to use the Assistant.", -"enum": [ -"NOT_ELIGIBLE", -"ELIGIBLE_PREBUILT", -"ELIGIBLE_FOR_UPGRADE", -"ELIGIBLE_UPGRADING", -"ELIGIBLE_UPGRADED", -"ELIGIBLE_UPGRADED_BYPASS" -], -"enumDescriptions": [ -"User is not eligible for OPA", -"User is eligible for OPA because their device came with OPA.", -"User is eligible to upgrade to OPA after their formerly-ineligible device received an update to AGSA >= 6.13 and received the proper config flags.", -"User is eligible to upgrade, AND has started the upgrade, but NOT finished it. By definition, a user who is ELIGIBLE_UPGRADING was ELIGIBLE_FOR_UPGRADE at some point prior.", -"User is eligible for OPA after completing the upgrade flow. By definition, a user who is ELIGIBLE_UPGRADED was ELIGIBLE_UPGRADING at some point prior.", -"User is eligible for OPA and bypassed some screens in onboarding to complete the upgrade flow. By definition, a user who is ELIGIBLE_UPGRADED_BYPASS is an OPA upgraded user and was ELIGIBLE_UPGRADING at some point prior." -], -"type": "string" +"type": "array" }, -"opaEmailOptInStatus": { -"description": "Has the user opted-in to receiving emails for OPA? This is set when the user opts-in during the OPA upgrade flow. It has an UNKNOWN value otherwise. Note that this bit isn't updated if the user changes their email opt-in status through settings or unsubscribing in the email.", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], +"endDateSec": { +"description": "[Optional] Date (in seconds since epoch) when the card should stop being shown. If missing, end_date_sec will be set to Jan 1st, 2100.", +"format": "int64", "type": "string" }, -"opaExperienceType": { -"description": "The Opa experience type. As of Feb 2019, it is only used to check whether the user is in the Try Before You Buy experience.", -"enum": [ -"OPA_EXPERIENCE_TYPE_UNKNOWN", -"OPA_EXPERIENCE_INELIGIBLE", -"OPA_EXPERIENCE_NOT_STARTED", -"OPA_EXPERIENCE_TRY_BEFORE_YOU_BUY", -"OPA_EXPERIENCE_COMPLETED_ONBOARDING" -], -"enumDescriptions": [ -"Default value. AGSA 9.27-: all users AGSA 9.27+ 9.66-: all users but TBYB users AGSA 9.66+: not used", -"OPA-ineligible users (AGSA 9.66+ only)", -"The initial state of OPA-eligible users (AGSA 9.66+ only)", -"TBYB users (AGSA 9.27+ only)", -"OOBE-completed users (AGSA 9.66+ only)" -], +"endDayOffsetSec": { +"description": "[Optional] End time in seconds, within a day, when the card should stop being shown if it's within [start_date_sec, end_date_sec]. If missing, this is set to 86400 (24 hours x 3600 sec/hour), i.e., midnight next day.", +"format": "int64", "type": "string" }, -"opaPartialExperienceReason": { -"description": "The reason why user enters the OPA \"signed-out mode\" partial experience (go/opa-signed-out-everywhere). Note that the value only means how the user entered the partial experience. For example, if a user enters TBYB and becomes a full-experience user, this value will remain as TBYB. To check the current experience type, you should read opa_experience_type instead.", -"enum": [ -"OPA_PARTIAL_EXPERIENCE_REASON_UNKNOWN", -"OPA_TRY_BEFORE_YOU_BUY", -"OPA_UDC_OPT_OUT_FLOW" -], -"enumDescriptions": [ -"Default value", -"User enters OPA \"siged-out mode\" partial experience due to the try-before-you-buy (TBYB) experiment go/opa-tbyb-experiment-plan", -"User enters OPA \"siged-out mode\" partial experience due to the \"UDC opt-out flow\" experiment (go/opa-udc-opt-out-ux-flow)" -], +"locale": { +"description": "[Optional] The locales for which the card should be triggered (e.g., en_US and en_CA). If missing, the card is going to show to clients regardless of their locale.", +"items": { "type": "string" }, -"opaUdcConsentStatus": { -"description": "Has the user opted in to OPA's UDC requirements? \"OPA UDC consent\" is a one-time opt-in to the set of required UDC opt-in bits. If the user has already granted all required UDC opt-ins, then we automatically mark them as consented. We require that users grant OPA UDC consent before using OPA for the first time. Note: The user does not revoke OPA UDC consent if they turn off one of the UDC opt-in bits from Settings; for such users, the server either offers a degraded experience, or prompts the user to re-grant missing opt-ins.)", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" +"type": "array" }, -"opaUserEnabledStatus": { -"description": "A user-configurable global on/off switch for the Assistant; the user can completely disable the assistant (go/opa-enabled-ss). Defaults to enabled. This setting is completely independent from the user's opa_eligibility; they can be eligible, but OPA disabled. There users are by definition not making Assistant queries, so this value is a signal of the population size.", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], +"location": { +"description": "[Optional] Text-free locations where the card should be shown. This is expected to match the user's location in focus. If no location is specified, the card will be shown for any location.", +"items": { "type": "string" }, -"proactivePersonalResponseStatus": { -"description": "Whether the user has opted into showing proactive personal suggestions on lock screen before asking. This is the proactive sub-bit for lockscreen_personal_response_status.", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" +"type": "array" }, -"screenContextOptInStatus": { -"description": "Has the user granted permission for Google to read the contents of their screen. Note that in OPA, training hotword automatically opts the user into screen context.", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], +"query": { +"description": "[Required only for Answer and RHS cards - will be ignored for Homepage] cards. It's the exact case-insensitive queries that will trigger the Answer or RHS card.", +"items": { "type": "string" }, -"skipVoiceRecognitionStatus": { -"description": "Whether the user has opted into skipping voice recognition. go/iris-newperm-prd", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" +"type": "array" }, -"speakerModelStatus": { -"description": "Whether the user has enrolled the Speaker ID model.", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], +"startDateSec": { +"description": "[Optional] Date (in seconds since epoch) when the card should start being shown. If missing, start_date_sec will be Jan 1st, 1970 UTC.", +"format": "int64", "type": "string" }, -"thirdPartyDisclosureStatus": { -"description": "Whether the user has acknowledged the third party disclosure.", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], +"startDayOffsetSec": { +"description": "[Optional] Start time in seconds, within a day, when the card should be shown if it's within [start_date_sec, end_date_sec]. If 0, the card will be shown from 12:00am on.", +"format": "int64", "type": "string" }, -"warmActionsAlarmsTimersEnrollmentStatus": { -"description": "Whether the user has opted into alarms/timers context for Quick phrases.", +"surface": { +"description": "[Optional] Surface where the card should be shown in. If missing, the card will be shown in any surface.", +"items": { "enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" +"UNKNOWN_SURFACE", +"DESKTOP", +"ANDROID", +"IOS", +"MOBILE", +"ANY" ], "enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." +"", +"", +"", +"", +"Any mobile device.", +"" ], "type": "string" }, -"warmActionsCallsEnrollmentStatus": { -"description": "Whether the user has opted into calls context for Quick phrases.", -"enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" -], -"enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." -], -"type": "string" +"type": "array" }, -"warmActionsEnrollmentStatus": { -"description": "Whether the user has opted into at least one Mobile Warm Words/Quick Phrases context. go/mww-prd", +"type": { +"description": "[Required] Type of the card (homepage, Answer or RHS).", +"items": { "enum": [ -"OPA_OPT_IN_STATUS_UNKNOWN", -"OPA_OPT_IN_STATUS_DISABLED", -"OPA_OPT_IN_STATUS_ENABLED" +"UNKNOWN_CARD_TYPE", +"HOMEPAGE_CARD", +"ANSWER_CARD", +"RHS_CARD" ], "enumDescriptions": [ -"The user has never been prompted with this opt-in.", -"The user has rejected the opt-in.", -"The user has accepted the opt-in." +"", +"", +"", +"" ], "type": "string" }, -"webAndAppHistoryStatus": { -"$ref": "OptInStatus", -"description": "User allows Google to upload usage history from their device. This field can be set to true iff web_history_status is set to true. Historically, this used to be called \"Supplemental Search History\". See https://goto.google.com/device-consents" -}, -"webHistoryStatus": { -"$ref": "OptInStatus", -"description": "User allows Google to log interactions with Search from their device. Historically, this used to be called \"Search History\". See https://goto.google.com/device-consents" +"type": "array" } }, "type": "object" }, -"CloudsearchEmailAddress": { -"description": "A person's email address.", -"id": "CloudsearchEmailAddress", +"ContextAttribute": { +"description": "A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.", +"id": "ContextAttribute", "properties": { -"emailAddress": { -"description": "The email address.", +"name": { +"description": "The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.", "type": "string" }, -"primary": { -"description": "Indicates if this is the user's primary email. Only one entry can be marked as primary.", -"type": "boolean" +"values": { +"description": "Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" }, -"CloudsearchFilter": { -"description": "Generic way of expessing filters. It support two ways. 1. Setting name and the value. The name has to be an operator_name defined in schema. 2. Setting the operator and filters. The sub filters will be evaluated using the operator.", -"id": "CloudsearchFilter", +"CustomerIndexStats": { +"description": "Aggregation of items by status code as of the specified date.", +"id": "CustomerIndexStats", "properties": { -"filters": { -"description": "Sub filters. If present, the operator must be set.", +"date": { +"$ref": "Date", +"description": "The date for which statistics were calculated." +}, +"itemCountByStatus": { +"description": "Number of items aggregrated by status code.", "items": { -"$ref": "CloudsearchFilter" +"$ref": "ItemCountByStatus" }, "type": "array" -}, -"name": { -"description": "The operator_name that we apply to the query, e.g. price_greater_than. It can be either case, 1. operator_name in schema. We will filter the results with the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in schema. We will filter the results that property is greater than or less than the given value.", -"type": "string" -}, -"operator": { -"description": "The operator of the filter.", -"enum": [ -"AND", -"OR", -"NOT" -], -"enumDescriptions": [ -"Logical operators, can only be applied to a sub filters.", -"", -"NOT can only be appiled on a single sub filters." -], -"type": "string" -}, -"value": { -"$ref": "CloudsearchValue", -"description": "The value to check. If present, the name must be set." } }, "type": "object" }, -"CloudsearchFilterSuggestion": { -"description": "A filter suggestion.", -"id": "CloudsearchFilterSuggestion", +"CustomerQueryStats": { +"id": "CustomerQueryStats", "properties": { -"filter": { -"$ref": "CloudsearchFilter", -"description": "The filter suggestion. It can be 1. A value filter, e.g. type:documents 2. A composite filter before:today and after:yesterday" -}, -"suggestionMatchInfo": { -"$ref": "CloudsearchSnippet", -"description": "This field contains the suggestion match information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside suggestion_match_info is: \"google search\", and the keyword \"goog\" is supposed to be bolded, the match_ranges is the list of range of indexes in the snippet string where it is bolded: [[0, 4)]." -}, -"type": { -"enum": [ -"NONE", -"OPERATOR", -"LABEL" -], -"enumDescriptions": [ -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" +"date": { +"$ref": "Date", +"description": "The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned." }, -"CloudsearchGroup": { -"description": "Object to represent a group.", -"id": "CloudsearchGroup", -"properties": { -"emailAddresses": { -"description": "The group's email addresses", +"queryCountByStatus": { "items": { -"$ref": "CloudsearchEmailAddress" +"$ref": "QueryCountByStatus" }, "type": "array" +} }, -"groupNames": { -"description": "Group's names", -"items": { -"$ref": "CloudsearchName" -}, -"type": "array" +"type": "object" }, -"name": { -"description": "The resource name of the group to provide information about. See People.get from Google People API.", +"CustomerSearchApplicationStats": { +"description": "Search application stats for a customer for the given date.", +"id": "CustomerSearchApplicationStats", +"properties": { +"count": { +"description": "The count of search applications for the date.", +"format": "int64", "type": "string" }, -"obfuscatedId": { -"description": "Obfuscated GAIA ID of a google group. Used by first party Cloud Search clients.", -"type": "string" +"date": { +"$ref": "Date", +"description": "The date for which search application stats were calculated." } }, "type": "object" }, -"CloudsearchImage": { -"description": "Image returned with suggestion; eg: person's photo or document thumbnail.", -"id": "CloudsearchImage", +"CustomerSessionStats": { +"id": "CustomerSessionStats", "properties": { -"source": { -"description": "Specifies the source from where the photo is fetched.", -"enum": [ -"CONTACT_DATA_SOURCE_UNSPECIFIED", -"CONTACT_DATA_SOURCE_PROFILE", -"CONTACT_DATA_SOURCE_DOMAIN_PROFILE", -"CONTACT_DATA_SOURCE_CONTACT", -"CONTACT_DATA_SOURCE_DOMAIN_CONTACT", -"CONTACT_DATA_SOURCE_AFFINITY" -], -"enumDescriptions": [ -"Data source for the contact is not specified.", -"This is where a Google user keeps and edits information about themself. They can decide who (what other Google users) can view which parts of it. Since it is information a user is managing about themselves, it is considered to be the most up-to-date.", -"Google-For-Work Profile. The domain profile data source describes Google profile data that is populated/edited by the admin of a Google Workspace organization.", -"Where a Google user keeps contact information about others, like phone numbers, emails and more. The user owns and edits this information. It could be out of date or incorrect. Users are generally only allowed to read their own contacts. Contacts are typically synced to mobile devices and used in apps like Gmail and Hangouts.", -"Domain shared contact. An entity that is owned by a domain and represents a person, but is not a user in the domain. For more details see https://support.google.com/a/answer/9281635.", -"Device contacts that are used in interaction ranking, but have not been uploaded to Google. These are synthesized people from interaction data." -], -"type": "string" +"date": { +"$ref": "Date", +"description": "The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned." }, -"url": { -"description": "The URL of the photo.", +"searchSessionsCount": { +"description": "The count of search sessions on the day", +"format": "int64", "type": "string" } }, "type": "object" }, -"CloudsearchMatchRange": { -"description": "Matched range of a snippet [start, end). The \"start\" and \"end\" positions are 0 indexed. For example, if the snippet string is \"google search\" and the string to be matched is \"goog\", the MatchRange is [0, 4).", -"id": "CloudsearchMatchRange", +"CustomerSettings": { +"description": "Represents settings at a customer level.", +"id": "CustomerSettings", "properties": { -"end": { -"description": "1 + index of the ending position of the match in the snippet.", -"format": "int32", -"type": "integer" +"auditLoggingSettings": { +"$ref": "AuditLoggingSettings", +"description": "Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." }, -"start": { -"description": "Index of the starting position of the match in the snippet.", -"format": "int32", -"type": "integer" +"vpcSettings": { +"$ref": "VPCSettings", +"description": "VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." } }, "type": "object" }, -"CloudsearchName": { -"description": "A person or group's name.", -"id": "CloudsearchName", +"CustomerUserStats": { +"id": "CustomerUserStats", "properties": { -"displayName": { -"description": "The read-only display name formatted according to the locale specified by the viewer's account or the Accept-Language HTTP header.", +"date": { +"$ref": "Date", +"description": "The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned." +}, +"oneDayActiveUsersCount": { +"description": "The count of unique active users in the past one day", +"format": "int64", "type": "string" }, -"source": { -"description": "Specifies the source from where the name is fetched.", -"enum": [ -"CONTACT_DATA_SOURCE_UNSPECIFIED", -"CONTACT_DATA_SOURCE_PROFILE", -"CONTACT_DATA_SOURCE_DOMAIN_PROFILE", -"CONTACT_DATA_SOURCE_CONTACT", -"CONTACT_DATA_SOURCE_DOMAIN_CONTACT", -"CONTACT_DATA_SOURCE_AFFINITY" -], -"enumDescriptions": [ -"Data source for the contact is not specified.", -"This is where a Google user keeps and edits information about themself. They can decide who (what other Google users) can view which parts of it. Since it is information a user is managing about themselves, it is considered to be the most up-to-date.", -"Google-For-Work Profile. The domain profile data source describes Google profile data that is populated/edited by the admin of a Google Workspace organization.", -"Where a Google user keeps contact information about others, like phone numbers, emails and more. The user owns and edits this information. It could be out of date or incorrect. Users are generally only allowed to read their own contacts. Contacts are typically synced to mobile devices and used in apps like Gmail and Hangouts.", -"Domain shared contact. An entity that is owned by a domain and represents a person, but is not a user in the domain. For more details see https://support.google.com/a/answer/9281635.", -"Device contacts that are used in interaction ranking, but have not been uploaded to Google. These are synthesized people from interaction data." -], +"sevenDaysActiveUsersCount": { +"description": "The count of unique active users in the past seven days", +"format": "int64", +"type": "string" +}, +"thirtyDaysActiveUsersCount": { +"description": "The count of unique active users in the past thirty days", +"format": "int64", "type": "string" } }, "type": "object" }, -"CloudsearchPeopleSuggestion": { -"description": "A person suggestion.", -"id": "CloudsearchPeopleSuggestion", +"DataSource": { +"description": "Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search. ", +"id": "DataSource", "properties": { -"emailNameMatchInfo": { -"$ref": "CloudsearchSnippet", -"description": "This field contains the suggestion information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside email_name_match_info is: \"John Doe - johndoe@google.com\", and the keyword \"doe\" should be matched, the match_ranges is: [[5, 8), [15, 18)]." +"disableModifications": { +"description": "If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.", +"type": "boolean" }, -"googleGroup": { -"$ref": "CloudsearchGroup" +"disableServing": { +"description": "Disable serving any search or assist results.", +"type": "boolean" }, -"person": { -"$ref": "CloudsearchPerson" -} +"displayName": { +"description": "Required. Display name of the datasource The maximum length is 300 characters.", +"type": "string" }, -"type": "object" +"indexingServiceAccounts": { +"description": "List of service accounts that have indexing access.", +"items": { +"type": "string" }, -"CloudsearchPerson": { -"description": "Object to represent a person.", -"id": "CloudsearchPerson", -"properties": { -"emailAddresses": { -"description": "The person's email addresses", +"type": "array" +}, +"itemsVisibility": { +"description": "This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.", "items": { -"$ref": "CloudsearchEmailAddress" +"$ref": "GSuitePrincipal" }, "type": "array" }, "name": { -"description": "The resource name of the person to provide information about. See People.get from Google People API.", -"type": "string" -}, -"obfuscatedId": { -"description": "Obfuscated GAIA ID of a person. Used by first party Cloud Search client, to build a hangout link.", +"description": "The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.", "type": "string" }, -"personNames": { -"description": "The person's names", +"operationIds": { +"description": "IDs of the Long Running Operations (LROs) currently running for this schema.", "items": { -"$ref": "CloudsearchName" +"type": "string" }, "type": "array" }, -"photos": { -"description": "A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.", -"items": { -"$ref": "CloudsearchImage" +"returnThumbnailUrls": { +"description": "Can a user request to get thumbnail URI for Items indexed in this data source.", +"type": "boolean" }, -"type": "array" +"shortName": { +"description": "A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is ** then queries like *source:* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.", +"type": "string" } }, "type": "object" }, -"CloudsearchQuerySuggestion": { -"id": "CloudsearchQuerySuggestion", +"DataSourceIndexStats": { +"description": "Aggregation of items by status code as of the specified date.", +"id": "DataSourceIndexStats", "properties": { -"suggestionMatchInfo": { -"$ref": "CloudsearchSnippet", -"description": "This field contains the suggestion match information returned by the backend after escaping the HTML in the suggestion string. The areas that we might like to extract from the suggestion string returned by the backend are marked using the match_ranges field inside Snippet. For example, if the snippet string inside suggestion_match_info is: \"google search\", and the keyword \"goog\" is supposed to be bolded, the match_ranges is the list of range of indexes in the snippet string where it is bolded: [[0, 4)]." +"date": { +"$ref": "Date", +"description": "The date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned." +}, +"itemCountByStatus": { +"description": "Number of items aggregrated by status code.", +"items": { +"$ref": "ItemCountByStatus" +}, +"type": "array" } }, "type": "object" }, -"CloudsearchSnippet": { -"description": "Snippet of the suggestion, which summarizes the content of the resulting page.", -"id": "CloudsearchSnippet", +"DataSourceRestriction": { +"description": "Restriction on Datasource.", +"id": "DataSourceRestriction", "properties": { -"matchRanges": { -"description": "The matched ranges in the snippet.", +"filterOptions": { +"description": "Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: \"objecttype\", \"type\" and \"mimetype\". For now, schema specific filters cannot be used to filter suggestions.", "items": { -"$ref": "CloudsearchMatchRange" +"$ref": "FilterOptions" }, "type": "array" }, -"snippet": { -"description": "The snippet of the document.", -"type": "string" +"source": { +"$ref": "Source", +"description": "The source of restriction." } }, "type": "object" }, -"CloudsearchSource": { -"description": "Define a source to query suggest/search APIs. Source is set in the STMixer request params.", -"id": "CloudsearchSource", +"Date": { +"description": "Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.", +"id": "Date", "properties": { -"anyThirdPartySource": { -"description": "If set to true, all 3p sources will be considered", -"type": "boolean" +"day": { +"description": "Day of month. Must be from 1 to 31 and valid for the year and month.", +"format": "int32", +"type": "integer" }, -"name": { -"description": "Source name of contents that indexed by Index API", -"type": "string" +"month": { +"description": "Month of date. Must be from 1 to 12.", +"format": "int32", +"type": "integer" }, -"predefinedSource": { -"description": "Predefined source for Google Apps.", -"enum": [ -"GENERIC", -"GROUPS", -"QUERY_HISTORY", -"PEOPLE", -"GOOGLE_DRIVE", -"GOOGLE_GMAIL", -"GOOGLE_SITES", -"GOOGLE_GROUPS", -"GOOGLE_CALENDAR", -"GOOGLE_CHAT", -"GOOGLE_KEEP", -"ENGDOC", -"GOOGLE_ATARI", -"GOOGLE_JOTSPOT", -"GOOWIKI", -"MOMA_GLOSSARY", -"MOMA_UAR", -"ENGDOC_RESTRICTED", -"GKMS", -"X20", -"YAQS", -"ENTERPRISE_ASSIST", -"FILTER" -], -"enumDescriptions": [ -"Default source.", -"", -"People API source. Used for suggest API only. Ignored in search API.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"" -], -"type": "string" +"year": { +"description": "Year of date. Must be from 1 to 9999.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"CloudsearchSuggestResponseDebugInfo": { -"id": "CloudsearchSuggestResponseDebugInfo", +"DateOperatorOptions": { +"description": "Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", +"id": "DateOperatorOptions", "properties": { -"completeServerInfo": { -"$ref": "CloudsearchSuggestResponseDebugInfoCompleteServerInfo" +"greaterThanOperatorName": { +"description": "Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:* show results only where the value of the property named *closeDate* is later than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", +"type": "string" +}, +"lessThanOperatorName": { +"description": "Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:* show results only where the value of the property named *closeDate* is earlier than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", +"type": "string" }, -"starlightInfo": { -"$ref": "CloudsearchSuggestResponseDebugInfoStarlightInfo" +"operatorName": { +"description": "Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:* show results only where the value of the *closeDate* property matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", +"type": "string" } }, "type": "object" }, -"CloudsearchSuggestResponseDebugInfoCompleteServerInfo": { -"id": "CloudsearchSuggestResponseDebugInfoCompleteServerInfo", +"DatePropertyOptions": { +"description": "The options for date properties.", +"id": "DatePropertyOptions", "properties": { -"completeserverHostname": { -"type": "string" -}, -"psuggestDoNotCache": { -"type": "boolean" +"operatorOptions": { +"$ref": "DateOperatorOptions", +"description": "If set, describes how the date should be used as a search operator." +} }, -"request": { -"$ref": "SuggestSuggestRequest" +"type": "object" }, -"results": { +"DateValues": { +"description": "List of date values.", +"id": "DateValues", +"properties": { +"values": { "items": { -"$ref": "CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult" +"$ref": "Date" }, "type": "array" -}, -"starlightHostname": { -"type": "string" } }, "type": "object" }, -"CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult": { -"id": "CloudsearchSuggestResponseDebugInfoCompleteServerInfoSuggestResult", +"DebugOptions": { +"description": "Shared request debug options for all cloudsearch RPC methods.", +"id": "DebugOptions", "properties": { -"suggestedQuery": { -"type": "string" -}, -"suggestionType": { -"enum": [ -"UNKNOWN", -"GMAIL_SUBJECT", -"CONTACT", -"PERSON", -"GMAIL_LABEL", -"DRIVE_TITLE", -"GMAIL_OPERATOR", -"QUERY_PREFIX", -"GMAIL_QUERY", -"WEB_QUERY", -"YOUTUBE_QUERY", -"MAPS_QUERY", -"MAPS_FEATURE", -"MAPS_PLACE_LIST", -"PHOTO_PERSON", -"PHOTO_PLACE", -"PHOTO_THING", -"PHOTO_ALBUM", -"PHOTO_DATE", -"PHOTO_APP_PAGE", -"PHOTO_OTHER", -"PHOTO_MEDIA_TYPE", -"GENERIC_QUERY", -"PHOTO_CAMERA", -"CHROME_HISTORY", -"DEVICE_CONTACT", -"CONTACT_GROUP", -"IMAGE_QUERY", -"LAST_URL", -"SERP_CLICK", -"PLAY_STORE_QUERY", -"PODCASTS_QUERY", -"CHAT_QUERY", -"DRIVE_QUERY", -"CALENDAR_QUERY", -"TOPAZ_QUERY", -"SHOPPING_QUERY", -"WEB_MAPS_FEATURE", -"LENS_QUERY", -"IGA_HISTORY", -"EXPERIMENTAL_QUERY" -], -"enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"", -"The original query prefix.", -"", -"Personalized web query.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Contact label.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"" -], -"type": "string" +"enableDebugging": { +"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.", +"type": "boolean" } }, "type": "object" }, -"CloudsearchSuggestResponseDebugInfoStarlightInfo": { -"id": "CloudsearchSuggestResponseDebugInfoStarlightInfo", +"DebugResponse": { +"description": "Debug Search Response.", +"id": "DebugResponse", "properties": { -"compareRankingsScore": { -"description": "Position-weighted measurement of the difference between the two result sets. See go/search-experiments-glossary - CR Score.", -"format": "double", -"type": "number" -}, -"starlightHostname": { +"gsrRequest": { +"description": "Serialized string of GenericSearchRequest.", +"format": "byte", "type": "string" }, -"suggestResults": { -"description": "List of suggestion results returned from Starlight for dark launch.", -"items": { -"$ref": "CloudsearchSuggestResult" +"gsrResponse": { +"description": "Serialized string of GenericSearchResponse.", +"format": "byte", +"type": "string" }, -"type": "array" +"searchResponse": { +"$ref": "SearchResponse", +"description": "Search response." } }, "type": "object" }, -"CloudsearchSuggestResult": { -"description": "One suggestion result. next_id: 16", -"id": "CloudsearchSuggestResult", +"DeleteQueueItemsRequest": { +"id": "DeleteQueueItemsRequest", "properties": { -"encryptedResultDebugId": { +"connectorName": { +"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", "type": "string" }, -"extension": { -"$ref": "MessageSet" +"debugOptions": { +"$ref": "DebugOptions", +"description": "Common debug options." +}, +"queue": { +"description": "The name of a queue to delete items from.", +"type": "string" +} }, -"filterSuggestion": { -"$ref": "CloudsearchFilterSuggestion" +"type": "object" }, -"matchedTextInQueryInfo": { -"description": "Indicates the matches between the suggestion and the user's query. For example, if the user types \"isac xx\" and the returned suggestion is \"Isaac Elias\" then the match is on the token \"isaac\" after spell correction. Note that \"isac\" in user's query matched with \"isaac\" in the suggestion because of spell correction. Also note that spell correction may or may not happen. In this example, matched_text_in_query_info.size() is 1, matched_text_in_query_info(0).snippet() is \"isaac\", matched_text_in_query_info(0).match_ranges().start() is 0 and matched_text_in_query_info(0).match_ranges().end() is 5.", -"items": { -"$ref": "CloudsearchSnippet" +"DisplayedProperty": { +"description": "A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown.", +"id": "DisplayedProperty", +"properties": { +"propertyName": { +"description": "The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error is given when attempting to update the schema.", +"type": "string" +} }, -"type": "array" +"type": "object" }, -"name": { -"description": "The name of the suggestion. This is unique identifier of the suggestion.", +"DoubleOperatorOptions": { +"description": "Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", +"id": "DoubleOperatorOptions", +"properties": { +"operatorName": { +"description": "Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", "type": "string" +} }, -"peopleSuggestion": { -"$ref": "CloudsearchPeopleSuggestion" +"type": "object" }, -"querySuggestion": { -"$ref": "CloudsearchQuerySuggestion" +"DoublePropertyOptions": { +"description": "The options for double properties.", +"id": "DoublePropertyOptions", +"properties": { +"operatorOptions": { +"$ref": "DoubleOperatorOptions", +"description": "If set, describes how the double should be used as a search operator." +} }, -"score": { -"description": "Final score returned by superroot for this suggestion.", +"type": "object" +}, +"DoubleValues": { +"description": "List of double values.", +"id": "DoubleValues", +"properties": { +"values": { +"items": { "format": "double", "type": "number" }, -"source": { -"$ref": "CloudsearchSource" +"type": "array" +} }, -"subScores": { -"$ref": "CloudsearchSuggestionScores" +"type": "object" }, -"subType": { +"DriveFollowUpRestrict": { +"description": "Drive follow-up search restricts (e.g. \"followup:suggestions\").", +"id": "DriveFollowUpRestrict", +"properties": { +"type": { "enum": [ -"NONE", -"CONTENT_TEXT_SUGGESTION", -"OPERATOR_NAME_SUGGESTION", -"OPERATOR_VALUE_SUGGESTION", -"NL_ENTITY_SUGGESTION", -"PEOPLE_SUGGESTION" +"UNSPECIFIED", +"FOLLOWUP_SUGGESTIONS", +"FOLLOWUP_ACTION_ITEMS" ], "enumDescriptions": [ "", "", -"", -"", -"", "" ], "type": "string" +} }, -"suggestedQuery": { -"description": "The suggested query that will be used for search, when the user clicks on the suggestion", -"type": "string" +"type": "object" }, -"suggestionOrigin": { +"DriveLocationRestrict": { +"description": "Drive location search restricts (e.g. \"is:starred\").", +"id": "DriveLocationRestrict", +"properties": { +"type": { "enum": [ -"DEFAULT", -"HISTORY", -"SEARCH_OPERATOR" +"UNSPECIFIED", +"TRASHED", +"STARRED" ], "enumDescriptions": [ -"Suggestion with default type.", -"Personal query history.", -"Suggestion is from search operator index." +"", +"", +"" ], "type": "string" +} +}, +"type": "object" }, +"DriveMimeTypeRestrict": { +"description": "Drive mime-type search restricts (e.g. \"type:pdf\").", +"id": "DriveMimeTypeRestrict", +"properties": { "type": { "enum": [ -"UNKNOWN", -"QUERY_HISTORY", -"SOURCE_CONTENT", -"PEOPLE", -"FILTER", -"GROUP", -"USER_QUERY" +"UNSPECIFIED", +"PDF", +"DOCUMENT", +"PRESENTATION", +"SPREADSHEET", +"FORM", +"DRAWING", +"SCRIPT", +"MAP", +"IMAGE", +"AUDIO", +"VIDEO", +"FOLDER", +"ARCHIVE", +"SITE" ], "enumDescriptions": [ -"Type is not known.", -"Suggestion from user search history.", -"Suggestion from content/source.", -"Suggestion is a person.", -"Suggestion is a filter.", -"Suggestion is a group.", -"User's own query returned as a suggestion" +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" ], "type": "string" } }, "type": "object" }, -"CloudsearchSuggestionScores": { -"description": "Signals that contribute to the final score.", -"id": "CloudsearchSuggestionScores", +"DriveTimeSpanRestrict": { +"description": "The time span search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").", +"id": "DriveTimeSpanRestrict", "properties": { -"completeServerInternalScores": { -"$ref": "CloudsearchSuggestionScoresCompleteServerInternalScores" +"type": { +"enum": [ +"UNSPECIFIED", +"TODAY", +"YESTERDAY", +"LAST_7_DAYS", +"LAST_30_DAYS", +"LAST_90_DAYS" +], +"enumDescriptions": [ +"", +"", +"", +"", +"Not Enabled", +"Not Enabled" +], +"type": "string" +} }, -"completeserverInternalScores": { -"$ref": "CloudsearchSuggestionScoresInternalScores" +"type": "object" }, -"personalizedBoost": { -"description": "How frequent is the suggestion within this user.", -"format": "float", -"type": "number" +"EmailAddress": { +"description": "A person's email address.", +"id": "EmailAddress", +"properties": { +"customType": { +"description": "If the value of type is custom, this property contains the custom type string.", +"type": "string" }, -"popularity": { -"description": "How popular is the suggestion among all users.", -"format": "float", -"type": "number" +"emailAddress": { +"description": "The email address.", +"type": "string" }, -"sectionBoost": { -"description": "Amount by which a section is boosted based on heuristics.", -"format": "float", -"type": "number" +"emailUrl": { +"description": "The URL to send email.", +"type": "string" }, -"sourceScaleFactor": { -"description": "Scale factor of the datasource its coming from.", -"format": "float", -"type": "number" +"primary": { +"description": "Indicates if this is the user's primary email. Only one entry can be marked as primary.", +"type": "boolean" }, -"starlightInternalScores": { -"$ref": "CloudsearchSuggestionScoresInternalScores" +"type": { +"description": "The type of the email account. Acceptable values are: \"custom\", \"home\", \"other\", \"work\".", +"type": "string" } }, "type": "object" }, -"CloudsearchSuggestionScoresCompleteServerInternalScores": { -"id": "CloudsearchSuggestionScoresCompleteServerInternalScores", +"EnterpriseTopazFrontendTeamsLink": { +"id": "EnterpriseTopazFrontendTeamsLink", "properties": { -"contactsGroup": { -"description": "Contacts group score (i.e. if the string is a name of a group).", -"format": "float", -"type": "number" +"type": { +"description": "The identifying link type", +"type": "string" }, -"emailAutocompleteScore": { -"description": "Score for email autocomplete. Corresponds to DAS affinity PERSONAL_SUGGEST_EMAIL_AUTOCOMPLETE_SCORE.", -"format": "float", -"type": "number" -}, -"focusOutboundEmailCount": { -"description": "Outbound email count as read from FBS.", -"format": "float", -"type": "number" -}, -"gmailHistory": { -"description": "Frequency based score of a query from the user's gmail search history", -"format": "float", -"type": "number" -}, -"gmailHistoryMediumTermQueryTime": { -"format": "float", -"type": "number" -}, -"gmailHistoryShortTermQueryTime": { -"description": "Both the gmail query_time scores below are based on the time of the last query event. Basically the score is (query_time - (model_time - PERIOD)) / PERIOD Where PERIOD is 1 & 14 days for short and medium term.", -"format": "float", -"type": "number" -}, -"gmailLabel": { -"description": "Gmail label score, as received from Gmail through PbUI.", -"format": "float", -"type": "number" -}, -"gmailOperator": { -"description": "Score for gmail operators.", -"format": "float", -"type": "number" -}, -"gmailText": { -"description": "Score for text entities extracted from gmail subjects.", -"format": "float", -"type": "number" -}, -"matchScore": { -"description": "The score of the match. The score is in the range [0, num_matching_tokens]. This means that a query with many tokens can have matches with higher score.", -"format": "double", -"type": "number" -}, -"score": { -"description": "Final score from CompleteServer. This either corresponds to Starlight score or Muppet score (for Generic Suggest suggestions) based on the CompleteServer backend. This is a combination of query dependent and independent components. The scores related to suggestion types like email_autocomplete_score & gmail_text are query independent whereas the match_score is query dependent.", -"format": "double", -"type": "number" -} -}, -"type": "object" -}, -"CloudsearchSuggestionScoresInternalScores": { -"description": "Internal scores from CompleteServer/Starlight. NOTE: This proto message is also being used for storing scores from calling Starlight directly instead from CompleteServer.", -"id": "CloudsearchSuggestionScoresInternalScores", -"properties": { -"contactsGroup": { -"description": "Contacts group score (i.e. if the string is a name of a group).", -"format": "float", -"type": "number" -}, -"emailAutocompleteScore": { -"description": "Score for email autocomplete. Corresponds to DAS affinity PERSONAL_SUGGEST_EMAIL_AUTOCOMPLETE_SCORE.", -"format": "float", -"type": "number" -}, -"focusOutboundEmailCount": { -"description": "Outbound email count as read from FBS.", -"format": "float", -"type": "number" -}, -"gmailHistory": { -"description": "Frequency based score of a query from the user's gmail search history", -"format": "float", -"type": "number" -}, -"gmailHistoryMediumTermQueryTime": { -"format": "float", -"type": "number" -}, -"gmailHistoryShortTermQueryTime": { -"description": "Both the gmail query_time scores below are based on the time of the last query event. Basically the score is (query_time - (model_time - PERIOD)) / PERIOD Where PERIOD is 1 & 14 days for short and medium term.", -"format": "float", -"type": "number" -}, -"gmailLabel": { -"description": "Gmail label score, as received from Gmail through PbUI.", -"format": "float", -"type": "number" -}, -"gmailOperator": { -"description": "Score for gmail operators.", -"format": "float", -"type": "number" -}, -"gmailText": { -"description": "Score for text entities extracted from gmail subjects.", -"format": "float", -"type": "number" -}, -"matchScore": { -"description": "The score of the match. The score is in the range [0, num_matching_tokens]. This means that a query with many tokens can have matches with higher score.", -"format": "double", -"type": "number" -}, -"score": { -"description": "Final score from CompleteServe / Starlight. This either corresponds to Starlight score or Muppet score (for Generic Suggest suggestions) based on the CompleteServer backend. This is a combination of query dependent and independent components. The scores related to suggestion types like email_autocomplete_score & gmail_text are query independent whereas the match_score is query dependent.", -"format": "double", -"type": "number" -} +"url": { +"$ref": "SafeUrlProto" +} }, "type": "object" }, -"CloudsearchValue": { -"description": "Definition of a single value with generic type. LINT.IfChange", -"id": "CloudsearchValue", +"EnterpriseTopazFrontendTeamsPersonCorePhoneNumber": { +"id": "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber", "properties": { -"booleanValue": { -"type": "boolean" -}, -"dateValue": { -"$ref": "Date" -}, -"doubleValue": { -"format": "double", -"type": "number" -}, -"integerValue": { -"format": "int64", -"type": "string" -}, -"stringValue": { -"type": "string" -}, -"timestampValue": { -"format": "google-datetime", +"phoneNumber": { +"description": "Phone number in no particular format (as comes from the Focus profile).", "type": "string" -} }, -"type": "object" +"phoneUrl": { +"$ref": "SafeUrlProto", +"description": "Phone number URL" }, -"CompositeFilter": { -"id": "CompositeFilter", -"properties": { -"logicOperator": { -"description": "The logic operator of the sub filter.", +"type": { "enum": [ -"AND", -"OR", -"NOT" +"UNKNOWN", +"MOBILE", +"OFFICE", +"OTHER" ], "enumDescriptions": [ -"Logical operators, which can only be applied to sub filters.", "", -"NOT can only be applied on a single sub filter." +"", +"", +"" ], "type": "string" -}, -"subFilters": { -"description": "Sub filters.", -"items": { -"$ref": "Filter" -}, -"type": "array" } }, "type": "object" }, -"Content": { -"id": "Content", +"EnterpriseTopazSidekickAgendaEntry": { +"description": "An AgendaEntry, e.g., a Calendar Event.", +"id": "EnterpriseTopazSidekickAgendaEntry", "properties": { -"actions": { -"description": "[Optional] Actions for this card.", -"items": { -"$ref": "Action" -}, -"type": "array" -}, -"description": { -"$ref": "SafeHtmlProto", -"description": "[Optional] Description of the card." -}, -"subtitle": { -"$ref": "BackgroundColoredText", -"description": "[Optional] Subtitle of the card." +"agendaItemUrl": { +"description": "URL of the agenda item.", +"type": "string" }, -"title": { -"$ref": "BackgroundColoredText", -"description": "[Optional] Title of the card." -} +"chronology": { +"description": "The chronology from the present.", +"enum": [ +"STALE", +"ALL_DAY", +"PAST", +"RECENTLY_PAST", +"PRESENT", +"NEAR_FUTURE", +"FUTURE" +], +"enumDescriptions": [ +"Stale.", +"All day.", +"Past.", +"Recently past.", +"Present.", +"Near future.", +"Future." +], +"type": "string" }, -"type": "object" +"creator": { +"$ref": "EnterpriseTopazSidekickPerson", +"description": "Person who created the event." }, -"Context": { -"id": "Context", -"properties": { -"app": { -"description": "[Optional] App where the card should be shown. If missing, the card will be shown in TOPAZ.", -"items": { +"currentUserAttendingStatus": { +"description": "Attendance status for the current user making the request. This is a convenience data member in order to avoid figuring out the same by iterating the invitee list above on the caller side.", "enum": [ -"UNKNOWN_APP", -"TOPAZ", -"MOMA" +"AWAITING", +"YES", +"NO", +"MAYBE" ], "enumDescriptions": [ -"", -"", -"" +"Awaiting for the user to set the status.", +"Attending.", +"Not attending.", +"Tentatively attending." ], "type": "string" }, -"type": "array" +"description": { +"description": "Description of the agenda item (i.e., typically, summary in calendar event).", +"type": "string" }, -"dayOfWeek": { -"description": "[Optional] Day of week when the card should be shown, where 0 is Monday.", +"document": { +"description": "Items related to the current AgendaEntry. E.g., related drive/mail/groups documents.", "items": { -"format": "int32", -"type": "integer" +"$ref": "EnterpriseTopazSidekickCommonDocument" }, "type": "array" }, -"endDateSec": { -"description": "[Optional] Date (in seconds since epoch) when the card should stop being shown. If missing, end_date_sec will be set to Jan 1st, 2100.", -"format": "int64", +"endDate": { +"description": "End date \"Friday, August 26\" in the user's timezone.", "type": "string" }, -"endDayOffsetSec": { -"description": "[Optional] End time in seconds, within a day, when the card should stop being shown if it's within [start_date_sec, end_date_sec]. If missing, this is set to 86400 (24 hours x 3600 sec/hour), i.e., midnight next day.", +"endTime": { +"description": "End time (HH:mm) in the user's timezone.", +"type": "string" +}, +"endTimeMs": { +"description": "End time in milliseconds", "format": "int64", "type": "string" }, -"locale": { -"description": "[Optional] The locales for which the card should be triggered (e.g., en_US and en_CA). If missing, the card is going to show to clients regardless of their locale.", -"items": { +"eventId": { +"description": "Event id provided by Calendar API.", "type": "string" }, -"type": "array" +"guestsCanInviteOthers": { +"description": "Whether the guests can invite other guests.", +"type": "boolean" }, -"location": { -"description": "[Optional] Text-free locations where the card should be shown. This is expected to match the user's location in focus. If no location is specified, the card will be shown for any location.", -"items": { +"guestsCanModify": { +"description": "Whether the guests can modify the event.", +"type": "boolean" +}, +"guestsCanSeeGuests": { +"description": "Whether the guests of the event can be seen. If false, the user is going to be reported as the only attendee to the meeting, even though there may be more attendees.", +"type": "boolean" +}, +"hangoutId": { +"description": "Hangout meeting identifier.", "type": "string" }, -"type": "array" +"hangoutUrl": { +"description": "Absolute URL for the Hangout meeting.", +"type": "string" }, -"query": { -"description": "[Required only for Answer and RHS cards - will be ignored for Homepage] cards. It's the exact case-insensitive queries that will trigger the Answer or RHS card.", +"invitee": { +"description": "People attending the meeting.", "items": { -"type": "string" +"$ref": "EnterpriseTopazSidekickPerson" }, "type": "array" }, -"startDateSec": { -"description": "[Optional] Date (in seconds since epoch) when the card should start being shown. If missing, start_date_sec will be Jan 1st, 1970 UTC.", +"isAllDay": { +"description": "Whether the entry lasts all day.", +"type": "boolean" +}, +"lastModificationTimeMs": { +"description": "Last time the event was modified.", "format": "int64", "type": "string" }, -"startDayOffsetSec": { -"description": "[Optional] Start time in seconds, within a day, when the card should be shown if it's within [start_date_sec, end_date_sec]. If 0, the card will be shown from 12:00am on.", -"format": "int64", +"location": { +"description": "Agenda item location.", "type": "string" }, -"surface": { -"description": "[Optional] Surface where the card should be shown in. If missing, the card will be shown in any surface.", -"items": { -"enum": [ -"UNKNOWN_SURFACE", -"DESKTOP", -"ANDROID", -"IOS", -"MOBILE", -"ANY" -], -"enumDescriptions": [ -"", -"", -"", -"", -"Any mobile device.", -"" -], +"notifyToUser": { +"description": "Whether this should be notified to the user.", +"type": "boolean" +}, +"otherAttendeesExcluded": { +"description": "Whether guest list is not returned because number of attendees is too large.", +"type": "boolean" +}, +"requesterIsOwner": { +"description": "Whether the requester is the owner of the agenda entry.", +"type": "boolean" +}, +"showFullEventDetailsToUse": { +"description": "Whether the details of this entry should be displayed to the user.", +"type": "boolean" +}, +"startDate": { +"description": "Start date \"Friday, August 26\" in the user's timezone.", "type": "string" }, -"type": "array" +"startTime": { +"description": "Start time (HH:mm) in the user's timezone.", +"type": "string" }, -"type": { -"description": "[Required] Type of the card (homepage, Answer or RHS).", -"items": { -"enum": [ -"UNKNOWN_CARD_TYPE", -"HOMEPAGE_CARD", -"ANSWER_CARD", -"RHS_CARD" -], -"enumDescriptions": [ -"", -"", -"", -"" -], +"startTimeMs": { +"description": "Start time in milliseconds.", +"format": "int64", "type": "string" }, -"type": "array" +"timeZone": { +"description": "User's calendar timezone;", +"type": "string" +}, +"title": { +"description": "Title of the agenda item.", +"type": "string" } }, "type": "object" }, -"ContextAttribute": { -"description": "A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.", -"id": "ContextAttribute", +"EnterpriseTopazSidekickAgendaGroupCardProto": { +"id": "EnterpriseTopazSidekickAgendaGroupCardProto", "properties": { -"name": { -"description": "The name of the attribute. It should not be empty. The maximum length is 32 characters. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The name will be normalized (lower-cased) before being matched.", -"type": "string" -}, -"values": { -"description": "Text values of the attribute. The maximum number of elements is 10. The maximum length of an element in the array is 32 characters. The value will be normalized (lower-cased) before being matched.", +"agendaItem": { "items": { -"type": "string" +"$ref": "EnterpriseTopazSidekickAgendaItem" }, "type": "array" +}, +"context": { +"$ref": "EnterpriseTopazSidekickAgendaGroupCardProtoContext" +}, +"currentAgendaItem": { +"$ref": "EnterpriseTopazSidekickAgendaItem" } }, "type": "object" }, -"CustomerIndexStats": { -"description": "Aggregation of items by status code as of the specified date.", -"id": "CustomerIndexStats", +"EnterpriseTopazSidekickAgendaGroupCardProtoContext": { +"description": "The context that resulted in the generation of the card.", +"id": "EnterpriseTopazSidekickAgendaGroupCardProtoContext", "properties": { -"date": { -"$ref": "Date", -"description": "The date for which statistics were calculated." +"context": { +"description": "User friendly free text that describes the context of the card (e.g. \"Next meeting with Bob\"). This is largely only applicable when the card is generated from a query.", +"type": "string" }, -"itemCountByStatus": { -"description": "Number of items aggregrated by status code.", -"items": { -"$ref": "ItemCountByStatus" +"date": { +"description": "Localized free text that describes the dates represented by the card. Currently, the card will only represent a single day.", +"type": "string" }, -"type": "array" +"eventsRestrict": { +"description": "Represents restrictions applied to the events requested in the user's query.", +"enum": [ +"NONE", +"NEXT_MEETING" +], +"enumDescriptions": [ +"No specific event was requested.", +"The next meeting was requested." +], +"type": "string" } }, "type": "object" }, -"CustomerQueryStats": { -"id": "CustomerQueryStats", +"EnterpriseTopazSidekickAgendaItem": { +"id": "EnterpriseTopazSidekickAgendaItem", "properties": { -"date": { -"$ref": "Date", -"description": "The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned." +"conflictedGroup": { +"$ref": "EnterpriseTopazSidekickConflictingEventsCardProto" }, -"queryCountByStatus": { -"items": { -"$ref": "QueryCountByStatus" +"gapBefore": { +"$ref": "EnterpriseTopazSidekickGap" }, -"type": "array" +"meeting": { +"$ref": "EnterpriseTopazSidekickAgendaEntry" } }, "type": "object" }, -"CustomerSearchApplicationStats": { -"description": "Search application stats for a customer for the given date.", -"id": "CustomerSearchApplicationStats", +"EnterpriseTopazSidekickAnswerAnswerList": { +"description": "A list of answers represented as free text.", +"id": "EnterpriseTopazSidekickAnswerAnswerList", "properties": { -"count": { -"description": "The count of search applications for the date.", -"format": "int64", -"type": "string" +"labeledAnswer": { +"description": "Answers that have a corresponding label.", +"items": { +"$ref": "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer" }, -"date": { -"$ref": "Date", -"description": "The date for which search application stats were calculated." +"type": "array" +}, +"type": { +"description": "Answer type.", +"enum": [ +"UNKNOWN", +"PERSON_ADDRESS", +"PERSON_BIRTHDAY", +"PERSON_DEPARTMENT", +"PERSON_DESK_LOCATION", +"PERSON_EMAIL", +"PERSON_JOB_TITLE", +"PERSON_PHONE" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" } }, "type": "object" }, -"CustomerSessionStats": { -"id": "CustomerSessionStats", +"EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer": { +"description": "An answer with a corresponding label.", +"id": "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer", "properties": { -"date": { -"$ref": "Date", -"description": "The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned." +"answer": { +"description": "The free text answer.", +"type": "string" }, -"searchSessionsCount": { -"description": "The count of search sessions on the day", -"format": "int64", +"label": { +"description": "A localized label for the answer (e.g. \"Cell phone\" vs \"Desk phone\").", "type": "string" } }, "type": "object" }, -"CustomerSettings": { -"description": "Represents settings at a customer level.", -"id": "CustomerSettings", +"EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard": { +"description": "Contains a list of suggested queries. Allows the user to determine what natural language queries they can ask Cloud Search (e.g. \"what can I search for?\").", +"id": "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard", "properties": { -"auditLoggingSettings": { -"$ref": "AuditLoggingSettings", -"description": "Audit Logging settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." +"suggestedQueryCategory": { +"description": "A list of queries to suggest.", +"items": { +"$ref": "EnterpriseTopazSidekickAnswerSuggestedQueryCategory" }, -"vpcSettings": { -"$ref": "VPCSettings", -"description": "VPC SC settings for the customer. If update_mask is empty then this field will be updated based on UpdateCustomerSettings request." +"type": "array" } }, "type": "object" }, -"CustomerUserStats": { -"id": "CustomerUserStats", +"EnterpriseTopazSidekickAnswerSuggestedQueryCategory": { +"description": "Contains a list of suggested queries for a single category.", +"id": "EnterpriseTopazSidekickAnswerSuggestedQueryCategory", "properties": { -"date": { -"$ref": "Date", -"description": "The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned." -}, -"oneDayActiveUsersCount": { -"description": "The count of unique active users in the past one day", -"format": "int64", +"category": { +"description": "The query list category.", +"enum": [ +"UNKNOWN", +"CALENDAR", +"DOCUMENT", +"PEOPLE" +], +"enumDescriptions": [ +"Unknown.", +"Calendar based queries (e.g. \"my agenda for tomorrow\").", +"Document based queries (e.g. \"files shared with me\").", +"People based queries (e.g. \"what is x's email address?\")." +], "type": "string" }, -"sevenDaysActiveUsersCount": { -"description": "The count of unique active users in the past seven days", -"format": "int64", -"type": "string" +"isEnabled": { +"description": "Whether this category is enabled.", +"type": "boolean" }, -"thirtyDaysActiveUsersCount": { -"description": "The count of unique active users in the past thirty days", -"format": "int64", +"query": { +"description": "List of suggested queries to show the user.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"DataSource": { -"description": "Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search. ", -"id": "DataSource", +"EnterpriseTopazSidekickAssistCardProto": { +"description": "Wrapper proto for the Assist cards.", +"id": "EnterpriseTopazSidekickAssistCardProto", "properties": { -"disableModifications": { -"description": "If true, sets the datasource to read-only mode. In read-only mode, the Indexing API rejects any requests to index or delete items in this source. Enabling read-only mode does not stop the processing of previously accepted data.", -"type": "boolean" +"agendaGroupCardProto": { +"$ref": "EnterpriseTopazSidekickAgendaGroupCardProto", +"description": "Agenda group card." }, -"disableServing": { -"description": "Disable serving any search or assist results.", -"type": "boolean" +"cardMetadata": { +"$ref": "EnterpriseTopazSidekickCardMetadata", +"description": "Card metadata such as chronology and render mode of the card." }, -"displayName": { -"description": "Required. Display name of the datasource The maximum length is 300 characters.", +"cardType": { +"description": "Card type.", +"enum": [ +"UNKNOWN_TYPE", +"AGENDA", +"CHANGELISTS", +"CONFLICTING_MEETINGS", +"CREATE_NOTES_FOR_MEETING", +"CREATE_NOTES_FOR_MEETING_REQUEST", +"CUSTOMER_NEWS", +"FIND_MEETING_TIME", +"NEXT_MEETING", +"PERSONALIZED_DOCS", +"TRENDING_DOCS", +"UPCOMING_TRIP", +"SUMMARY", +"MEETINGS", +"HOMEPAGE", +"SHARE_MEETING_DOCS", +"DISCOVER_PEOPLE", +"HOMEPAGE_V3", +"AGENDA_GROUP", +"WORK_IN_PROGRESS", +"GET_AND_KEEP_AHEAD", +"GENERIC_ANSWER_CARD", +"THIRD_PARTY_ANSWER_CARD", +"DOMAIN_TRENDING_DOCS", +"TEAM_TRENDING_DOCS", +"DOCUMENT_LIST_ANSWER_CARD", +"SUGGESTED_QUERY_ANSWER_CARD", +"PERSON_ANSWER_CARD", +"RELATED_PEOPLE_ANSWER_CARD", +"PERSON_KNOWLEDGE_CARD", +"PEOPLE_SEARCH_PROMOTION_CARD" +], +"enumDeprecated": [ +false, +true, +true, +true, +true, +true, +true, +false, +true, +true, +true, +true, +true, +true, +true, +true, +true, +true, +false, +false, +false, +false, +false, +true, +true, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"The default type, an unknown card type.", +"The user's agenda for the day.", +"Changelists.", +"Any group of meetings for the day that are overlapping.", +"Create notes for a meeting specified in the request.", +"Create notes for meeting query.", +"News about your SFDC customers.", +"Find a time for two people to meet.", +"The user's next non-declined meeting.", +"Important documents for you since you have viewed them in the last month and there's some action going on.", +"Documents that are trending in your company. A TRENDING_DOCS card can be of two types: TRENDING_IN_COLLABORATORS (i.e., Stay in the Loop) and TRENDING_IN_DOMAIN (i.e., Popular Content). Use DOMAIN_TRENDING_DOCS/TEAM_TRENDING_DOCS instead.", +"An upcoming trip with all trip information along with calendar events in the destination timezone.", +"The Morning/Evening Summary Card for the next working day.", +"A meeting. When requesting meetings, the service will return a MEETING card for each meeting the user has in his agenda.", +"All cards related to the homepage (agenda, conflicting-meetings, summary, etc...). This type should no longer be used. Use HOMEPAGE_V3 instead.", +"A card to with specifics to share meeting documents with all attendees.", +"Represents a set of users that the requesting user has low affinity with.", +"All cards related to the homepage-v3 (agenda-group, WIP, etc...)", +"A group of agenda-events (meeting, conflicts)", +"The documents that you were recently working on.", +"(v3) The \"get and keep ahead\" card for today and tomorrow", +"Generic answer card.", +"Third party answer card.", +"Documents that are trending in your company/domain (i.e., Popular Content).", +"Documents that are trending in your team (i.e., Stay in the Loop).", +"Documents that match the user's query (e.g. sheets shared with me).", +"A help card that provides examples of queries the user can ask.", +"Answer card for a single person (e.g. what is x's phone number).", +"Answer card for a list of people related to the person that is the subject of the query (e.g. who reports to x).", +"Knowledge card for a single person and their related people.", +"People Search promotion card." +], "type": "string" }, -"indexingServiceAccounts": { -"description": "List of service accounts that have indexing access.", -"items": { -"type": "string" +"conflictingMeetingsCard": { +"$ref": "EnterpriseTopazSidekickConflictingEventsCardProto", +"deprecated": true, +"description": "Conflicting events card." }, -"type": "array" +"documentListCard": { +"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", +"description": "Answer card for documents that are applicable to the current query." }, -"itemsVisibility": { -"description": "This field restricts visibility to items at the datasource level. Items within the datasource are restricted to the union of users and groups included in this field. Note that, this does not ensure access to a specific item, as users need to have ACL permissions on the contained items. This ensures a high level access on the entire datasource, and that the individual items are not shared outside this visibility.", -"items": { -"$ref": "GSuitePrincipal" +"documentsWithMentions": { +"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", +"deprecated": true, +"description": "Documents with mentions." }, -"type": "array" +"findMeetingTimeCard": { +"$ref": "EnterpriseTopazSidekickFindMeetingTimeCardProto", +"description": "Find meeting time card." }, -"name": { -"description": "The name of the datasource resource. Format: datasources/{source_id}. The name is ignored when creating a datasource.", -"type": "string" +"genericAnswerCard": { +"$ref": "EnterpriseTopazSidekickGenericAnswerCard", +"description": "Generic answer card." }, -"operationIds": { -"description": "IDs of the Long Running Operations (LROs) currently running for this schema.", -"items": { -"type": "string" +"getAndKeepAheadCard": { +"$ref": "EnterpriseTopazSidekickGetAndKeepAheadCardProto", +"description": "Get and keep ahead card." }, -"type": "array" +"meeting": { +"$ref": "EnterpriseTopazSidekickAgendaEntry", +"deprecated": true, +"description": "Meeting card." }, -"returnThumbnailUrls": { -"description": "Can a user request to get thumbnail URI for Items indexed in this data source.", -"type": "boolean" +"meetingNotesCard": { +"$ref": "EnterpriseTopazSidekickMeetingNotesCardProto", +"description": "Meeting notes card." }, -"shortName": { -"description": "A short name or alias for the source. This value will be used to match the 'source' operator. For example, if the short name is ** then queries like *source:* will only return results for this source. The value must be unique across all datasources. The value must only contain alphanumeric characters (a-zA-Z0-9). The value cannot start with 'google' and cannot be one of the following: mail, gmail, docs, drive, groups, sites, calendar, hangouts, gplus, keep, people, teams. Its maximum length is 32 characters.", -"type": "string" -} +"meetingNotesCardRequest": { +"$ref": "EnterpriseTopazSidekickMeetingNotesCardRequest", +"description": "Request for meeting notes card." }, -"type": "object" +"peopleDisambiguationCard": { +"$ref": "EnterpriseTopazSidekickPeopleDisambiguationCard", +"description": "The people disambiguation card." }, -"DataSourceIndexStats": { -"description": "Aggregation of items by status code as of the specified date.", -"id": "DataSourceIndexStats", -"properties": { -"date": { -"$ref": "Date", -"description": "The date for which index stats were calculated. If the date of request is not the current date then stats calculated on the next day are returned. Stats are calculated close to mid night in this case. If date of request is current date, then real time stats are returned." +"peoplePromotionCard": { +"$ref": "PeoplePromotionCard", +"description": "People Search promotion card." }, -"itemCountByStatus": { -"description": "Number of items aggregrated by status code.", -"items": { -"$ref": "ItemCountByStatus" +"personAnswerCard": { +"$ref": "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard", +"description": "Answer card that represents a single person." }, -"type": "array" -} +"personProfileCard": { +"$ref": "EnterpriseTopazSidekickPersonProfileCard", +"description": "Full profile card." }, -"type": "object" +"personalizedDocsCard": { +"$ref": "EnterpriseTopazSidekickPersonalizedDocsCardProto", +"deprecated": true, +"description": "Card with recommended documents for the user." }, -"DataSourceRestriction": { -"description": "Restriction on Datasource.", -"id": "DataSourceRestriction", -"properties": { -"filterOptions": { -"description": "Filter options restricting the results. If multiple filters are present, they are grouped by object type before joining. Filters with the same object type are joined conjunctively, then the resulting expressions are joined disjunctively. The maximum number of elements is 20. NOTE: Suggest API supports only few filters at the moment: \"objecttype\", \"type\" and \"mimetype\". For now, schema specific filters cannot be used to filter suggestions.", -"items": { -"$ref": "FilterOptions" +"relatedPeopleAnswerCard": { +"$ref": "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard", +"description": "Answer card that represents a list of people related to a person." }, -"type": "array" +"shareMeetingDocsCard": { +"$ref": "EnterpriseTopazSidekickShareMeetingDocsCardProto", +"deprecated": true, +"description": "Sahre meeting docs card." }, -"source": { -"$ref": "Source", -"description": "The source of restriction." +"sharedDocuments": { +"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", +"deprecated": true, +"description": "Shared documents." +}, +"suggestedQueryAnswerCard": { +"$ref": "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard", +"description": "Answer card for what natural language queries the user can ask." +}, +"thirdPartyAnswerCard": { +"$ref": "ThirdPartyGenericCard", +"description": "Third party answer cards." +}, +"workInProgressCardProto": { +"$ref": "EnterpriseTopazSidekickRecentDocumentsCardProto", +"description": "Work In Progress card." } }, "type": "object" }, -"Date": { -"description": "Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.", -"id": "Date", +"EnterpriseTopazSidekickCardMetadata": { +"description": "Card metadata.", +"id": "EnterpriseTopazSidekickCardMetadata", "properties": { -"day": { -"description": "Day of month. Must be from 1 to 31 and valid for the year and month.", -"format": "int32", -"type": "integer" -}, -"month": { -"description": "Month of date. Must be from 1 to 12.", -"format": "int32", -"type": "integer" -}, -"year": { -"description": "Year of date. Must be from 1 to 9999.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"DateOperatorOptions": { -"description": "Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", -"id": "DateOperatorOptions", -"properties": { -"greaterThanOperatorName": { -"description": "Indicates the operator name required in the query in order to isolate the date property using the greater-than operator. For example, if greaterThanOperatorName is *closedafter* and the property's name is *closeDate*, then queries like *closedafter:* show results only where the value of the property named *closeDate* is later than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", +"cardCategory": { +"description": "Declares a preference for how this card should be packed in MSCR. All cards in a response must correspond to a single category. As a result, cards may be dropped from the response if this field is set. Any card that does not match the category of the card with the highest priority in the response will be dropped.", +"enum": [ +"DEFAULT", +"ANSWER", +"KNOWLEDGE", +"HOMEPAGE" +], +"enumDescriptions": [ +"Let MSCR decide how this card should be packed. Most cards should choose this type. This type should largely be considered equivalent to ANSWER. However, this is not guaranteed to be the case as the request to MSCR may override the static configuration.", +"This card should be rendered as an answer card.", +"This card should be rendered as a knowledge card (a non-organic result).", +"This card should be rendered in the Homepage." +], "type": "string" }, -"lessThanOperatorName": { -"description": "Indicates the operator name required in the query in order to isolate the date property using the less-than operator. For example, if lessThanOperatorName is *closedbefore* and the property's name is *closeDate*, then queries like *closedbefore:* show results only where the value of the property named *closeDate* is earlier than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", +"cardId": { +"description": "An ID to identify the card and match actions to it. Be thoughtful of new card IDs since actions will be associated to that ID. E.g., if two card IDs collide, the system will think that the actions have been applied to the same card. Similarly, if EAS can return multiple cards of the same type (e.g., Meetings), ensure that the card_id identifies a given instance of the card so that, e.g., dismissals only affect the dismissed card as opposed to affecting all meeting cards.", "type": "string" }, -"operatorName": { -"description": "Indicates the actual string required in the query in order to isolate the date property. For example, suppose an issue tracking schema object has a property named *closeDate* that specifies an operator with an operatorName of *closedon*. For searches on that data, queries like *closedon:* show results only where the value of the *closeDate* property matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the indexed datasource. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", +"chronology": { +"description": "Chronology.", +"enum": [ +"UNKNOWN", +"PAST", +"RECENTLY_PAST", +"PRESENT", +"NEAR_FUTURE", +"FUTURE" +], +"enumDescriptions": [ +"Unknown chronology (default).", +"Past.", +"Recently past.", +"Present.", +"Near future.", +"Future." +], "type": "string" -} -}, -"type": "object" -}, -"DatePropertyOptions": { -"description": "The options for date properties.", -"id": "DatePropertyOptions", -"properties": { -"operatorOptions": { -"$ref": "DateOperatorOptions", -"description": "If set, describes how the date should be used as a search operator." -} -}, -"type": "object" }, -"DateValues": { -"description": "List of date values.", -"id": "DateValues", -"properties": { -"values": { -"items": { -"$ref": "Date" +"debugInfo": { +"description": "Debug info (only reported if request's debug_level > 0).", +"type": "string" }, -"type": "array" -} +"nlpMetadata": { +"$ref": "EnterpriseTopazSidekickNlpMetadata", +"description": "Information about the NLP done to get the card." }, -"type": "object" +"rankingParams": { +"$ref": "EnterpriseTopazSidekickRankingParams", +"description": "Ranking params." }, -"DebugOptions": { -"description": "Shared request debug options for all cloudsearch RPC methods.", -"id": "DebugOptions", -"properties": { -"enableDebugging": { -"description": "If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.", -"type": "boolean" +"renderMode": { +"description": "Render mode.", +"enum": [ +"UNKNOWN_RENDER", +"COLLAPSED", +"EXPANDED" +], +"enumDescriptions": [ +"Unknown mode (default).", +"Collapsed.", +"Expanded." +], +"type": "string" } }, "type": "object" }, -"DebugResponse": { -"description": "Debug Search Response.", -"id": "DebugResponse", +"EnterpriseTopazSidekickCommonDebugInfo": { +"description": "Container of debugging information in all object levels. Extend as needed.", +"id": "EnterpriseTopazSidekickCommonDebugInfo", "properties": { -"gsrRequest": { -"description": "Serialized string of GenericSearchRequest.", -"format": "byte", -"type": "string" -}, -"gsrResponse": { -"description": "Serialized string of GenericSearchResponse.", -"format": "byte", +"message": { +"description": "Debug message.", "type": "string" -}, -"searchResponse": { -"$ref": "SearchResponse", -"description": "Search response." } }, "type": "object" }, -"DefaultBlockingDataProto": { -"description": "Next ID: 3", -"id": "DefaultBlockingDataProto", +"EnterpriseTopazSidekickCommonDocument": { +"description": "Representation of a document. NEXT_TAG: 15", +"id": "EnterpriseTopazSidekickCommonDocument", "properties": { -"types": { -"items": { +"accessType": { +"description": "Access type, i.e., whether the user has access to the document or not.", "enum": [ -"BLOCKING_TYPE_UNSPECIFIED", -"BLOCKING_TYPE_DEFAULT_BLOCKED", -"BLOCKING_TYPE_DEFAULT_BLOCKED_NON_TYPE_COUNTRY" +"UNKNOWN_ACCESS", +"ALLOWED", +"NOT_ALLOWED" ], "enumDescriptions": [ -"The default value. Not actually used by IPGeo/Oolong.", -"Under go/embargo.", -"A feature that is not a TYPE_COUNTRY and is under go/embargo. Discouraged." +"Unknown access type.", +"Access allowed.", +"Access not allowed." ], "type": "string" }, -"type": "array" -}, -"version": { -"description": "Version ID of the current list of blocked countries and sanctions areas, based on which the types field was computed.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" +"debugInfo": { +"$ref": "EnterpriseTopazSidekickCommonDebugInfo", +"description": "Information for debugging." }, -"DeleteQueueItemsRequest": { -"id": "DeleteQueueItemsRequest", -"properties": { -"connectorName": { -"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", +"documentId": { +"description": "Document id.", "type": "string" }, -"debugOptions": { -"$ref": "DebugOptions", -"description": "Common debug options." +"driveDocumentMetadata": { +"$ref": "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata", +"description": "Drive document metadata." }, -"queue": { -"description": "The name of a queue to delete items from.", +"genericUrl": { +"description": "Generic Drive-based url in the format of drive.google.com/open to be used for deeplink", "type": "string" -} }, -"type": "object" +"justification": { +"$ref": "EnterpriseTopazSidekickCommonDocumentJustification", +"description": "Justification on why the document is selected." }, -"DisabledIcingPackageCorpus": { -"id": "DisabledIcingPackageCorpus", -"properties": { -"corpusName": { -"description": "The name of an individual corpus within the given app. When unset, this means that all corpora for the given package are disabled.", +"mimeType": { +"description": "MIME type", "type": "string" }, -"packageName": { -"description": "The package name of an app that the user disabled. This is required.", +"provenance": { +"deprecated": true, +"description": "Document provenance.", +"enum": [ +"UNKNOWN_PROVENANCE", +"CALENDAR_DESCRIPTION", +"CALENDAR_ATTACHMENT", +"MINED", +"CALENDAR_ASSIST_ATTACHMENT" +], +"enumDescriptions": [ +"Unknown provenance.", +"Calendar event description.", +"Calendar event attachment.", +"Mined (extracted by some offline/online analysis).", +"Attachment created by enterprise assist." +], "type": "string" -} -}, -"type": "object" }, -"DisplayedProperty": { -"description": "A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown.", -"id": "DisplayedProperty", -"properties": { -"propertyName": { -"description": "The name of the top-level property as defined in a property definition for the object. If the name is not a defined property in the schema, an error is given when attempting to update the schema.", +"reason": { +"deprecated": true, +"description": "Justification of why this document is being returned.", +"enum": [ +"UNKNOWN", +"TRENDING_IN_COLLABORATORS", +"TRENDING_IN_DOMAIN", +"FREQUENTLY_VIEWED", +"FREQUENTLY_EDITED", +"NEW_UPDATES", +"NEW_COMMENTS", +"EVENT_DESCRIPTION", +"EVENT_ATTACHMENT", +"EVENT_METADATA_ATTACHMENT", +"MINED_DOCUMENT", +"NEW_MENTIONS", +"NEW_SHARES" +], +"enumDescriptions": [ +"Unknown justification.", +"Popular documents within collaborators.", +"Popular documents within the domain.", +"Documents being reviewed frequently by the current user .", +"Documents being edited frequently by the current user .", +"Documents updated since user's last visit.", +"Documents that receive comments since user's last visit.", +"Documents in the calendar event description.", +"Documents in the calendar event attachments section.", +"Documents attached in calendar event metadata instead of the attachment section. Event metadata is not visible to the final user. Enterprise assist uses this metadata to store auto-generated documents such as meeting notes.", +"Documents mined, and so, probably related to the request context. For example, this category includes documents related to a meeting.", +"Documents that contains mentions of the user.", +"Documents that are shared with the user." +], "type": "string" -} }, -"type": "object" +"snippet": { +"description": "A sampling of the text from the document.", +"type": "string" }, -"DoubleOperatorOptions": { -"description": "Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", -"id": "DoubleOperatorOptions", -"properties": { -"operatorName": { -"description": "Indicates the operator name required in the query in order to use the double property in sorting or as a facet. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", +"thumbnailUrl": { +"description": "Thumbnail URL.", "type": "string" -} }, -"type": "object" +"title": { +"description": "Title of the document.", +"type": "string" }, -"DoublePropertyOptions": { -"description": "The options for double properties.", -"id": "DoublePropertyOptions", -"properties": { -"operatorOptions": { -"$ref": "DoubleOperatorOptions", -"description": "If set, describes how the double should be used as a search operator." -} -}, -"type": "object" -}, -"DoubleValues": { -"description": "List of double values.", -"id": "DoubleValues", -"properties": { -"values": { -"items": { -"format": "double", -"type": "number" -}, -"type": "array" -} -}, -"type": "object" -}, -"DriveFollowUpRestrict": { -"description": "Drive follow-up search restricts (e.g. \"followup:suggestions\").", -"id": "DriveFollowUpRestrict", -"properties": { -"type": { -"enum": [ -"UNSPECIFIED", -"FOLLOWUP_SUGGESTIONS", -"FOLLOWUP_ACTION_ITEMS" -], -"enumDescriptions": [ -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"DriveLocationRestrict": { -"description": "Drive location search restricts (e.g. \"is:starred\").", -"id": "DriveLocationRestrict", -"properties": { -"type": { -"enum": [ -"UNSPECIFIED", -"TRASHED", -"STARRED" -], -"enumDescriptions": [ -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"DriveMimeTypeRestrict": { -"description": "Drive mime-type search restricts (e.g. \"type:pdf\").", -"id": "DriveMimeTypeRestrict", -"properties": { "type": { +"description": "Type of the document.", "enum": [ -"UNSPECIFIED", -"PDF", +"UNKNOWN", "DOCUMENT", "PRESENTATION", "SPREADSHEET", -"FORM", -"DRAWING", -"SCRIPT", -"MAP", +"PDF", "IMAGE", -"AUDIO", -"VIDEO", +"BINARY_BLOB", +"FUSION_TABLE", "FOLDER", -"ARCHIVE", -"SITE" +"DRAWING", +"VIDEO", +"FORM", +"LINK_URL", +"LINK_GO", +"LINK_GOO_GL", +"LINK_BIT_LY", +"LINK_GMAIL", +"LINK_MAILTO", +"VIDEO_YOUTUBE", +"VIDEO_LIVE", +"GROUPS", +"NEWS", +"SITES", +"HANGOUT", +"AUDIO", +"MS_WORD", +"MS_POWERPOINT", +"MS_EXCEL", +"MS_OUTLOOK" ], "enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", +"If the type is unknown or not represented in this enum.", +"Drive document types Writely, Word, etc.", +"Presently, PowerPoint, etc.", +"Trix, Excel, etc.", +"File types for Gdrive objects are below. PDF.", +"Image.", +"Fall-back for unknown Gdrive types.", +"Fusion table.", +"Folder.", +"Drawing.", +"Video.", +"Form.", +"Link formats uncategorized URL links", +"meaningful links that should be renderred specifically", +"Link to goo.gl.", +"Link to bit_ly.", +"Link to Gmail.", +"Mailto link.", +"Videos Youtube videos.", +"Live streams (e.g., liveplayer.googleplex.com)", +"Other types. Google Groups.", +"Google News.", +"Google Sites.", +"Google Hangout.", +"Audio files.", +"Microsoft-specific file types.", "", "", "" ], "type": "string" -} -}, -"type": "object" }, -"DriveTimeSpanRestrict": { -"description": "The time span search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").", -"id": "DriveTimeSpanRestrict", -"properties": { -"type": { -"enum": [ -"UNSPECIFIED", -"TODAY", -"YESTERDAY", -"LAST_7_DAYS", -"LAST_30_DAYS", -"LAST_90_DAYS" -], -"enumDescriptions": [ -"", -"", -"", -"", -"Not Enabled", -"Not Enabled" -], +"url": { +"description": "Absolute URL of the document.", "type": "string" } }, "type": "object" }, -"EmailAddress": { -"description": "A person's email address.", -"id": "EmailAddress", +"EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata": { +"description": "Meta data for drive documents.", +"id": "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata", "properties": { -"customType": { -"description": "If the value of type is custom, this property contains the custom type string.", -"type": "string" -}, -"emailAddress": { -"description": "The email address.", -"type": "string" -}, -"emailUrl": { -"description": "The URL to send email.", +"documentId": { +"deprecated": true, +"description": "The drive document cosmo id. Client could use the id to build a URL to open a document. Please use Document.document_id.", "type": "string" }, -"primary": { -"description": "Indicates if this is the user's primary email. Only one entry can be marked as primary.", +"isPrivate": { +"description": "Additional field to identify whether a document is private since scope set to LIMITED can mean both that the doc is private or that it's shared with others. is_private indicates whether the doc is not shared with anyone except for the owner.", "type": "boolean" }, -"type": { -"description": "The type of the email account. Acceptable values are: \"custom\", \"home\", \"other\", \"work\".", +"lastCommentTimeMs": { +"description": "Timestamp of the most recent comment added to the document in milliseconds since epoch.", +"format": "uint64", "type": "string" -} -}, -"type": "object" }, -"EnterpriseTopazFrontendTeamsLink": { -"id": "EnterpriseTopazFrontendTeamsLink", -"properties": { -"type": { -"description": "The identifying link type", +"lastEditTimeMs": { +"description": "Timestamp of the most recent edit from the current user in milliseconds since epoch.", +"format": "uint64", "type": "string" }, -"url": { -"$ref": "SafeUrlProto" -} +"lastModificationTimeMillis": { +"description": "Last modification time of the document (independent of the user that modified it).", +"format": "int64", +"type": "string" }, -"type": "object" +"lastUpdatedTimeMs": { +"description": "Timestamp of the last updated time of the document in milliseconds since epoch.", +"format": "uint64", +"type": "string" }, -"EnterpriseTopazFrontendTeamsPersonCorePhoneNumber": { -"id": "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber", -"properties": { -"phoneNumber": { -"description": "Phone number in no particular format (as comes from the Focus profile).", +"lastViewTimeMs": { +"description": "Timestamp of the most recent view from the current user in milliseconds since epoch.", +"format": "uint64", "type": "string" }, -"phoneUrl": { -"$ref": "SafeUrlProto", -"description": "Phone number URL" +"owner": { +"$ref": "EnterpriseTopazSidekickCommonPerson", +"description": "The owner of the document." }, -"type": { +"scope": { +"description": "ACL scope of the document which identifies the sharing status of the doc (e.g., limited, shared with link, team drive, ...).", "enum": [ -"UNKNOWN", -"MOBILE", -"OFFICE", -"OTHER" +"UNKNOWN_DOCUMENT_SCOPE", +"LIMITED", +"DASHER_DOMAIN_WITH_LINK", +"DASHER_DOMAIN", +"PUBLIC_WITH_LINK", +"PUBLIC", +"TEAM_DRIVE" ], "enumDescriptions": [ "", "", "", +"", +"", +"", "" ], "type": "string" @@ -4163,15062 +3792,986 @@ }, "type": "object" }, -"EnterpriseTopazSidekickAgendaEntry": { -"description": "An AgendaEntry, e.g., a Calendar Event.", -"id": "EnterpriseTopazSidekickAgendaEntry", +"EnterpriseTopazSidekickCommonDocumentJustification": { +"description": "Justification of why we are reporting the document.", +"id": "EnterpriseTopazSidekickCommonDocumentJustification", "properties": { -"agendaItemUrl": { -"description": "URL of the agenda item.", +"justification": { +"description": "A locale aware message that explains why this document was selected.", "type": "string" }, -"chronology": { -"description": "The chronology from the present.", +"reason": { +"description": "Reason on why the document is selected. Populate for trending documents.", "enum": [ -"STALE", -"ALL_DAY", -"PAST", -"RECENTLY_PAST", -"PRESENT", -"NEAR_FUTURE", -"FUTURE" +"UNKNOWN", +"TRENDING_IN_COLLABORATORS", +"TRENDING_IN_DOMAIN", +"FREQUENTLY_VIEWED", +"FREQUENTLY_EDITED", +"NEW_UPDATES", +"NEW_COMMENTS", +"EVENT_DESCRIPTION", +"EVENT_ATTACHMENT", +"EVENT_METADATA_ATTACHMENT", +"MINED_DOCUMENT", +"NEW_MENTIONS", +"NEW_SHARES" ], "enumDescriptions": [ -"Stale.", -"All day.", -"Past.", -"Recently past.", -"Present.", -"Near future.", -"Future." +"Unknown justification.", +"Popular documents within collaborators.", +"Popular documents within the domain.", +"Documents being reviewed frequently by the current user .", +"Documents being edited frequently by the current user .", +"Documents updated since user's last visit.", +"Documents that receive comments since user's last visit.", +"Documents in the calendar event description.", +"Documents in the calendar event attachments section.", +"Documents attached in calendar event metadata instead of the attachment section. Event metadata is not visible to the final user. Enterprise assist uses this metadata to store auto-generated documents such as meeting notes.", +"Documents mined, and so, probably related to the request context. For example, this category includes documents related to a meeting.", +"Documents that contains mentions of the user.", +"Documents that are shared with the user." ], "type": "string" +} }, -"creator": { -"$ref": "EnterpriseTopazSidekickPerson", -"description": "Person who created the event." +"type": "object" }, -"currentUserAttendingStatus": { -"description": "Attendance status for the current user making the request. This is a convenience data member in order to avoid figuring out the same by iterating the invitee list above on the caller side.", -"enum": [ -"AWAITING", -"YES", -"NO", -"MAYBE" -], -"enumDescriptions": [ -"Awaiting for the user to set the status.", -"Attending.", -"Not attending.", -"Tentatively attending." -], -"type": "string" +"EnterpriseTopazSidekickCommonPerson": { +"description": "Common representation of a person.", +"id": "EnterpriseTopazSidekickCommonPerson", +"properties": { +"birthday": { +"$ref": "EnterpriseTopazSidekickCommonPersonBirthday", +"description": "The birthday." }, -"description": { -"description": "Description of the agenda item (i.e., typically, summary in calendar event).", +"cellPhone": { +"description": "Cell phone number.", "type": "string" }, -"document": { -"description": "Items related to the current AgendaEntry. E.g., related drive/mail/groups documents.", -"items": { -"$ref": "EnterpriseTopazSidekickCommonDocument" -}, -"type": "array" -}, -"endDate": { -"description": "End date \"Friday, August 26\" in the user's timezone.", +"department": { +"description": "The department the person works in (e.g. Engineering).", "type": "string" }, -"endTime": { -"description": "End time (HH:mm) in the user's timezone.", +"deskLocation": { +"description": "Desk location (e.g. US-MTV-PR55-5-5B1I).", "type": "string" }, -"endTimeMs": { -"description": "End time in milliseconds", -"format": "int64", +"deskPhone": { +"description": "Work desk phone number.", "type": "string" }, -"eventId": { -"description": "Event id provided by Calendar API.", +"displayName": { +"description": "The full name.", "type": "string" }, -"guestsCanInviteOthers": { -"description": "Whether the guests can invite other guests.", -"type": "boolean" -}, -"guestsCanModify": { -"description": "Whether the guests can modify the event.", -"type": "boolean" -}, -"guestsCanSeeGuests": { -"description": "Whether the guests of the event can be seen. If false, the user is going to be reported as the only attendee to the meeting, even though there may be more attendees.", -"type": "boolean" -}, -"hangoutId": { -"description": "Hangout meeting identifier.", +"email": { +"description": "Email.", "type": "string" }, -"hangoutUrl": { -"description": "Absolute URL for the Hangout meeting.", +"familyName": { +"description": "The last name.", "type": "string" }, -"invitee": { -"description": "People attending the meeting.", -"items": { -"$ref": "EnterpriseTopazSidekickPerson" -}, -"type": "array" -}, -"isAllDay": { -"description": "Whether the entry lasts all day.", -"type": "boolean" +"fullAddress": { +"description": "The fully formatted address (e.g. 1255 Pear Avenue, Mountain View 94043, United States).", +"type": "string" }, -"lastModificationTimeMs": { -"description": "Last time the event was modified.", +"gaiaId": { +"deprecated": true, +"description": "This field is deprecated. The obfuscated_id should be used instead.", "format": "int64", "type": "string" }, -"location": { -"description": "Agenda item location.", +"givenName": { +"description": "The first name.", "type": "string" }, -"notifyToUser": { -"description": "Whether this should be notified to the user.", -"type": "boolean" -}, -"otherAttendeesExcluded": { -"description": "Whether guest list is not returned because number of attendees is too large.", -"type": "boolean" -}, -"requesterIsOwner": { -"description": "Whether the requester is the owner of the agenda entry.", -"type": "boolean" +"jobTitle": { +"description": "The person's job title (e.g. Software Engineer).", +"type": "string" }, -"showFullEventDetailsToUse": { -"description": "Whether the details of this entry should be displayed to the user.", -"type": "boolean" +"manager": { +"$ref": "EnterpriseTopazSidekickCommonPerson", +"description": "The manager." }, -"startDate": { -"description": "Start date \"Friday, August 26\" in the user's timezone.", +"obfuscatedId": { +"description": "The obfuscated GAIA ID.", "type": "string" }, -"startTime": { -"description": "Start time (HH:mm) in the user's timezone.", +"photoUrl": { +"description": "The URL for the Focus profile picture.", "type": "string" }, -"startTimeMs": { -"description": "Start time in milliseconds.", -"format": "int64", +"streetAddress": { +"description": "The street address (e.g. 1255 Pear Avenue).", "type": "string" +} }, -"timeZone": { -"description": "User's calendar timezone;", -"type": "string" +"type": "object" }, -"title": { -"description": "Title of the agenda item.", +"EnterpriseTopazSidekickCommonPersonBirthday": { +"id": "EnterpriseTopazSidekickCommonPersonBirthday", +"properties": { +"value": { +"description": "Unstructured birthday.", "type": "string" } }, "type": "object" }, -"EnterpriseTopazSidekickAgendaGroupCardProto": { -"id": "EnterpriseTopazSidekickAgendaGroupCardProto", +"EnterpriseTopazSidekickConflictingEventsCardProto": { +"description": "Conflicting meetings card proto.", +"id": "EnterpriseTopazSidekickConflictingEventsCardProto", "properties": { -"agendaItem": { +"conflictingEvent": { +"description": "All the events that conflict with main_event.", "items": { -"$ref": "EnterpriseTopazSidekickAgendaItem" +"$ref": "EnterpriseTopazSidekickAgendaEntry" }, "type": "array" }, -"context": { -"$ref": "EnterpriseTopazSidekickAgendaGroupCardProtoContext" -}, -"currentAgendaItem": { -"$ref": "EnterpriseTopazSidekickAgendaItem" +"mainEvent": { +"$ref": "EnterpriseTopazSidekickAgendaEntry", +"description": "The event identified as being the most important." } }, "type": "object" }, -"EnterpriseTopazSidekickAgendaGroupCardProtoContext": { -"description": "The context that resulted in the generation of the card.", -"id": "EnterpriseTopazSidekickAgendaGroupCardProtoContext", +"EnterpriseTopazSidekickDocumentGroup": { +"description": "Represents a mapping between a document type and its corresponding documents. Use for Work in Progress card in v1 homepage.", +"id": "EnterpriseTopazSidekickDocumentGroup", "properties": { -"context": { -"description": "User friendly free text that describes the context of the card (e.g. \"Next meeting with Bob\"). This is largely only applicable when the card is generated from a query.", -"type": "string" -}, -"date": { -"description": "Localized free text that describes the dates represented by the card. Currently, the card will only represent a single day.", -"type": "string" -}, -"eventsRestrict": { -"description": "Represents restrictions applied to the events requested in the user's query.", +"groupType": { +"deprecated": true, +"description": "Document group type", "enum": [ -"NONE", -"NEXT_MEETING" +"UNKNOWN_TYPE", +"ALL" ], "enumDescriptions": [ -"No specific event was requested.", -"The next meeting was requested." +"Unknown type.", +"A mix of all the document types." ], "type": "string" +}, +"personalizedDocument": { +"description": "The list of corresponding documents.", +"items": { +"$ref": "EnterpriseTopazSidekickCommonDocument" +}, +"type": "array" } }, "type": "object" }, -"EnterpriseTopazSidekickAgendaItem": { -"id": "EnterpriseTopazSidekickAgendaItem", +"EnterpriseTopazSidekickDocumentPerCategoryList": { +"id": "EnterpriseTopazSidekickDocumentPerCategoryList", "properties": { -"conflictedGroup": { -"$ref": "EnterpriseTopazSidekickConflictingEventsCardProto" +"documents": { +"items": { +"$ref": "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry" }, -"gapBefore": { -"$ref": "EnterpriseTopazSidekickGap" +"type": "array" }, -"meeting": { -"$ref": "EnterpriseTopazSidekickAgendaEntry" -} +"helpMessage": { +"description": "Localized message explaining how the documents were derived (e.g. from the last 30 days activity). This field is optional.", +"type": "string" }, -"type": "object" +"listType": { +"enum": [ +"UNKNOWN_LIST_TYPE", +"MENTIONS", +"SHARES", +"NEEDS_ATTENTION", +"VIEWS", +"EDITS" +], +"enumDescriptions": [ +"", +"All documents in the list correspond to one of the mention categories.", +"All documents in the list correspond to one of the share categories.", +"A mixture of document categories that correspond to documents that need the users attention (e.g. documents that have been explicitly shared with the user but have not been viewed and documents where the user was mentioned but has not replied).", +"All documents in the list correspond to one of the view categories.", +"All documents in the list correspond to one of the edit categories." +], +"type": "string" }, -"EnterpriseTopazSidekickAnswerAnswerList": { -"description": "A list of answers represented as free text.", -"id": "EnterpriseTopazSidekickAnswerAnswerList", -"properties": { -"labeledAnswer": { -"description": "Answers that have a corresponding label.", -"items": { -"$ref": "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer" +"listTypeDescription": { +"description": "Description of the types of documents present in the list.", +"type": "string" }, -"type": "array" +"responseMessage": { +"description": "Response message in case no documents are present in the card.", +"type": "string" +} }, -"type": { -"description": "Answer type.", +"type": "object" +}, +"EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry": { +"id": "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry", +"properties": { +"category": { "enum": [ -"UNKNOWN", -"PERSON_ADDRESS", -"PERSON_BIRTHDAY", -"PERSON_DEPARTMENT", -"PERSON_DESK_LOCATION", -"PERSON_EMAIL", -"PERSON_JOB_TITLE", -"PERSON_PHONE" +"UNKNOWN_DOCUMENT", +"ACTIONABLE", +"VIEWED", +"REPLIED", +"MENTION_VIEWED", +"MENTION_REPLIED", +"MENTION_NOT_VIEWED", +"SHARED_AND_VIEWED", +"SHARED_NOT_VIEWED", +"EDITED" +], +"enumDeprecated": [ +false, +true, +false, +true, +false, +false, +false, +false, +false, +false ], "enumDescriptions": [ "", "", "", "", -"", -"", -"", -"" +"Mention categories. The mention has been viewed by the user, but the user has not replied.", +"The user has replied to the mention.", +"The mention has not been viewed by the user.", +"Share categories. Consists of documents that have been explicitly shared with the user. Document has been viewed.", +"Document has not been viewed.", +"Document has been edited." ], "type": "string" +}, +"document": { +"$ref": "EnterpriseTopazSidekickCommonDocument" +}, +"rationale": { +"description": "Reason this document was selected.", +"type": "string" } }, "type": "object" }, -"EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer": { -"description": "An answer with a corresponding label.", -"id": "EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer", +"EnterpriseTopazSidekickFindMeetingTimeCardProto": { +"description": "Response to find meeting time among a set of people.", +"id": "EnterpriseTopazSidekickFindMeetingTimeCardProto", "properties": { -"answer": { -"description": "The free text answer.", -"type": "string" +"commonAvailableTimeSlots": { +"description": "Slots when all attendees have availability.", +"items": { +"$ref": "EnterpriseTopazSidekickTimeSlot" }, -"label": { -"description": "A localized label for the answer (e.g. \"Cell phone\" vs \"Desk phone\").", +"type": "array" +}, +"invitees": { +"description": "Invitees to the event.", +"items": { +"$ref": "EnterpriseTopazSidekickPerson" +}, +"type": "array" +}, +"requester": { +"$ref": "EnterpriseTopazSidekickPerson", +"description": "Requester." +}, +"scheduledMeeting": { +"$ref": "EnterpriseTopazSidekickScheduledMeeting", +"description": "Details about the scheduled meeting, if one exists." +}, +"skippedInvitees": { +"description": "Invitees that have been skipped in the computation, most likely because they are groups.", +"items": { +"$ref": "EnterpriseTopazSidekickPerson" +}, +"type": "array" +}, +"timeBoundaries": { +"$ref": "EnterpriseTopazSidekickTimeSlot", +"description": "Min and max timestamp used to find a common available timeslot." +}, +"timezoneId": { +"description": "Timezone ID.", "type": "string" } }, "type": "object" }, -"EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard": { -"description": "Contains a list of suggested queries. Allows the user to determine what natural language queries they can ask Cloud Search (e.g. \"what can I search for?\").", -"id": "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard", +"EnterpriseTopazSidekickGap": { +"id": "EnterpriseTopazSidekickGap", "properties": { -"suggestedQueryCategory": { -"description": "A list of queries to suggest.", -"items": { -"$ref": "EnterpriseTopazSidekickAnswerSuggestedQueryCategory" +"displayRemainingTime": { +"description": "Localized time string in the format: 1 hour 15 minutes", +"type": "string" }, -"type": "array" +"endTime": { +"description": "Localized time string in the format:(Locale CZ) 8:30 odp.", +"type": "string" +}, +"endTimeMs": { +"format": "uint64", +"type": "string" +}, +"remainingTime": { +"format": "google-duration", +"type": "string" +}, +"startTime": { +"description": "Localized time string in the format:(Locale CZ) 8:30 odp.", +"type": "string" +}, +"startTimeMs": { +"format": "uint64", +"type": "string" } }, "type": "object" }, -"EnterpriseTopazSidekickAnswerSuggestedQueryCategory": { -"description": "Contains a list of suggested queries for a single category.", -"id": "EnterpriseTopazSidekickAnswerSuggestedQueryCategory", +"EnterpriseTopazSidekickGenericAnswerCard": { +"id": "EnterpriseTopazSidekickGenericAnswerCard", "properties": { -"category": { -"description": "The query list category.", -"enum": [ -"UNKNOWN", -"CALENDAR", -"DOCUMENT", -"PEOPLE" -], -"enumDescriptions": [ -"Unknown.", -"Calendar based queries (e.g. \"my agenda for tomorrow\").", -"Document based queries (e.g. \"files shared with me\").", -"People based queries (e.g. \"what is x's email address?\")." -], +"answer": { +"description": "The answer.", "type": "string" }, -"isEnabled": { -"description": "Whether this category is enabled.", -"type": "boolean" +"title": { +"description": "Title or header of the card.", +"type": "string" +} }, -"query": { -"description": "List of suggested queries to show the user.", +"type": "object" +}, +"EnterpriseTopazSidekickGetAndKeepAheadCardProto": { +"description": "Get and keep ahead card", +"id": "EnterpriseTopazSidekickGetAndKeepAheadCardProto", +"properties": { +"declinedEvents": { +"$ref": "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents" +}, +"mentionedDocuments": { +"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList" +}, +"sharedDocuments": { +"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList" +} +}, +"type": "object" +}, +"EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents": { +"description": "A list of events where all guests declined.", +"id": "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents", +"properties": { +"events": { "items": { -"type": "string" +"$ref": "EnterpriseTopazSidekickAgendaEntry" }, "type": "array" } }, "type": "object" }, -"EnterpriseTopazSidekickAssistCardProto": { -"description": "Wrapper proto for the Assist cards.", -"id": "EnterpriseTopazSidekickAssistCardProto", +"EnterpriseTopazSidekickMeetingNotesCardError": { +"description": "Errors in the creation of meeting notes.", +"id": "EnterpriseTopazSidekickMeetingNotesCardError", "properties": { -"agendaGroupCardProto": { -"$ref": "EnterpriseTopazSidekickAgendaGroupCardProto", -"description": "Agenda group card." +"description": { +"description": "The description of the reason why create-meeting-notes failed.", +"type": "string" }, -"cardMetadata": { -"$ref": "EnterpriseTopazSidekickCardMetadata", -"description": "Card metadata such as chronology and render mode of the card." +"event": { +"$ref": "EnterpriseTopazSidekickAgendaEntry", +"description": "The event to request meeting notes creation" }, -"cardType": { -"description": "Card type.", +"reason": { +"description": "The reason why create-meeting-notes failed.", "enum": [ -"UNKNOWN_TYPE", -"AGENDA", -"CHANGELISTS", -"CONFLICTING_MEETINGS", -"CREATE_NOTES_FOR_MEETING", -"CREATE_NOTES_FOR_MEETING_REQUEST", -"CUSTOMER_NEWS", -"FIND_MEETING_TIME", -"NEXT_MEETING", -"PERSONALIZED_DOCS", -"TRENDING_DOCS", -"UPCOMING_TRIP", -"SUMMARY", -"MEETINGS", -"HOMEPAGE", -"SHARE_MEETING_DOCS", -"DISCOVER_PEOPLE", -"HOMEPAGE_V3", -"AGENDA_GROUP", -"WORK_IN_PROGRESS", -"GET_AND_KEEP_AHEAD", -"GENERIC_ANSWER_CARD", -"THIRD_PARTY_ANSWER_CARD", -"DOMAIN_TRENDING_DOCS", -"TEAM_TRENDING_DOCS", -"DOCUMENT_LIST_ANSWER_CARD", -"SUGGESTED_QUERY_ANSWER_CARD", -"PERSON_ANSWER_CARD", -"RELATED_PEOPLE_ANSWER_CARD", -"PERSON_KNOWLEDGE_CARD", -"PEOPLE_SEARCH_PROMOTION_CARD" -], -"enumDeprecated": [ -false, -true, -true, -true, -true, -true, -true, -false, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -false +"NONE", +"NOT_OWNER", +"UNKNOWN" ], "enumDescriptions": [ -"The default type, an unknown card type.", -"The user's agenda for the day.", -"Changelists.", -"Any group of meetings for the day that are overlapping.", -"Create notes for a meeting specified in the request.", -"Create notes for meeting query.", -"News about your SFDC customers.", -"Find a time for two people to meet.", -"The user's next non-declined meeting.", -"Important documents for you since you have viewed them in the last month and there's some action going on.", -"Documents that are trending in your company. A TRENDING_DOCS card can be of two types: TRENDING_IN_COLLABORATORS (i.e., Stay in the Loop) and TRENDING_IN_DOMAIN (i.e., Popular Content). Use DOMAIN_TRENDING_DOCS/TEAM_TRENDING_DOCS instead.", -"An upcoming trip with all trip information along with calendar events in the destination timezone.", -"The Morning/Evening Summary Card for the next working day.", -"A meeting. When requesting meetings, the service will return a MEETING card for each meeting the user has in his agenda.", -"All cards related to the homepage (agenda, conflicting-meetings, summary, etc...). This type should no longer be used. Use HOMEPAGE_V3 instead.", -"A card to with specifics to share meeting documents with all attendees.", -"Represents a set of users that the requesting user has low affinity with.", -"All cards related to the homepage-v3 (agenda-group, WIP, etc...)", -"A group of agenda-events (meeting, conflicts)", -"The documents that you were recently working on.", -"(v3) The \"get and keep ahead\" card for today and tomorrow", -"Generic answer card.", -"Third party answer card.", -"Documents that are trending in your company/domain (i.e., Popular Content).", -"Documents that are trending in your team (i.e., Stay in the Loop).", -"Documents that match the user's query (e.g. sheets shared with me).", -"A help card that provides examples of queries the user can ask.", -"Answer card for a single person (e.g. what is x's phone number).", -"Answer card for a list of people related to the person that is the subject of the query (e.g. who reports to x).", -"Knowledge card for a single person and their related people.", -"People Search promotion card." +"No reason (default value).", +"The user is not an owner.", +"Unknown reason." ], "type": "string" +} }, -"conflictingMeetingsCard": { -"$ref": "EnterpriseTopazSidekickConflictingEventsCardProto", -"deprecated": true, -"description": "Conflicting events card." +"type": "object" }, -"documentListCard": { -"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", -"description": "Answer card for documents that are applicable to the current query." +"EnterpriseTopazSidekickMeetingNotesCardProto": { +"description": "Information about the meeting notes created.", +"id": "EnterpriseTopazSidekickMeetingNotesCardProto", +"properties": { +"event": { +"$ref": "EnterpriseTopazSidekickAgendaEntry", +"description": "The event to request meeting notes creation." }, -"documentsWithMentions": { -"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", -"deprecated": true, -"description": "Documents with mentions." +"fileId": { +"description": "Google Drive ID (a.k.a. resource ID) of the file.", +"type": "string" }, -"findMeetingTimeCard": { -"$ref": "EnterpriseTopazSidekickFindMeetingTimeCardProto", -"description": "Find meeting time card." +"title": { +"description": "Title we want to show for meeting notes in the answer card", +"type": "string" }, -"genericAnswerCard": { -"$ref": "EnterpriseTopazSidekickGenericAnswerCard", -"description": "Generic answer card." +"url": { +"description": "New URL.", +"type": "string" +} }, -"getAndKeepAheadCard": { -"$ref": "EnterpriseTopazSidekickGetAndKeepAheadCardProto", -"description": "Get and keep ahead card." +"type": "object" }, -"meeting": { -"$ref": "EnterpriseTopazSidekickAgendaEntry", -"deprecated": true, -"description": "Meeting card." +"EnterpriseTopazSidekickMeetingNotesCardRequest": { +"description": "Meeting notes card request.", +"id": "EnterpriseTopazSidekickMeetingNotesCardRequest", +"properties": { +"canCreateFor": { +"description": "Who are the meeting notes created for.", +"items": { +"enum": [ +"UNKNOWN", +"MYSELF", +"ALL_ATTENDEES" +], +"enumDescriptions": [ +"Unknown (default).", +"For the requester.", +"For all the meeting attendees." +], +"type": "string" }, -"meetingNotesCard": { -"$ref": "EnterpriseTopazSidekickMeetingNotesCardProto", -"description": "Meeting notes card." +"type": "array" }, -"meetingNotesCardRequest": { -"$ref": "EnterpriseTopazSidekickMeetingNotesCardRequest", -"description": "Request for meeting notes card." +"error": { +"$ref": "EnterpriseTopazSidekickMeetingNotesCardError", +"description": "The error and reason if known error occured." }, -"peopleDisambiguationCard": { -"$ref": "EnterpriseTopazSidekickPeopleDisambiguationCard", -"description": "The people disambiguation card." +"event": { +"$ref": "EnterpriseTopazSidekickAgendaEntry", +"description": "The event to request meeting notes creation" +} }, -"peoplePromotionCard": { -"$ref": "PeoplePromotionCard", -"description": "People Search promotion card." +"type": "object" }, -"personAnswerCard": { -"$ref": "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard", -"description": "Answer card that represents a single person." +"EnterpriseTopazSidekickNlpMetadata": { +"description": "Metadata about the NLP interpretation of the query.", +"id": "EnterpriseTopazSidekickNlpMetadata", +"properties": { +"confidence": { +"description": "Confidence of the interpretation that generated this card.", +"format": "float", +"type": "number" +} }, -"personProfileCard": { -"$ref": "EnterpriseTopazSidekickPersonProfileCard", -"description": "Full profile card." +"type": "object" }, -"personalizedDocsCard": { -"$ref": "EnterpriseTopazSidekickPersonalizedDocsCardProto", -"deprecated": true, -"description": "Card with recommended documents for the user." +"EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo": { +"description": "Metadata for disambiguation.", +"id": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", +"properties": { +"disambiguation": { +"description": "A list of people that also matched the query. This list is not complete.", +"items": { +"$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson" }, -"relatedPeopleAnswerCard": { -"$ref": "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard", -"description": "Answer card that represents a list of people related to a person." +"type": "array" }, -"shareMeetingDocsCard": { -"$ref": "EnterpriseTopazSidekickShareMeetingDocsCardProto", -"deprecated": true, -"description": "Sahre meeting docs card." +"name": { +"description": "The name that was extracted from the query. This may be in the form of the given name, last name, full name, LDAP, or email address. This name can be considered suitable for displaying to the user and can largely be considered to be normalized (e.g. \"Bob's\" -> \"Bob\").", +"type": "string" +} }, -"sharedDocuments": { -"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList", -"deprecated": true, -"description": "Shared documents." +"type": "object" }, -"suggestedQueryAnswerCard": { -"$ref": "EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard", -"description": "Answer card for what natural language queries the user can ask." +"EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson": { +"description": "A person that also matches the query, but was not selected due to a lower affinity with the requesting user.", +"id": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson", +"properties": { +"person": { +"$ref": "EnterpriseTopazSidekickCommonPerson", +"description": "The profile of this person." }, -"thirdPartyAnswerCard": { -"$ref": "ThirdPartyGenericCard", -"description": "Third party answer cards." +"query": { +"description": "The query that can be used to produce an answer card with the same attribute, but for this person.", +"type": "string" +} }, -"workInProgressCardProto": { -"$ref": "EnterpriseTopazSidekickRecentDocumentsCardProto", -"description": "Work In Progress card." +"type": "object" +}, +"EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader": { +"description": "Recommended header to display for the card.", +"id": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", +"properties": { +"title": { +"description": "The suggested title to display. This defaults to the user's query.", +"type": "string" } }, "type": "object" }, -"EnterpriseTopazSidekickCardMetadata": { -"description": "Card metadata.", -"id": "EnterpriseTopazSidekickCardMetadata", +"EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard": { +"description": "An answer card for a single person.", +"id": "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard", "properties": { -"cardCategory": { -"description": "Declares a preference for how this card should be packed in MSCR. All cards in a response must correspond to a single category. As a result, cards may be dropped from the response if this field is set. Any card that does not match the category of the card with the highest priority in the response will be dropped.", -"enum": [ -"DEFAULT", -"ANSWER", -"KNOWLEDGE", -"HOMEPAGE" -], -"enumDescriptions": [ -"Let MSCR decide how this card should be packed. Most cards should choose this type. This type should largely be considered equivalent to ANSWER. However, this is not guaranteed to be the case as the request to MSCR may override the static configuration.", -"This card should be rendered as an answer card.", -"This card should be rendered as a knowledge card (a non-organic result).", -"This card should be rendered in the Homepage." -], -"type": "string" +"answer": { +"deprecated": true, +"description": "List of answers.", +"items": { +"$ref": "SafeHtmlProto" }, -"cardId": { -"description": "An ID to identify the card and match actions to it. Be thoughtful of new card IDs since actions will be associated to that ID. E.g., if two card IDs collide, the system will think that the actions have been applied to the same card. Similarly, if EAS can return multiple cards of the same type (e.g., Meetings), ensure that the card_id identifies a given instance of the card so that, e.g., dismissals only affect the dismissed card as opposed to affecting all meeting cards.", -"type": "string" +"type": "array" }, -"chronology": { -"description": "Chronology.", +"answerText": { +"$ref": "EnterpriseTopazSidekickAnswerAnswerList", +"description": "List of answers." +}, +"disambiguationInfo": { +"$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", +"description": "Disambiguation information." +}, +"header": { +"$ref": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", +"description": "The header to display for the card." +}, +"responseStatus": { +"description": "The response status.", "enum": [ "UNKNOWN", -"PAST", -"RECENTLY_PAST", -"PRESENT", -"NEAR_FUTURE", -"FUTURE" +"SUCCESS", +"MISSING_PERSON", +"MISSING_DATA" ], "enumDescriptions": [ -"Unknown chronology (default).", -"Past.", -"Recently past.", -"Present.", -"Near future.", -"Future." +"Unknown.", +"Success.", +"No such person was found in the user's domain.", +"A person was found to match the query, but an answer could not be obtained." ], "type": "string" }, -"debugInfo": { -"description": "Debug info (only reported if request's debug_level > 0).", +"statusMessage": { +"description": "Localized user friendly message to display to the user in the case of missing data or an error.", "type": "string" }, -"nlpMetadata": { -"$ref": "EnterpriseTopazSidekickNlpMetadata", -"description": "Information about the NLP done to get the card." -}, -"rankingParams": { -"$ref": "EnterpriseTopazSidekickRankingParams", -"description": "Ranking params." -}, -"renderMode": { -"description": "Render mode.", -"enum": [ -"UNKNOWN_RENDER", -"COLLAPSED", -"EXPANDED" -], -"enumDescriptions": [ -"Unknown mode (default).", -"Collapsed.", -"Expanded." -], -"type": "string" +"subject": { +"$ref": "EnterpriseTopazSidekickCommonPerson", +"description": "The profile of the person that was the subject of the query." } }, "type": "object" }, -"EnterpriseTopazSidekickCommonDebugInfo": { -"description": "Container of debugging information in all object levels. Extend as needed.", -"id": "EnterpriseTopazSidekickCommonDebugInfo", +"EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard": { +"description": "An answer card for a list of people that are related to the subject of the query.", +"id": "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard", "properties": { -"message": { -"description": "Debug message.", -"type": "string" -} +"disambiguationInfo": { +"$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", +"description": "Disambiguation information." }, -"type": "object" +"header": { +"$ref": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", +"description": "The header to display for the card." }, -"EnterpriseTopazSidekickCommonDocument": { -"description": "Representation of a document. NEXT_TAG: 15", -"id": "EnterpriseTopazSidekickCommonDocument", -"properties": { -"accessType": { -"description": "Access type, i.e., whether the user has access to the document or not.", +"relatedPeople": { +"description": "A list of people that are related to the query subject.", +"items": { +"$ref": "EnterpriseTopazSidekickCommonPerson" +}, +"type": "array" +}, +"relationType": { +"description": "Defines the type of relation the list of people have with the subject of the card.", "enum": [ -"UNKNOWN_ACCESS", -"ALLOWED", -"NOT_ALLOWED" +"UNKNOWN", +"DIRECT_REPORTS", +"MANAGER", +"PEERS" ], "enumDescriptions": [ -"Unknown access type.", -"Access allowed.", -"Access not allowed." +"Unknown.", +"Direct reports.", +"The manager.", +"The teammates/peers of the subject." ], "type": "string" }, -"debugInfo": { -"$ref": "EnterpriseTopazSidekickCommonDebugInfo", -"description": "Information for debugging." +"responseStatus": { +"description": "The response status.", +"enum": [ +"UNKNOWN", +"SUCCESS", +"MISSING_PERSON", +"MISSING_DATA" +], +"enumDescriptions": [ +"Unknown.", +"Success.", +"No such person was found in the user's domain.", +"A person was found to match the query, but an answer could not be obtained." +], +"type": "string" }, -"documentId": { -"description": "Document id.", +"statusMessage": { +"description": "Localized user friendly message to display to the user in the case of missing data or an error.", "type": "string" }, -"driveDocumentMetadata": { -"$ref": "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata", -"description": "Drive document metadata." +"subject": { +"$ref": "EnterpriseTopazSidekickCommonPerson", +"description": "The profile of the person that was the subject of the query." +} }, -"genericUrl": { -"description": "Generic Drive-based url in the format of drive.google.com/open to be used for deeplink", -"type": "string" +"type": "object" }, -"justification": { -"$ref": "EnterpriseTopazSidekickCommonDocumentJustification", -"description": "Justification on why the document is selected." +"EnterpriseTopazSidekickPeopleDisambiguationCard": { +"id": "EnterpriseTopazSidekickPeopleDisambiguationCard", +"properties": { +"person": { +"description": "Candidate persons for the query.", +"items": { +"$ref": "EnterpriseTopazSidekickCommonPerson" }, -"mimeType": { -"description": "MIME type", -"type": "string" +"type": "array" +} }, -"provenance": { -"deprecated": true, -"description": "Document provenance.", +"type": "object" +}, +"EnterpriseTopazSidekickPerson": { +"description": "Person.", +"id": "EnterpriseTopazSidekickPerson", +"properties": { +"affinityLevel": { +"description": "The level of affinity this person has with the requesting user.", "enum": [ -"UNKNOWN_PROVENANCE", -"CALENDAR_DESCRIPTION", -"CALENDAR_ATTACHMENT", -"MINED", -"CALENDAR_ASSIST_ATTACHMENT" +"UNKNOWN", +"LOW", +"MEDIUM", +"HIGH" ], "enumDescriptions": [ -"Unknown provenance.", -"Calendar event description.", -"Calendar event attachment.", -"Mined (extracted by some offline/online analysis).", -"Attachment created by enterprise assist." +"", +"", +"", +"" ], "type": "string" }, -"reason": { -"deprecated": true, -"description": "Justification of why this document is being returned.", +"attendingStatus": { +"description": "Attendance status of the person when included in a meeting event.", "enum": [ -"UNKNOWN", -"TRENDING_IN_COLLABORATORS", -"TRENDING_IN_DOMAIN", -"FREQUENTLY_VIEWED", -"FREQUENTLY_EDITED", -"NEW_UPDATES", -"NEW_COMMENTS", -"EVENT_DESCRIPTION", -"EVENT_ATTACHMENT", -"EVENT_METADATA_ATTACHMENT", -"MINED_DOCUMENT", -"NEW_MENTIONS", -"NEW_SHARES" +"AWAITING", +"YES", +"NO", +"MAYBE" ], "enumDescriptions": [ -"Unknown justification.", -"Popular documents within collaborators.", -"Popular documents within the domain.", -"Documents being reviewed frequently by the current user .", -"Documents being edited frequently by the current user .", -"Documents updated since user's last visit.", -"Documents that receive comments since user's last visit.", -"Documents in the calendar event description.", -"Documents in the calendar event attachments section.", -"Documents attached in calendar event metadata instead of the attachment section. Event metadata is not visible to the final user. Enterprise assist uses this metadata to store auto-generated documents such as meeting notes.", -"Documents mined, and so, probably related to the request context. For example, this category includes documents related to a meeting.", -"Documents that contains mentions of the user.", -"Documents that are shared with the user." +"Awaiting for the user to set the status.", +"Attending.", +"Not attending.", +"Tentatively attending." ], "type": "string" }, -"snippet": { -"description": "A sampling of the text from the document.", +"email": { +"description": "Email.", "type": "string" }, -"thumbnailUrl": { -"description": "Thumbnail URL.", +"gaiaId": { +"deprecated": true, +"description": "Gaia id.", +"format": "int64", "type": "string" }, -"title": { -"description": "Title of the document.", +"isGroup": { +"description": "Whether the invitee is a group.", +"type": "boolean" +}, +"name": { +"description": "Name.", "type": "string" }, -"type": { -"description": "Type of the document.", +"obfuscatedGaiaId": { +"description": "Obfuscated Gaia id.", +"type": "string" +}, +"photoUrl": { +"description": "Absolute URL to the profile photo of the person.", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseTopazSidekickPersonProfileCard": { +"id": "EnterpriseTopazSidekickPersonProfileCard", +"properties": { +"relatedPeople": { +"items": { +"$ref": "EnterpriseTopazSidekickPersonProfileCardRelatedPeople" +}, +"type": "array" +}, +"subject": { +"$ref": "EnterpriseTopazSidekickCommonPerson", +"description": "The subject of the card." +} +}, +"type": "object" +}, +"EnterpriseTopazSidekickPersonProfileCardRelatedPeople": { +"id": "EnterpriseTopazSidekickPersonProfileCardRelatedPeople", +"properties": { +"relatedPerson": { +"description": "Related people.", +"items": { +"$ref": "EnterpriseTopazSidekickCommonPerson" +}, +"type": "array" +}, +"relation": { +"description": "Relation type.", "enum": [ "UNKNOWN", -"DOCUMENT", -"PRESENTATION", -"SPREADSHEET", -"PDF", -"IMAGE", -"BINARY_BLOB", -"FUSION_TABLE", -"FOLDER", -"DRAWING", -"VIDEO", -"FORM", -"LINK_URL", -"LINK_GO", -"LINK_GOO_GL", -"LINK_BIT_LY", -"LINK_GMAIL", -"LINK_MAILTO", -"VIDEO_YOUTUBE", -"VIDEO_LIVE", -"GROUPS", -"NEWS", -"SITES", -"HANGOUT", -"AUDIO", -"MS_WORD", -"MS_POWERPOINT", -"MS_EXCEL", -"MS_OUTLOOK" +"MANAGER", +"DIRECT_REPORT" ], "enumDescriptions": [ -"If the type is unknown or not represented in this enum.", -"Drive document types Writely, Word, etc.", -"Presently, PowerPoint, etc.", -"Trix, Excel, etc.", -"File types for Gdrive objects are below. PDF.", -"Image.", -"Fall-back for unknown Gdrive types.", -"Fusion table.", -"Folder.", -"Drawing.", -"Video.", -"Form.", -"Link formats uncategorized URL links", -"meaningful links that should be renderred specifically", -"Link to goo.gl.", -"Link to bit_ly.", -"Link to Gmail.", -"Mailto link.", -"Videos Youtube videos.", -"Live streams (e.g., liveplayer.googleplex.com)", -"Other types. Google Groups.", -"Google News.", -"Google Sites.", -"Google Hangout.", -"Audio files.", -"Microsoft-specific file types.", "", "", "" ], "type": "string" -}, -"url": { -"description": "Absolute URL of the document.", -"type": "string" } }, "type": "object" }, -"EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata": { -"description": "Meta data for drive documents.", -"id": "EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata", +"EnterpriseTopazSidekickPersonalizedDocsCardProto": { +"description": "Personalized docs card proto.", +"id": "EnterpriseTopazSidekickPersonalizedDocsCardProto", "properties": { -"documentId": { -"deprecated": true, -"description": "The drive document cosmo id. Client could use the id to build a URL to open a document. Please use Document.document_id.", -"type": "string" +"documentGroup": { +"description": "Document group.", +"items": { +"$ref": "EnterpriseTopazSidekickDocumentGroup" }, -"isPrivate": { -"description": "Additional field to identify whether a document is private since scope set to LIMITED can mean both that the doc is private or that it's shared with others. is_private indicates whether the doc is not shared with anyone except for the owner.", -"type": "boolean" +"type": "array" +} }, -"lastCommentTimeMs": { -"description": "Timestamp of the most recent comment added to the document in milliseconds since epoch.", -"format": "uint64", -"type": "string" +"type": "object" }, -"lastEditTimeMs": { -"description": "Timestamp of the most recent edit from the current user in milliseconds since epoch.", +"EnterpriseTopazSidekickRankingParams": { +"description": "Ranking params.", +"id": "EnterpriseTopazSidekickRankingParams", +"properties": { +"endTimeMs": { +"description": "The end-time that this object will expect to occur. If the type is marked as FIXED, then this end-time will persist after bidding. If the type is marked as FLEXIBLE, this field is NOT expected to be filled and will be filled in after it has won a bid. Expected to be set when type is set to FIXED.", "format": "uint64", "type": "string" }, -"lastModificationTimeMillis": { -"description": "Last modification time of the document (independent of the user that modified it).", -"format": "int64", +"priority": { +"description": "The priority to determine between objects that have the same start_time_ms The lower-value of priority == ranked higher. Max-priority = 0. Expected to be set for all types.", +"enum": [ +"UNKNOWN", +"CRITICAL", +"IMPORTANT", +"HIGH", +"NORMAL", +"BEST_EFFORT" +], +"enumDescriptions": [ +"Unknown (default).", +"Critical.", +"Important.", +"High.", +"Normal.", +"Best effort." +], "type": "string" }, -"lastUpdatedTimeMs": { -"description": "Timestamp of the last updated time of the document in milliseconds since epoch.", +"score": { +"description": "The score of the card to be used to break priority-ties", +"format": "float", +"type": "number" +}, +"spanMs": { +"description": "The span that this card will take in the stream Expected to be set when type is set to FLEXIBLE.", "format": "uint64", "type": "string" }, -"lastViewTimeMs": { -"description": "Timestamp of the most recent view from the current user in milliseconds since epoch.", +"startTimeMs": { +"description": "The start-time that this object will bid-for If the type is marked as FIXED, then this start-time will persist after bidding. If the type is marked as FLEXIBLE, then it will occur at the given time or sometime after the requested time. Expected to be set for all types.", "format": "uint64", "type": "string" }, -"owner": { -"$ref": "EnterpriseTopazSidekickCommonPerson", -"description": "The owner of the document." -}, -"scope": { -"description": "ACL scope of the document which identifies the sharing status of the doc (e.g., limited, shared with link, team drive, ...).", +"type": { +"description": "The packing type of this object.", "enum": [ -"UNKNOWN_DOCUMENT_SCOPE", -"LIMITED", -"DASHER_DOMAIN_WITH_LINK", -"DASHER_DOMAIN", -"PUBLIC_WITH_LINK", -"PUBLIC", -"TEAM_DRIVE" +"FIXED", +"FLEXIBLE" ], "enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"" +"Fixed, i.e., the card is time sensitive.", +"Flexible, i.e., the card is not time sensitive." ], "type": "string" } }, "type": "object" }, -"EnterpriseTopazSidekickCommonDocumentJustification": { -"description": "Justification of why we are reporting the document.", -"id": "EnterpriseTopazSidekickCommonDocumentJustification", +"EnterpriseTopazSidekickRecentDocumentsCardProto": { +"id": "EnterpriseTopazSidekickRecentDocumentsCardProto", "properties": { -"justification": { -"description": "A locale aware message that explains why this document was selected.", -"type": "string" +"document": { +"items": { +"$ref": "EnterpriseTopazSidekickCommonDocument" }, -"reason": { -"description": "Reason on why the document is selected. Populate for trending documents.", -"enum": [ -"UNKNOWN", -"TRENDING_IN_COLLABORATORS", -"TRENDING_IN_DOMAIN", -"FREQUENTLY_VIEWED", -"FREQUENTLY_EDITED", -"NEW_UPDATES", -"NEW_COMMENTS", -"EVENT_DESCRIPTION", -"EVENT_ATTACHMENT", -"EVENT_METADATA_ATTACHMENT", -"MINED_DOCUMENT", -"NEW_MENTIONS", -"NEW_SHARES" -], -"enumDescriptions": [ -"Unknown justification.", -"Popular documents within collaborators.", -"Popular documents within the domain.", -"Documents being reviewed frequently by the current user .", -"Documents being edited frequently by the current user .", -"Documents updated since user's last visit.", -"Documents that receive comments since user's last visit.", -"Documents in the calendar event description.", -"Documents in the calendar event attachments section.", -"Documents attached in calendar event metadata instead of the attachment section. Event metadata is not visible to the final user. Enterprise assist uses this metadata to store auto-generated documents such as meeting notes.", -"Documents mined, and so, probably related to the request context. For example, this category includes documents related to a meeting.", -"Documents that contains mentions of the user.", -"Documents that are shared with the user." -], -"type": "string" +"type": "array" } }, "type": "object" }, -"EnterpriseTopazSidekickCommonPerson": { -"description": "Common representation of a person.", -"id": "EnterpriseTopazSidekickCommonPerson", +"EnterpriseTopazSidekickScheduledMeeting": { +"description": "Details about scheduled meetings.", +"id": "EnterpriseTopazSidekickScheduledMeeting", "properties": { -"birthday": { -"$ref": "EnterpriseTopazSidekickCommonPersonBirthday", -"description": "The birthday." +"meetingLocation": { +"description": "The meeting location.", +"type": "string" }, -"cellPhone": { -"description": "Cell phone number.", -"type": "string" -}, -"department": { -"description": "The department the person works in (e.g. Engineering).", -"type": "string" -}, -"deskLocation": { -"description": "Desk location (e.g. US-MTV-PR55-5-5B1I).", -"type": "string" -}, -"deskPhone": { -"description": "Work desk phone number.", -"type": "string" -}, -"displayName": { -"description": "The full name.", -"type": "string" -}, -"email": { -"description": "Email.", -"type": "string" -}, -"familyName": { -"description": "The last name.", -"type": "string" -}, -"fullAddress": { -"description": "The fully formatted address (e.g. 1255 Pear Avenue, Mountain View 94043, United States).", -"type": "string" -}, -"gaiaId": { -"deprecated": true, -"description": "This field is deprecated. The obfuscated_id should be used instead.", -"format": "int64", -"type": "string" -}, -"givenName": { -"description": "The first name.", -"type": "string" -}, -"jobTitle": { -"description": "The person's job title (e.g. Software Engineer).", -"type": "string" -}, -"manager": { -"$ref": "EnterpriseTopazSidekickCommonPerson", -"description": "The manager." -}, -"obfuscatedId": { -"description": "The obfuscated GAIA ID.", -"type": "string" -}, -"photoUrl": { -"description": "The URL for the Focus profile picture.", -"type": "string" -}, -"streetAddress": { -"description": "The street address (e.g. 1255 Pear Avenue).", -"type": "string" -} -}, -"type": "object" +"meetingTime": { +"$ref": "EnterpriseTopazSidekickTimeSlot", +"description": "The meeting time slot." }, -"EnterpriseTopazSidekickCommonPersonBirthday": { -"id": "EnterpriseTopazSidekickCommonPersonBirthday", -"properties": { -"value": { -"description": "Unstructured birthday.", +"meetingTitle": { +"description": "The meeting title.", "type": "string" } }, "type": "object" }, -"EnterpriseTopazSidekickConflictingEventsCardProto": { -"description": "Conflicting meetings card proto.", -"id": "EnterpriseTopazSidekickConflictingEventsCardProto", +"EnterpriseTopazSidekickShareMeetingDocsCardProto": { +"description": "Share meeting docs card proto.", +"id": "EnterpriseTopazSidekickShareMeetingDocsCardProto", "properties": { -"conflictingEvent": { -"description": "All the events that conflict with main_event.", +"document": { +"description": "Documents to share for the given meeting.", "items": { -"$ref": "EnterpriseTopazSidekickAgendaEntry" +"$ref": "EnterpriseTopazSidekickCommonDocument" }, "type": "array" }, -"mainEvent": { +"event": { "$ref": "EnterpriseTopazSidekickAgendaEntry", -"description": "The event identified as being the most important." -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickDocumentGroup": { -"description": "Represents a mapping between a document type and its corresponding documents. Use for Work in Progress card in v1 homepage.", -"id": "EnterpriseTopazSidekickDocumentGroup", -"properties": { -"groupType": { -"deprecated": true, -"description": "Document group type", -"enum": [ -"UNKNOWN_TYPE", -"ALL" -], -"enumDescriptions": [ -"Unknown type.", -"A mix of all the document types." -], -"type": "string" -}, -"personalizedDocument": { -"description": "The list of corresponding documents.", -"items": { -"$ref": "EnterpriseTopazSidekickCommonDocument" -}, -"type": "array" +"description": "Event." } }, "type": "object" }, -"EnterpriseTopazSidekickDocumentPerCategoryList": { -"id": "EnterpriseTopazSidekickDocumentPerCategoryList", +"EnterpriseTopazSidekickTimeSlot": { +"description": "Slot of time.", +"id": "EnterpriseTopazSidekickTimeSlot", "properties": { -"documents": { -"items": { -"$ref": "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry" -}, -"type": "array" -}, -"helpMessage": { -"description": "Localized message explaining how the documents were derived (e.g. from the last 30 days activity). This field is optional.", -"type": "string" -}, -"listType": { -"enum": [ -"UNKNOWN_LIST_TYPE", -"MENTIONS", -"SHARES", -"NEEDS_ATTENTION", -"VIEWS", -"EDITS" -], -"enumDescriptions": [ -"", -"All documents in the list correspond to one of the mention categories.", -"All documents in the list correspond to one of the share categories.", -"A mixture of document categories that correspond to documents that need the users attention (e.g. documents that have been explicitly shared with the user but have not been viewed and documents where the user was mentioned but has not replied).", -"All documents in the list correspond to one of the view categories.", -"All documents in the list correspond to one of the edit categories." -], -"type": "string" -}, -"listTypeDescription": { -"description": "Description of the types of documents present in the list.", -"type": "string" -}, -"responseMessage": { -"description": "Response message in case no documents are present in the card.", +"endTimeDay": { +"description": "Day end time at the user's timezone.", "type": "string" -} }, -"type": "object" -}, -"EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry": { -"id": "EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry", -"properties": { -"category": { -"enum": [ -"UNKNOWN_DOCUMENT", -"ACTIONABLE", -"VIEWED", -"REPLIED", -"MENTION_VIEWED", -"MENTION_REPLIED", -"MENTION_NOT_VIEWED", -"SHARED_AND_VIEWED", -"SHARED_NOT_VIEWED", -"EDITED" -], -"enumDeprecated": [ -false, -true, -false, -true, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"", -"", -"", -"", -"Mention categories. The mention has been viewed by the user, but the user has not replied.", -"The user has replied to the mention.", -"The mention has not been viewed by the user.", -"Share categories. Consists of documents that have been explicitly shared with the user. Document has been viewed.", -"Document has not been viewed.", -"Document has been edited." -], +"endTimeHourAndMinute": { +"description": "Hour and minute of the end time at the user's timezone.", "type": "string" }, -"document": { -"$ref": "EnterpriseTopazSidekickCommonDocument" -}, -"rationale": { -"description": "Reason this document was selected.", +"endTimeInMillis": { +"description": "End time in milliseconds.", +"format": "int64", "type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickFindMeetingTimeCardProto": { -"description": "Response to find meeting time among a set of people.", -"id": "EnterpriseTopazSidekickFindMeetingTimeCardProto", -"properties": { -"commonAvailableTimeSlots": { -"description": "Slots when all attendees have availability.", -"items": { -"$ref": "EnterpriseTopazSidekickTimeSlot" }, -"type": "array" -}, -"invitees": { -"description": "Invitees to the event.", -"items": { -"$ref": "EnterpriseTopazSidekickPerson" -}, -"type": "array" -}, -"requester": { -"$ref": "EnterpriseTopazSidekickPerson", -"description": "Requester." -}, -"scheduledMeeting": { -"$ref": "EnterpriseTopazSidekickScheduledMeeting", -"description": "Details about the scheduled meeting, if one exists." -}, -"skippedInvitees": { -"description": "Invitees that have been skipped in the computation, most likely because they are groups.", -"items": { -"$ref": "EnterpriseTopazSidekickPerson" -}, -"type": "array" -}, -"timeBoundaries": { -"$ref": "EnterpriseTopazSidekickTimeSlot", -"description": "Min and max timestamp used to find a common available timeslot." -}, -"timezoneId": { -"description": "Timezone ID.", -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickGap": { -"id": "EnterpriseTopazSidekickGap", -"properties": { -"displayRemainingTime": { -"description": "Localized time string in the format: 1 hour 15 minutes", -"type": "string" -}, -"endTime": { -"description": "Localized time string in the format:(Locale CZ) 8:30 odp.", -"type": "string" -}, -"endTimeMs": { -"format": "uint64", -"type": "string" -}, -"remainingTime": { -"format": "google-duration", -"type": "string" -}, -"startTime": { -"description": "Localized time string in the format:(Locale CZ) 8:30 odp.", -"type": "string" -}, -"startTimeMs": { -"format": "uint64", -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickGenericAnswerCard": { -"id": "EnterpriseTopazSidekickGenericAnswerCard", -"properties": { -"answer": { -"description": "The answer.", -"type": "string" -}, -"title": { -"description": "Title or header of the card.", -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickGetAndKeepAheadCardProto": { -"description": "Get and keep ahead card", -"id": "EnterpriseTopazSidekickGetAndKeepAheadCardProto", -"properties": { -"declinedEvents": { -"$ref": "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents" -}, -"mentionedDocuments": { -"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList" -}, -"sharedDocuments": { -"$ref": "EnterpriseTopazSidekickDocumentPerCategoryList" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents": { -"description": "A list of events where all guests declined.", -"id": "EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents", -"properties": { -"events": { -"items": { -"$ref": "EnterpriseTopazSidekickAgendaEntry" -}, -"type": "array" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickMeetingNotesCardError": { -"description": "Errors in the creation of meeting notes.", -"id": "EnterpriseTopazSidekickMeetingNotesCardError", -"properties": { -"description": { -"description": "The description of the reason why create-meeting-notes failed.", -"type": "string" -}, -"event": { -"$ref": "EnterpriseTopazSidekickAgendaEntry", -"description": "The event to request meeting notes creation" -}, -"reason": { -"description": "The reason why create-meeting-notes failed.", -"enum": [ -"NONE", -"NOT_OWNER", -"UNKNOWN" -], -"enumDescriptions": [ -"No reason (default value).", -"The user is not an owner.", -"Unknown reason." -], -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickMeetingNotesCardProto": { -"description": "Information about the meeting notes created.", -"id": "EnterpriseTopazSidekickMeetingNotesCardProto", -"properties": { -"event": { -"$ref": "EnterpriseTopazSidekickAgendaEntry", -"description": "The event to request meeting notes creation." -}, -"fileId": { -"description": "Google Drive ID (a.k.a. resource ID) of the file.", -"type": "string" -}, -"title": { -"description": "Title we want to show for meeting notes in the answer card", -"type": "string" -}, -"url": { -"description": "New URL.", -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickMeetingNotesCardRequest": { -"description": "Meeting notes card request.", -"id": "EnterpriseTopazSidekickMeetingNotesCardRequest", -"properties": { -"canCreateFor": { -"description": "Who are the meeting notes created for.", -"items": { -"enum": [ -"UNKNOWN", -"MYSELF", -"ALL_ATTENDEES" -], -"enumDescriptions": [ -"Unknown (default).", -"For the requester.", -"For all the meeting attendees." -], -"type": "string" -}, -"type": "array" -}, -"error": { -"$ref": "EnterpriseTopazSidekickMeetingNotesCardError", -"description": "The error and reason if known error occured." -}, -"event": { -"$ref": "EnterpriseTopazSidekickAgendaEntry", -"description": "The event to request meeting notes creation" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickNlpMetadata": { -"description": "Metadata about the NLP interpretation of the query.", -"id": "EnterpriseTopazSidekickNlpMetadata", -"properties": { -"confidence": { -"description": "Confidence of the interpretation that generated this card.", -"format": "float", -"type": "number" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo": { -"description": "Metadata for disambiguation.", -"id": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", -"properties": { -"disambiguation": { -"description": "A list of people that also matched the query. This list is not complete.", -"items": { -"$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson" -}, -"type": "array" -}, -"name": { -"description": "The name that was extracted from the query. This may be in the form of the given name, last name, full name, LDAP, or email address. This name can be considered suitable for displaying to the user and can largely be considered to be normalized (e.g. \"Bob's\" -> \"Bob\").", -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson": { -"description": "A person that also matches the query, but was not selected due to a lower affinity with the requesting user.", -"id": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson", -"properties": { -"person": { -"$ref": "EnterpriseTopazSidekickCommonPerson", -"description": "The profile of this person." -}, -"query": { -"description": "The query that can be used to produce an answer card with the same attribute, but for this person.", -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader": { -"description": "Recommended header to display for the card.", -"id": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", -"properties": { -"title": { -"description": "The suggested title to display. This defaults to the user's query.", -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard": { -"description": "An answer card for a single person.", -"id": "EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard", -"properties": { -"answer": { -"deprecated": true, -"description": "List of answers.", -"items": { -"$ref": "SafeHtmlProto" -}, -"type": "array" -}, -"answerText": { -"$ref": "EnterpriseTopazSidekickAnswerAnswerList", -"description": "List of answers." -}, -"disambiguationInfo": { -"$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", -"description": "Disambiguation information." -}, -"header": { -"$ref": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", -"description": "The header to display for the card." -}, -"responseStatus": { -"description": "The response status.", -"enum": [ -"UNKNOWN", -"SUCCESS", -"MISSING_PERSON", -"MISSING_DATA" -], -"enumDescriptions": [ -"Unknown.", -"Success.", -"No such person was found in the user's domain.", -"A person was found to match the query, but an answer could not be obtained." -], -"type": "string" -}, -"statusMessage": { -"description": "Localized user friendly message to display to the user in the case of missing data or an error.", -"type": "string" -}, -"subject": { -"$ref": "EnterpriseTopazSidekickCommonPerson", -"description": "The profile of the person that was the subject of the query." -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard": { -"description": "An answer card for a list of people that are related to the subject of the query.", -"id": "EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard", -"properties": { -"disambiguationInfo": { -"$ref": "EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo", -"description": "Disambiguation information." -}, -"header": { -"$ref": "EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader", -"description": "The header to display for the card." -}, -"relatedPeople": { -"description": "A list of people that are related to the query subject.", -"items": { -"$ref": "EnterpriseTopazSidekickCommonPerson" -}, -"type": "array" -}, -"relationType": { -"description": "Defines the type of relation the list of people have with the subject of the card.", -"enum": [ -"UNKNOWN", -"DIRECT_REPORTS", -"MANAGER", -"PEERS" -], -"enumDescriptions": [ -"Unknown.", -"Direct reports.", -"The manager.", -"The teammates/peers of the subject." -], -"type": "string" -}, -"responseStatus": { -"description": "The response status.", -"enum": [ -"UNKNOWN", -"SUCCESS", -"MISSING_PERSON", -"MISSING_DATA" -], -"enumDescriptions": [ -"Unknown.", -"Success.", -"No such person was found in the user's domain.", -"A person was found to match the query, but an answer could not be obtained." -], -"type": "string" -}, -"statusMessage": { -"description": "Localized user friendly message to display to the user in the case of missing data or an error.", -"type": "string" -}, -"subject": { -"$ref": "EnterpriseTopazSidekickCommonPerson", -"description": "The profile of the person that was the subject of the query." -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPeopleDisambiguationCard": { -"id": "EnterpriseTopazSidekickPeopleDisambiguationCard", -"properties": { -"person": { -"description": "Candidate persons for the query.", -"items": { -"$ref": "EnterpriseTopazSidekickCommonPerson" -}, -"type": "array" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPerson": { -"description": "Person.", -"id": "EnterpriseTopazSidekickPerson", -"properties": { -"affinityLevel": { -"description": "The level of affinity this person has with the requesting user.", -"enum": [ -"UNKNOWN", -"LOW", -"MEDIUM", -"HIGH" -], -"enumDescriptions": [ -"", -"", -"", -"" -], -"type": "string" -}, -"attendingStatus": { -"description": "Attendance status of the person when included in a meeting event.", -"enum": [ -"AWAITING", -"YES", -"NO", -"MAYBE" -], -"enumDescriptions": [ -"Awaiting for the user to set the status.", -"Attending.", -"Not attending.", -"Tentatively attending." -], -"type": "string" -}, -"email": { -"description": "Email.", -"type": "string" -}, -"gaiaId": { -"deprecated": true, -"description": "Gaia id.", -"format": "int64", -"type": "string" -}, -"isGroup": { -"description": "Whether the invitee is a group.", -"type": "boolean" -}, -"name": { -"description": "Name.", -"type": "string" -}, -"obfuscatedGaiaId": { -"description": "Obfuscated Gaia id.", -"type": "string" -}, -"photoUrl": { -"description": "Absolute URL to the profile photo of the person.", -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPersonProfileCard": { -"id": "EnterpriseTopazSidekickPersonProfileCard", -"properties": { -"relatedPeople": { -"items": { -"$ref": "EnterpriseTopazSidekickPersonProfileCardRelatedPeople" -}, -"type": "array" -}, -"subject": { -"$ref": "EnterpriseTopazSidekickCommonPerson", -"description": "The subject of the card." -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPersonProfileCardRelatedPeople": { -"id": "EnterpriseTopazSidekickPersonProfileCardRelatedPeople", -"properties": { -"relatedPerson": { -"description": "Related people.", -"items": { -"$ref": "EnterpriseTopazSidekickCommonPerson" -}, -"type": "array" -}, -"relation": { -"description": "Relation type.", -"enum": [ -"UNKNOWN", -"MANAGER", -"DIRECT_REPORT" -], -"enumDescriptions": [ -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickPersonalizedDocsCardProto": { -"description": "Personalized docs card proto.", -"id": "EnterpriseTopazSidekickPersonalizedDocsCardProto", -"properties": { -"documentGroup": { -"description": "Document group.", -"items": { -"$ref": "EnterpriseTopazSidekickDocumentGroup" -}, -"type": "array" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickRankingParams": { -"description": "Ranking params.", -"id": "EnterpriseTopazSidekickRankingParams", -"properties": { -"endTimeMs": { -"description": "The end-time that this object will expect to occur. If the type is marked as FIXED, then this end-time will persist after bidding. If the type is marked as FLEXIBLE, this field is NOT expected to be filled and will be filled in after it has won a bid. Expected to be set when type is set to FIXED.", -"format": "uint64", -"type": "string" -}, -"priority": { -"description": "The priority to determine between objects that have the same start_time_ms The lower-value of priority == ranked higher. Max-priority = 0. Expected to be set for all types.", -"enum": [ -"UNKNOWN", -"CRITICAL", -"IMPORTANT", -"HIGH", -"NORMAL", -"BEST_EFFORT" -], -"enumDescriptions": [ -"Unknown (default).", -"Critical.", -"Important.", -"High.", -"Normal.", -"Best effort." -], -"type": "string" -}, -"score": { -"description": "The score of the card to be used to break priority-ties", -"format": "float", -"type": "number" -}, -"spanMs": { -"description": "The span that this card will take in the stream Expected to be set when type is set to FLEXIBLE.", -"format": "uint64", -"type": "string" -}, -"startTimeMs": { -"description": "The start-time that this object will bid-for If the type is marked as FIXED, then this start-time will persist after bidding. If the type is marked as FLEXIBLE, then it will occur at the given time or sometime after the requested time. Expected to be set for all types.", -"format": "uint64", -"type": "string" -}, -"type": { -"description": "The packing type of this object.", -"enum": [ -"FIXED", -"FLEXIBLE" -], -"enumDescriptions": [ -"Fixed, i.e., the card is time sensitive.", -"Flexible, i.e., the card is not time sensitive." -], -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickRecentDocumentsCardProto": { -"id": "EnterpriseTopazSidekickRecentDocumentsCardProto", -"properties": { -"document": { -"items": { -"$ref": "EnterpriseTopazSidekickCommonDocument" -}, -"type": "array" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickScheduledMeeting": { -"description": "Details about scheduled meetings.", -"id": "EnterpriseTopazSidekickScheduledMeeting", -"properties": { -"meetingLocation": { -"description": "The meeting location.", -"type": "string" -}, -"meetingTime": { -"$ref": "EnterpriseTopazSidekickTimeSlot", -"description": "The meeting time slot." -}, -"meetingTitle": { -"description": "The meeting title.", -"type": "string" -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickShareMeetingDocsCardProto": { -"description": "Share meeting docs card proto.", -"id": "EnterpriseTopazSidekickShareMeetingDocsCardProto", -"properties": { -"document": { -"description": "Documents to share for the given meeting.", -"items": { -"$ref": "EnterpriseTopazSidekickCommonDocument" -}, -"type": "array" -}, -"event": { -"$ref": "EnterpriseTopazSidekickAgendaEntry", -"description": "Event." -} -}, -"type": "object" -}, -"EnterpriseTopazSidekickTimeSlot": { -"description": "Slot of time.", -"id": "EnterpriseTopazSidekickTimeSlot", -"properties": { -"endTimeDay": { -"description": "Day end time at the user's timezone.", -"type": "string" -}, -"endTimeHourAndMinute": { -"description": "Hour and minute of the end time at the user's timezone.", -"type": "string" -}, -"endTimeInMillis": { -"description": "End time in milliseconds.", -"format": "int64", -"type": "string" -}, -"startTimeDay": { -"description": "Day start time at user's timezone.", -"type": "string" -}, -"startTimeHourAndMinute": { -"description": "Hour and minute of the start time at the user's timezone.", -"type": "string" -}, -"startTimeInMillis": { -"description": "Start time in milliseconds.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, -"EnumOperatorOptions": { -"description": "Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* returns items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*.", -"id": "EnumOperatorOptions", -"properties": { -"operatorName": { -"description": "Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", -"type": "string" -} -}, -"type": "object" -}, -"EnumPropertyOptions": { -"description": "The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*.", -"id": "EnumPropertyOptions", -"properties": { -"operatorOptions": { -"$ref": "EnumOperatorOptions", -"description": "If set, describes how the enum should be used as a search operator." -}, -"orderedRanking": { -"description": "Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false.", -"enum": [ -"NO_ORDER", -"ASCENDING", -"DESCENDING" -], -"enumDescriptions": [ -"There is no ranking order for the property. Results aren't adjusted by this property's value.", -"This property is ranked in ascending order. Lower values indicate lower ranking.", -"This property is ranked in descending order. Lower values indicate higher ranking." -], -"type": "string" -}, -"possibleValues": { -"description": "The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100.", -"items": { -"$ref": "EnumValuePair" -}, -"type": "array" -} -}, -"type": "object" -}, -"EnumValuePair": { -"description": "The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking.", -"id": "EnumValuePair", -"properties": { -"integerValue": { -"description": "The integer value of the EnumValuePair which must be non-negative. Optional.", -"format": "int32", -"type": "integer" -}, -"stringValue": { -"description": "The string value of the EnumValuePair. The maximum length is 32 characters.", -"type": "string" -} -}, -"type": "object" -}, -"EnumValues": { -"description": "List of enum values.", -"id": "EnumValues", -"properties": { -"values": { -"description": "The maximum allowable length for string values is 32 characters.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"ErrorInfo": { -"description": "Error information about the response.", -"id": "ErrorInfo", -"properties": { -"errorMessages": { -"items": { -"$ref": "ErrorMessage" -}, -"type": "array" -} -}, -"type": "object" -}, -"ErrorMessage": { -"description": "Error message per source response.", -"id": "ErrorMessage", -"properties": { -"errorMessage": { -"type": "string" -}, -"source": { -"$ref": "Source" -} -}, -"type": "object" -}, -"FacetBucket": { -"description": "A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.", -"id": "FacetBucket", -"properties": { -"count": { -"description": "Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned.", -"format": "int32", -"type": "integer" -}, -"filter": { -"$ref": "Filter", -"description": "Filter to be passed in the search request if the corresponding bucket is selected." -}, -"percentage": { -"description": "Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.", -"format": "int32", -"type": "integer" -}, -"value": { -"$ref": "Value" -} -}, -"type": "object" -}, -"FacetOptions": { -"description": "Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.", -"id": "FacetOptions", -"properties": { -"integerFacetingOptions": { -"$ref": "IntegerFacetingOptions", -"description": "If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets." -}, -"numFacetBuckets": { -"description": "Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.", -"format": "int32", -"type": "integer" -}, -"objectType": { -"description": "If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.", -"type": "string" -}, -"operatorName": { -"description": "The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions", -"type": "string" -}, -"sourceName": { -"description": "Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.", -"type": "string" -} -}, -"type": "object" -}, -"FacetResult": { -"description": "Source specific facet response", -"id": "FacetResult", -"properties": { -"buckets": { -"description": "FacetBuckets for values in response containing at least a single result with the corresponding filter.", -"items": { -"$ref": "FacetBucket" -}, -"type": "array" -}, -"objectType": { -"description": "Object type for which facet results are returned. Can be empty.", -"type": "string" -}, -"operatorName": { -"description": "The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions", -"type": "string" -}, -"sourceName": { -"description": "Source name for which facet results are returned. Will not be empty.", -"type": "string" -} -}, -"type": "object" -}, -"FieldViolation": { -"id": "FieldViolation", -"properties": { -"description": { -"description": "The description of the error.", -"type": "string" -}, -"field": { -"description": "Path of field with violation.", -"type": "string" -} -}, -"type": "object" -}, -"Filter": { -"description": "A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.", -"id": "Filter", -"properties": { -"compositeFilter": { -"$ref": "CompositeFilter" -}, -"valueFilter": { -"$ref": "ValueFilter" -} -}, -"type": "object" -}, -"FilterOptions": { -"description": "Filter options to be applied on query.", -"id": "FilterOptions", -"properties": { -"filter": { -"$ref": "Filter", -"description": "Generic filter to restrict the search, such as `lang:en`, `site:xyz`." -}, -"objectType": { -"description": "If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.", -"type": "string" -} -}, -"type": "object" -}, -"FreshnessOptions": { -"description": "Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.", -"id": "FreshnessOptions", -"properties": { -"freshnessDuration": { -"description": "The duration after which an object should be considered stale. The default value is 180 days (in seconds).", -"format": "google-duration", -"type": "string" -}, -"freshnessProperty": { -"description": "This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time.", -"type": "string" -} -}, -"type": "object" -}, -"GSuitePrincipal": { -"id": "GSuitePrincipal", -"properties": { -"gsuiteDomain": { -"description": "This principal represents all users of the Google Workspace domain of the customer.", -"type": "boolean" -}, -"gsuiteGroupEmail": { -"description": "This principal references a Google Workspace group name.", -"type": "string" -}, -"gsuiteUserEmail": { -"description": "This principal references a Google Workspace user account.", -"type": "string" -} -}, -"type": "object" -}, -"GeostoreFeatureIdProto": { -"description": "A globally unique identifier associated with each feature. We use 128-bit identifiers so that we have lots of bits available to distinguish between features. The feature id currently consists of a 64-bit \"cell id\" that **sometimes** corresponds to the approximate centroid of the feature, plus a 64-bit fingerprint of other identifying information. See more on each respective field in its comments. Feature ids are first assigned when the data is created in MapFacts. After initial creation of the feature, they are immutable. This means that the only properties that you should rely on are that they are unique, and that cell_ids often - but not always - preserve spatial locality. The degree of locality varies as the feature undergoes geometry changes, and should not in general be considered a firm guarantee of the location of any particular feature. In fact, some locationless features have randomized cell IDs! Consumers of FeatureProtos from Mapfacts are guaranteed that fprints in the id field of features will be globally unique. Using the fprint allows consumers who don't need the spatial benefit of cell ids to uniquely identify features in a 64-bit address space. This property is not guaranteed for other sources of FeatureProtos.", -"id": "GeostoreFeatureIdProto", -"properties": { -"cellId": { -"description": "The S2CellId corresponding to the approximate location of this feature as of when it was first created. This can be of variable accuracy, ranging from the exact centroid of the feature at creation, a very large S2 Cell, or even being completely randomized for locationless features. Cell ids have the nice property that they follow a space-filling curve over the surface of the earth. (See s2cellid.h for details.) WARNING: Clients should only use cell IDs to perform spatial locality optimizations. There is no strict guarantee that the cell ID of a feature is related to the current geometry of the feature in any way.", -"format": "uint64", -"type": "string" -}, -"fprint": { -"description": "A 64-bit fingerprint used to identify features. Most clients should rely on MapFacts or OneRing to choose fingerprints. If creating new fprints, the strategy should be chosen so that the chance of collision is remote or non-existent, and the distribution should be reasonably uniform. For example, if the source data assigns unique ids to features, then a fingerprint of the provider name, version, and source id is sufficient.", -"format": "uint64", -"type": "string" -}, -"temporaryData": { -"$ref": "MessageSet", -"description": "A place for clients to attach arbitrary data to a feature ID. Never set in MapFacts." -} -}, -"type": "object" -}, -"GeostoreFieldMetadataProto": { -"description": "Internal field metadata. This part is not exposed to downstream consumers of the repository (read-only clients) but is available to upstream providers to the repository (read-write clients).", -"id": "GeostoreFieldMetadataProto", -"properties": { -"internal": { -"$ref": "GeostoreInternalFieldMetadataProto" -} -}, -"type": "object" -}, -"GeostoreInternalFieldMetadataProto": { -"id": "GeostoreInternalFieldMetadataProto", -"properties": { -"isAuto": { -"description": "Whether or not the piece of data has been generated automatically (i.e., by a bot/automated process based on heuristics/algorithms rather than coming as a fact set by some human user or data provider based on their knowledge). Note that this does NOT imply that the value was set as a result of a bot operation on the repository, since it is conceivable to use a bot/automated process simply as a way of convenience to ingest large amount of canonical/ground truth data.", -"type": "boolean" -}, -"sourceSummary": { -"$ref": "GeostoreInternalSourceSummaryProto", -"description": "Information about the source providing the piece of data this metadata is attached to." -} -}, -"type": "object" -}, -"GeostoreInternalSourceSummaryProto": { -"id": "GeostoreInternalSourceSummaryProto", -"properties": { -"dataset": { -"description": "Within the above provider, the dataset from which this piece of data was generated. For fields that are auto-generated the \"dataset\" is likely to be some algorithm's or program's name. Similar to SourceInfoProto.dataset but with the difference that it is required to always be set. Providers that don't have a concept of dataset may use \"default\".", -"type": "string" -}, -"provider": { -"description": "The data provider from which this piece of data was generated. Equivalent to SourceInfoProto.provider in the public schema.", -"enum": [ -"PROVIDER_ANY", -"PROVIDER_UNKNOWN", -"PROVIDER_NAVTEQ", -"PROVIDER_TELE_ATLAS", -"PROVIDER_TELE_ATLAS_MULTINET", -"PROVIDER_TELE_ATLAS_CODEPOINT", -"PROVIDER_TELE_ATLAS_GEOPOST", -"PROVIDER_TELE_ATLAS_DATAGEO", -"PROVIDER_TELE_ATLAS_ADDRESS_POINTS", -"PROVIDER_TELCONTAR", -"PROVIDER_EUROPA", -"PROVIDER_ROYAL_MAIL", -"PROVIDER_GOOGLE", -"PROVIDER_GOOGLE_HAND_EDIT", -"PROVIDER_GOOGLE_BORDERS", -"PROVIDER_GOOGLE_SUBRANGE", -"PROVIDER_GOOGLE_GT_FUSION", -"PROVIDER_GOOGLE_ZAGAT_CMS", -"PROVIDER_GOOGLE_PLACE_NAVBOOST", -"PROVIDER_GOOGLE_FOOTPRINT", -"PROVIDER_GOOGLE_PRODUCT_TERMS", -"PROVIDER_GOOGLE_POINTCARDS", -"PROVIDER_GOOGLE_BUSINESS_CHAINS", -"PROVIDER_GOOGLE_LOCAL_SUMMARIZATION", -"PROVIDER_GOOGLE_PRONUNCIATIONS", -"PROVIDER_GOOGLE_DUMPLING", -"PROVIDER_GOOGLE_DISTILLERY", -"PROVIDER_GOOGLE_LOCAL_ATTRIBUTE_SUMMARIZATION", -"PROVIDER_GOOGLE_RELATION_MINER", -"PROVIDER_GOOGLE_MAPSPAM", -"PROVIDER_GOOGLE_ROSE", -"PROVIDER_GOOGLE_LOCAL_PLACE_RATINGS", -"PROVIDER_GOOGLE_WIPEOUT", -"PROVIDER_GOOGLE_KNOWLEDGE_GRAPH", -"PROVIDER_GOOGLE_BEEGEES", -"PROVIDER_GOOGLE_REVIEW_SUMMARIZATION", -"PROVIDER_GOOGLE_OFFLINE_NON_CORE_ATTRIBUTE_SUMMARIZATION", -"PROVIDER_GOOGLE_GEO_WORLDMAPS", -"PROVIDER_GOOGLE_GEO_MODERATION", -"PROVIDER_GOOGLE_OYSTER_AUTO_EDITS", -"PROVIDER_GOOGLE_LOCAL_ALCHEMY", -"PROVIDER_GOOGLE_KEROUAC", -"PROVIDER_GOOGLE_MOBRANK", -"PROVIDER_GOOGLE_RAPTURE", -"PROVIDER_GOOGLE_CULTURAL_INSTITUTE", -"PROVIDER_GOOGLE_GEOCODES_FROM_LOCAL_FEEDS", -"PROVIDER_GOOGLE_ATTRIBUTES_FROM_CRAWLED_CHAINS", -"PROVIDER_GOOGLE_TACTILE_MAPS", -"PROVIDER_GOOGLE_MAPS_FOR_MOBILE", -"PROVIDER_GOOGLE_GEO_REALTIME", -"PROVIDER_GOOGLE_PROMINENT_PLACES", -"PROVIDER_GOOGLE_PLACE_ACTIONS", -"PROVIDER_GOOGLE_GT_AUTO_EDITS", -"PROVIDER_GOOGLE_WAZE", -"PROVIDER_GOOGLE_ONTHEGO", -"PROVIDER_GOOGLE_GT_IMPORT", -"PROVIDER_GOOGLE_STRUCTURED_DATA", -"PROVIDER_GOOGLE_HELICOPTER", -"PROVIDER_GOOGLE_ROLLBACK", -"PROVIDER_GOOGLE_RIGHTS_REPAIR", -"PROVIDER_GOOGLE_PERFUME", -"PROVIDER_GOOGLE_MAPS_TRANSLATION", -"PROVIDER_GOOGLE_CALL_ME_MAYBE", -"PROVIDER_GOOGLE_LOCAL_UNIVERSAL", -"PROVIDER_GOOGLE_CROUPIER", -"PROVIDER_GOOGLE_SKYSMART", -"PROVIDER_GOOGLE_RIDDLER", -"PROVIDER_GOOGLE_ROADCLOSURES", -"PROVIDER_GOOGLE_SPORE", -"PROVIDER_GOOGLE_LOCALIZATION", -"PROVIDER_GOOGLE_CATTERMS", -"PROVIDER_GOOGLE_GT_FIELD_OPS", -"PROVIDER_GOOGLE_MATCHMAKER", -"PROVIDER_GOOGLE_ARBITRATION", -"PROVIDER_GOOGLE_BIZBUILDER_OPS", -"PROVIDER_GOOGLE_LOCAL_INVENTORY_ADS", -"PROVIDER_GOOGLE_GT_DRAFTY", -"PROVIDER_GOOGLE_HOTELADS_OPS", -"PROVIDER_GOOGLE_MARKERS", -"PROVIDER_GOOGLE_STATE_MACHINE", -"PROVIDER_GOOGLE_ATTRIBUTES_INFERENCE", -"PROVIDER_GOOGLE_BIKESHARE", -"PROVIDER_GOOGLE_GHOSTWRITER", -"PROVIDER_GOOGLE_EDIT_PLATFORM", -"PROVIDER_GOOGLE_BLUE_GINGER", -"PROVIDER_GOOGLE_GEO_TIGER", -"PROVIDER_GOOGLE_HYADES", -"PROVIDER_GOOGLE_WEBQUARRY", -"PROVIDER_GOOGLE_GEO_MADDEN", -"PROVIDER_GOOGLE_ANDROID_PAY", -"PROVIDER_GOOGLE_OPENING_HOURS_TEAM", -"PROVIDER_GOOGLE_LOCAL_DISCOVERY", -"PROVIDER_GOOGLE_LOCAL_HEALTH", -"PROVIDER_GOOGLE_UGC_MAPS", -"PROVIDER_GOOGLE_FIBER", -"PROVIDER_GOOGLE_REVGEO", -"PROVIDER_GOOGLE_HOTELADS_PARTNER_FRONT_END", -"PROVIDER_GOOGLE_GEO_UGC_TASKS", -"PROVIDER_GOOGLE_GEOCODING", -"PROVIDER_GOOGLE_SPYGLASS", -"PROVIDER_GOOGLE_PLUS_CODES_AS_ADDRESSES", -"PROVIDER_GOOGLE_GEO_CHANGES", -"PROVIDER_GOOGLE_HUME", -"PROVIDER_GOOGLE_MEGAMIND", -"PROVIDER_GOOGLE_GT_ROADSYNTH", -"PROVIDER_GOOGLE_FIREBOLT", -"PROVIDER_GOOGLE_LOCAL_PLACE_OFFERINGS", -"PROVIDER_GOOGLE_UGC_SERVICES", -"PROVIDER_GOOGLE_GEOALIGN", -"PROVIDER_GOOGLE_GT_COMPOUNDS", -"PROVIDER_GOOGLE_FOOD_ORDERING", -"PROVIDER_GOOGLE_HOTEL_KNOWLEDGE_OPS", -"PROVIDER_GOOGLE_URAW", -"PROVIDER_GOOGLE_FLYEYE", -"PROVIDER_GOOGLE_YOUKE", -"PROVIDER_GOOGLE_GT_ZEPHYR", -"PROVIDER_GOOGLE_USER_SAFETY", -"PROVIDER_GOOGLE_ADDRESS_MAKER", -"PROVIDER_GOOGLE_UGC_PHOTOS", -"PROVIDER_GOOGLE_GT_WINDCHIME", -"PROVIDER_GOOGLE_SNAG_FIXER", -"PROVIDER_GOOGLE_GEO_DEALS", -"PROVIDER_GOOGLE_LOCAL_PLACE_TOPICS", -"PROVIDER_GOOGLE_PROPERTY_INSIGHTS", -"PROVIDER_GOOGLE_GEO_CONSUMER_MERCHANT_EXPERIMENTS", -"PROVIDER_GOOGLE_GEO_PORTKEY", -"PROVIDER_GOOGLE_ROAD_MAPPER", -"PROVIDER_GOOGLE_LOCATION_PLATFORM", -"PROVIDER_GOOGLE_POSTTRIP", -"PROVIDER_GOOGLE_TRAVEL_DESTINATION", -"PROVIDER_GOOGLE_GEO_DATA_UPLOAD", -"PROVIDER_GOOGLE_BIZBUILDER_CLEANUP", -"PROVIDER_GOOGLE_USER", -"PROVIDER_GOOGLE_STATION", -"PROVIDER_GOOGLE_GEO_FOOD", -"PROVIDER_GOOGLE_GEO_AR", -"PROVIDER_GOOGLE_GEO_TEMPORAL", -"PROVIDER_GOOGLE_SERVICES_MARKETPLACE", -"PROVIDER_GOOGLE_IMT_CLEANUP", -"PROVIDER_GOOGLE_GEO_FOOD_MENU", -"PROVIDER_GOOGLE_CARENAV", -"PROVIDER_GOOGLE_DRIVING_FEEDS", -"PROVIDER_GOOGLE_DRIVING_UGC", -"PROVIDER_GOOGLE_POLAR", -"PROVIDER_GOOGLE_TRIWILD", -"PROVIDER_GOOGLE_CROWD_COMPUTE_OPS", -"PROVIDER_GOOGLE_SA_FROM_WEB", -"PROVIDER_GOOGLE_POI_ALIGNMENT", -"PROVIDER_GOOGLE_SA_FROM_HULK", -"PROVIDER_GOOGLE_SERVICES_INTERACTIONS", -"PROVIDER_GOOGLE_ROADS_UGC_EDITOR", -"PROVIDER_GOOGLE_SA_FROM_NG_INFERENCE", -"PROVIDER_GOOGLE_GEO_DRIVING_VIZ", -"PROVIDER_GOOGLE_GEO_TASKING", -"PROVIDER_GOOGLE_CROWDTASK_DATACOMPUTE", -"PROVIDER_GOOGLE_CROWDTASK_TASKADS", -"PROVIDER_GOOGLE_CROWDTASK_TASKMATE", -"PROVIDER_GOOGLE_CROWDTASK_FURBALL", -"PROVIDER_GOOGLE_CROWDTASK_ADAP", -"PROVIDER_GOOGLE_GPAY", -"PROVIDER_GOOGLE_GEO_UGC_TRUSTED_USERS", -"PROVIDER_GOOGLE_THIRD_PARTY_DATA_PRODUCTION", -"PROVIDER_GOOGLE_GEOTRACKER", -"PROVIDER_GOOGLE_LOCAL_LANDMARK_INFERENCE", -"PROVIDER_GOOGLE_GEO_CLOSED_LOOP", -"PROVIDER_GOOGLE_SA_FROM_MERCHANT_POSTS", -"PROVIDER_GOOGLE_CORE_DATA_RIGHTS", -"PROVIDER_GOOGLE_SA_FROM_USER_REVIEWS", -"PROVIDER_GOOGLE_GEO_CONTENT_FIXER", -"PROVIDER_GOOGLE_POLYGON_REFINEMENT", -"PROVIDER_GOOGLE_HANASU", -"PROVIDER_GOOGLE_FULLRIGHTS_GEO_DATA_UPLOAD", -"PROVIDER_GOOGLE_FULLRIGHTS_3P_OUTREACH_UPLOAD", -"PROVIDER_GOOGLE_ATTRIBUTION_3P_OUTREACH_UPLOAD", -"PROVIDER_GOOGLE_SA_FROM_FOOD_MENUS", -"PROVIDER_GOOGLE_GT_CONSISTENCY_EDITS", -"PROVIDER_GOOGLE_SA_QUALITY", -"PROVIDER_GOOGLE_GDCE_CLEANUP", -"PROVIDER_GOOGLE_UGC_QUALITY_CHAINS", -"PROVIDER_GOOGLE_ATTRIBUTES_DISCOVERY", -"PROVIDER_GOOGLE_GEO_LDE", -"PROVIDER_GOOGLE_GEO_SIGNAL_TRACKING", -"PROVIDER_GOOGLE_UGC_AGGREGATION", -"PROVIDER_GOOGLE_3D_BASEMAP", -"PROVIDER_GOOGLE_MAPFACTS_PRIVACY", -"PROVIDER_GOOGLE_GT_ALF", -"PROVIDER_GOOGLE_GT_OPERATOR_PROVENANCE", -"PROVIDER_GOOGLE_LOCAL_SERVICES_ADS", -"PROVIDER_GOOGLE_GT_LANE_AUTOMATION", -"PROVIDER_GOOGLE_GEO_NG_LOCAL", -"PROVIDER_GOOGLE_MAPFACTS_CLEANUP", -"PROVIDER_GOOGLE_THIRD_PARTY_UGC", -"PROVIDER_GOOGLE_GEO_ISSUE_ADMIN", -"PROVIDER_GOOGLE_VACATION_RENTAL_PARTNERS", -"PROVIDER_GOOGLE_FEED_PROCESSOR_ROAD_INCIDENTS", -"PROVIDER_GOOGLE_DYNAMIC_BASEMAP", -"PROVIDER_GOOGLE_LOCAL_SERVICES_ADS_EMEA", -"PROVIDER_GOOGLE_LOCALSEARCH", -"PROVIDER_GOOGLE_TRANSIT", -"PROVIDER_GOOGLE_GEOWIKI", -"PROVIDER_GOOGLE_CHINA_LOCAL_TEAM", -"PROVIDER_GOOGLE_SYNTHESIZED", -"PROVIDER_GOOGLE_INTERNAL_TEST", -"PROVIDER_GOOGLE_DISPUTED_AREAS", -"PROVIDER_GOOGLE_3DWAREHOUSE", -"PROVIDER_GOOGLE_GROUNDS_BUILDER", -"PROVIDER_GOOGLE_SESAME", -"PROVIDER_GOOGLE_GT", -"PROVIDER_GOOGLE_GT_BASEMAP_UPLOAD", -"PROVIDER_GOOGLE_ADSDB", -"PROVIDER_GOOGLE_MACHINE_TRANSLITERATION", -"PROVIDER_GOOGLE_TRAVELSEARCH", -"PROVIDER_GOOGLE_PANORAMIO", -"PROVIDER_GOOGLE_YOUTUBE", -"PROVIDER_GOOGLE_OLD", -"PROVIDER_GOOGLE_STREETVIEW", -"PROVIDER_GOOGLE_STREETVIEW_BIZVIEW", -"PROVIDER_GOOGLE_ZIPIT", -"PROVIDER_GOOGLE_OYSTER_CONNECT_ROUTES", -"PROVIDER_GOOGLE_GOLDEN", -"PROVIDER_GOOGLE_INNERSPACE", -"PROVIDER_GOOGLE_MAPSEARCH", -"PROVIDER_GOOGLE_CATEGORIES_TEAM", -"PROVIDER_GOOGLE_CROWDSENSUS", -"PROVIDER_GOOGLE_LOCAL_ALGORITHMIC_IDENTITY", -"PROVIDER_GOOGLE_FREEBASE", -"PROVIDER_GOOGLE_HOTELADS", -"PROVIDER_GOOGLE_AUTHORITY_PAGES", -"PROVIDER_GOOGLE_PLACES_API", -"PROVIDER_GOOGLE_NAMEHEATMAP", -"PROVIDER_GOOGLE_MAPMAKER", -"PROVIDER_GOOGLE_MAPMAKER_MOBILE", -"PROVIDER_GOOGLE_MAPMAKER_PANCAKE", -"PROVIDER_GOOGLE_MAPMAKER_V2", -"PROVIDER_GOOGLE_LOCAL_CLUSTERING_OPERATOR_OVERRIDE", -"PROVIDER_GOOGLE_SERVED_ON_MAPMAKER", -"PROVIDER_GOOGLE_GT_LOCAL", -"PROVIDER_GOOGLE_GT_LOCAL_WITH_RIGHTS", -"PROVIDER_GOOGLE_LOGS_RANKING_SIGNALS", -"PROVIDER_GOOGLE_ENTITY_NAVBOOST", -"PROVIDER_GOOGLE_RELATED_PLACES", -"PROVIDER_GOOGLE_KNOWN_FOR_TERMS", -"PROVIDER_GOOGLE_SYNTHETIC_AREAS", -"PROVIDER_GOOGLE_AUTHORITY_PAGE_PHOTOS", -"PROVIDER_GOOGLE_CROSS_STREETS", -"PROVIDER_GOOGLE_CORRIDORS", -"PROVIDER_GOOGLE_BICYCLE_RENTAL", -"PROVIDER_GOOGLE_CONCRETE_URLS", -"PROVIDER_GOOGLE_LEANBACK", -"PROVIDER_GOOGLE_LOCKED_LISTINGS", -"PROVIDER_GOOGLE_MONITORING", -"PROVIDER_GOOGLE_SPROUT", -"PROVIDER_GOOGLE_LOCAL_SEARCH_QUALITY", -"PROVIDER_GOOGLE_GOBY", -"PROVIDER_GOOGLE_PROBLEM_REPORT", -"PROVIDER_GOOGLE_CANDID", -"PROVIDER_GOOGLE_BIZBUILDER", -"PROVIDER_AUTOMOTIVE_NAVIGATION_DATA", -"PROVIDER_MAPDATA_SCIENCES", -"PROVIDER_MAPONICS", -"PROVIDER_SKI_RESORTS", -"PROVIDER_ZENRIN", -"PROVIDER_SANBORN", -"PROVIDER_URBAN_MAPPING", -"PROVIDER_US_GOVERNMENT", -"PROVIDER_US_CENSUS", -"PROVIDER_US_POSTAL_SERVICE", -"PROVIDER_US_GEOLOGICAL_SURVEY", -"PROVIDER_US_GNIS", -"PROVIDER_US_LANDSAT", -"PROVIDER_US_NATIONAL_GEOSPATIAL_INTELLIGENCE_AGENCY", -"PROVIDER_US_NGA_GNS", -"PROVIDER_US_SSIBL", -"PROVIDER_US_BUREAU_OF_TRANSPORTATION_STATISTICS", -"PROVIDER_US_NATIONAL_OCEANIC_AND_ATMOSPHERIC_ADMINISTRATION", -"PROVIDER_US_POLAR_GEOSPATIAL_CENTER", -"PROVIDER_US_DEPARTMENT_OF_AGRICULTURE", -"PROVIDER_US_NPI_REGISTRY", -"PROVIDER_US_BUREAU_OF_INDIAN_AFFAIRS", -"PROVIDER_DMTI_SPATIAL", -"PROVIDER_INTERNATIONAL_HYDROGRAPHIC_ORGANIZATION", -"PROVIDER_MAPLINK", -"PROVIDER_KINGWAY", -"PROVIDER_GEOCENTRE", -"PROVIDER_CN_NATIONAL_FOUNDAMENTAL_GIS", -"PROVIDER_CN_MAPABC", -"PROVIDER_SMITHSONIAN_INSTITUTE", -"PROVIDER_TRACKS_FOR_AFRICA", -"PROVIDER_PPWK", -"PROVIDER_LEADDOG", -"PROVIDER_CENTRE_DONNEES_ASTRONOMIQUES_STRASBOURG", -"PROVIDER_GISRAEL", -"PROVIDER_BASARSOFT", -"PROVIDER_MAPINFO", -"PROVIDER_MAPIT", -"PROVIDER_GEOBASE", -"PROVIDER_ORION", -"PROVIDER_CENTRAL_EUROPEAN_DATA_AGENCY", -"PROVIDER_ANASAT", -"PROVIDER_MINED_POSTCODES", -"PROVIDER_DMAPAS", -"PROVIDER_COMMON_LOCALE_DATA_REPOSITORY", -"PROVIDER_CH_SBB", -"PROVIDER_SKENERGY", -"PROVIDER_GBRMPA", -"PROVIDER_KOREA_POST", -"PROVIDER_CN_AUTONAVI", -"PROVIDER_MINED_POI", -"PROVIDER_ML_INFOMAP", -"PROVIDER_SNOOPER", -"PROVIDER_GEOSISTEMAS", -"PROVIDER_AFRIGIS", -"PROVIDER_TRANSNAVICOM", -"PROVIDER_EASYCONNECT", -"PROVIDER_LANTMATERIET", -"PROVIDER_LOGICA", -"PROVIDER_MAPKING", -"PROVIDER_DIANPING", -"PROVIDER_GEONAV", -"PROVIDER_HEIBONSHA", -"PROVIDER_DEUTSCHE_TELEKOM", -"PROVIDER_LINGUISTIC_DATA_CONSORTIUM", -"PROVIDER_ACXIOM", -"PROVIDER_DUN_AND_BRADSTREET", -"PROVIDER_FEDERAL_AVIATION_ADMINISTRATION", -"PROVIDER_INFOUSA", -"PROVIDER_INFOUSA_NIXIE", -"PROVIDER_THOMSON_LOCAL", -"PROVIDER_TELEFONICA_PUBLICIDAD_E_INFORMACION", -"PROVIDER_WIKIPEDIA", -"PROVIDER_INFOBEL", -"PROVIDER_MX_GOVERNMENT", -"PROVIDER_MX_NATIONAL_INSTITUTE_STATISTICS_GEOGRAPHY", -"PROVIDER_MX_SERVICIO_POSTAL_MEXICANO", -"PROVIDER_TELEGATE", -"PROVIDER_TELELISTAS", -"PROVIDER_MAPCITY", -"PROVIDER_EXPLAINER_DC", -"PROVIDER_DAIKEI", -"PROVIDER_NL_CHAMBER_OF_COMMERCE", -"PROVIDER_KOREA_INFO_SERVICE", -"PROVIDER_WIKITRAVEL", -"PROVIDER_FLICKR", -"PROVIDER_DIANCO", -"PROVIDER_VOLT_DELTA", -"PROVIDER_SG_GOVERNMENT", -"PROVIDER_SG_LAND_TRANSPORT_AUTHORITY", -"PROVIDER_MAPBAR", -"PROVIDER_LONGTU", -"PROVIDER_SA_GOVERNMENT", -"PROVIDER_SA_SAUDI_POST", -"PROVIDER_PEAKLIST", -"PROVIDER_LOCAL_BUSINESS_CENTER", -"PROVIDER_LOCAL_FEED_XML", -"PROVIDER_WEB", -"PROVIDER_RAILS_TO_TRAILS", -"PROVIDER_INDIACOM", -"PROVIDER_INFOMEDIA", -"PROVIDER_PICASA", -"PROVIDER_AT_GOVERNMENT", -"PROVIDER_AT_BUNDESAMT_FUR_EICH_UND_VERMESSUNGSWESEN", -"PROVIDER_AT_NATIONAL_TOURIST_OFFICE", -"PROVIDER_AT_AUSTRIA_POST", -"PROVIDER_NO_GOVERNMENT", -"PROVIDER_NO_NORSK_EIENDOMSINFORMASJON", -"PROVIDER_NO_POSTEN_NORGE_AS", -"PROVIDER_CH_GOVERNMENT", -"PROVIDER_CH_SWISS_POST", -"PROVIDER_CH_SWISSTOPO", -"PROVIDER_CH_SWISS_NATIONAL_PARK", -"PROVIDER_NAVIT", -"PROVIDER_GEOSEARCH", -"PROVIDER_DE_GOVERNMENT", -"PROVIDER_BUNDESAMT_KARTOGRAPHIE_UND_GEODASIE", -"PROVIDER_BUNDESNETZAGENTUR", -"PROVIDER_SCHOBER_GROUP", -"PROVIDER_MIREO", -"PROVIDER_PUBLIC_MUNICIPALITY", -"PROVIDER_US_PUBLIC_MUNICIPALITY", -"PROVIDER_US_PUBLIC_MUNICIPALITY_WEBSTER_TEXAS", -"PROVIDER_US_PUBLIC_MUNICIPALITY_AMHERST_MASSACHUSETTS", -"PROVIDER_US_PUBLIC_MUNICIPALITY_BLOOMINGTON_INDIANA", -"PROVIDER_US_PUBLIC_MUNICIPALITY_PASADENA_CALIFORNIA", -"PROVIDER_US_PUBLIC_MUNICIPALITY_CHULA_VISTA_CALIFORNIA", -"PROVIDER_US_PUBLIC_MUNICIPALITY_TEMPE_ARIZONA", -"PROVIDER_US_PUBLIC_MUNICIPALITY_COLUMBUS_OHIO", -"PROVIDER_US_PUBLIC_MUNICIPALITY_PORTAGE_MICHIGAN", -"PROVIDER_US_PUBLIC_MUNICIPALITY_GEORGETOWN_KENTUCKY", -"PROVIDER_US_PUBLIC_MUNICIPALITY_GREENVILLE_SOUTH_CAROLINA", -"PROVIDER_US_PUBLIC_MUNICIPALITY_NASHVILLE_TENNESSEE", -"PROVIDER_US_PUBLIC_MUNICIPALITY_WASHINGTON_DISTRICT_OF_COLUMBIA", -"PROVIDER_US_PUBLIC_MUNICIPALITY_BOULDER_COLORADO", -"PROVIDER_NZ_PUBLIC_MUNICIPALITY", -"PROVIDER_NZ_PUBLIC_MUNICIPALITY_ENVIRONMENT_BAY", -"PROVIDER_PL_PUBLIC_MUNICIPALITY", -"PROVIDER_PL_PUBLIC_MUNICIPALITY_BIELSKO_BIALA", -"PROVIDER_DE_PUBLIC_MUNICIPALITY", -"PROVIDER_DE_PUBLIC_MUNICIPALITY_FRANKFURT", -"PROVIDER_DE_PUBLIC_MUNICIPALITY_HAMBURG", -"PROVIDER_DE_PUBLIC_MUNICIPALITY_KARLSRUHE", -"PROVIDER_PT_PUBLIC_MUNICIPALITY", -"PROVIDER_PT_PUBLIC_MUNICIPALITY_SANTA_CRUZ", -"PROVIDER_AT_PUBLIC_MUNICIPALITY", -"PROVIDER_AT_PUBLIC_MUNICIPALITY_KLAGENFURT", -"PROVIDER_AT_PUBLIC_MUNICIPALITY_LINZ", -"PROVIDER_ES_PUBLIC_MUNICIPALITY", -"PROVIDER_ES_PUBLIC_MUNICIPALITY_AZKOITIA", -"PROVIDER_ES_PUBLIC_MUNICIPALITY_BEASAIN", -"PROVIDER_ES_PUBLIC_MUNICIPALITY_GIRONA", -"PROVIDER_ES_PUBLIC_MUNICIPALITY_SAN_SEBASTIAN", -"PROVIDER_ES_PUBLIC_MUNICIPALITY_CATALUNYA", -"PROVIDER_ES_PUBLIC_MUNICIPALITY_HONDARRIBIA", -"PROVIDER_AU_PUBLIC_MUNICIPALITY", -"PROVIDER_AU_PUBLIC_MUNICIPALITY_LAUNCESTON_TASMANIA", -"PROVIDER_IS_PUBLIC_MUNICIPALITY", -"PROVIDER_IS_PUBLIC_MUNICIPALITY_REYKJAVIK", -"PROVIDER_NL_PUBLIC_MUNICIPALITY", -"PROVIDER_NL_PUBLIC_MUNICIPALITY_AMELSTEVEEN", -"PROVIDER_BE_PUBLIC_MUNICIPALITY", -"PROVIDER_BE_PUBLIC_MUNICIPALITY_ANTWERPEN", -"PROVIDER_CA_PUBLIC_MUNICIPALITY", -"PROVIDER_CA_PUBLIC_MUNICIPALITY_FREDERICTON_NEW_BRUNSWICK", -"PROVIDER_CA_PUBLIC_MUNICIPALITY_KAMLOOPS_BRITISH_COLUMBIA", -"PROVIDER_CA_PUBLIC_MUNICIPALITY_NANAIMO_BRITISH_COLUMBIA", -"PROVIDER_CA_PUBLIC_MUNICIPALITY_BANFF_ALBERTA", -"PROVIDER_CA_PUBLIC_MUNICIPALITY_CALGARY_ALBERTA", -"PROVIDER_CA_PUBLIC_MUNICIPALITY_TORONTO_ONTARIO", -"PROVIDER_SE_PUBLIC_MUNICIPALITY", -"PROVIDER_SE_PUBLIC_MUNICIPALITY_UMEA", -"PROVIDER_UA_PUBLIC_MUNICIPALITY", -"PROVIDER_UA_PUBLIC_MUNICIPALITY_KHARKIV", -"PROVIDER_OTHER_PUBLIC_MUNICIPALITY", -"PROVIDER_OTHER_PUBLIC_MUNICIPALITY_AQUA_CALIENTE_CAHUILLA_INDIANS", -"PROVIDER_FR_PUBLIC_MUNICIPALITY", -"PROVIDER_FR_PUBLIC_MUNICIPALITY_PONT_AUDEMER", -"PROVIDER_FR_PUBLIC_MUNICIPALITY_BORDEAUX", -"PROVIDER_SG_PUBLIC_MUNICIPALITY", -"PROVIDER_BR_PUBLIC_MUNICIPALITY", -"PROVIDER_BR_PUBLIC_MUNICIPALITY_RIO_DE_JANEIRO", -"PROVIDER_MAPCUBE", -"PROVIDER_3D_REALITYMAPS", -"PROVIDER_DEUTSCHES_ZENTRUM_FUR_LUFT_UND_RAUMFAHRT", -"PROVIDER_3D_CITIES_SOCIEDADE_ANONIMA", -"PROVIDER_DISNEY", -"PROVIDER_CYBERCITY", -"PROVIDER_PRECISION_LIGHTWORKS_MODELWORKS", -"PROVIDER_VIRTUAL_HUNGARY_LIMITED", -"PROVIDER_VIRTUEL_CITY", -"PROVIDER_SCREAMPOINT_INTERNATIONAL", -"PROVIDER_AGENTSCHAP_VOOR_GEOGRAFISCHE_INFORMATIE_VLAANDEREN", -"PROVIDER_FR_GOVERNMENT", -"PROVIDER_FR_INSTITUT_GEOGRAPHIQUE_NATIONAL", -"PROVIDER_FR_CADASTRE", -"PROVIDER_DIADIEM", -"PROVIDER_THE_WEATHER_CHANNEL", -"PROVIDER_COWI", -"PROVIDER_FALKPLAN_ANDES", -"PROVIDER_NL_GOVERNMENT", -"PROVIDER_NL_KADASTER", -"PROVIDER_NL_BOARD_OF_TOURISM_AND_CONVENTIONS", -"PROVIDER_DIGITAL_MAP_PRODUCTS", -"PROVIDER_SILICE_DIGITAL", -"PROVIDER_TYDAC", -"PROVIDER_ALBRECHT_GOLF", -"PROVIDER_HEALTH_CH", -"PROVIDER_VISITDENMARK", -"PROVIDER_FLYHERE", -"PROVIDER_DIGITAL_DATA_SERVICES", -"PROVIDER_MECOMO", -"PROVIDER_ZA_GOVERNMENT", -"PROVIDER_ZA_RURAL_DEVELOPMENT_LAND_REFORM", -"PROVIDER_SENSIS", -"PROVIDER_JJCONNECT", -"PROVIDER_OPPLYSNINGEN", -"PROVIDER_TELLUS", -"PROVIDER_IQONIA", -"PROVIDER_BE_GOVERNMENT", -"PROVIDER_BE_NATIONAAL_GEOGRAFISCH_INSTITUUT", -"PROVIDER_BE_BRUSSELS_MOBILITY", -"PROVIDER_YELLOWMAP_AG", -"PROVIDER_STIFTUNG_GESUNDHEIT", -"PROVIDER_GIATA", -"PROVIDER_SANPARKS", -"PROVIDER_CENTRE_DINFORMATIQUE_POUR_LA_REGION_BRUXELLOISE", -"PROVIDER_INFOPORTUGAL", -"PROVIDER_NEGOCIOS_DE_TELECOMUNICACOES_E_SISTEMAS_DE_INFORMACAO", -"PROVIDER_COLLINS_BARTHOLOMEW", -"PROVIDER_PROTECT_PLANET_OCEAN", -"PROVIDER_KARTTAKESKUS", -"PROVIDER_FI_GOVERNMENT", -"PROVIDER_FI_NATIONAL_ROAD_ADMINISTRATION", -"PROVIDER_FI_NATIONAL_LAND_SURVEY", -"PROVIDER_FI_STATISTICS_FINLAND", -"PROVIDER_GB_GOVERNMENT", -"PROVIDER_GB_ORDNANCE_SURVEY", -"PROVIDER_NATURAL_ENGLAND", -"PROVIDER_WELSH_GOVERNMENT", -"PROVIDER_GB_OFFICE_FOR_NATIONAL_STATISTICS", -"PROVIDER_EPSILON", -"PROVIDER_PARTNER_FRONT_END", -"PROVIDER_CARTESIA", -"PROVIDER_SE_GOVERNMENT", -"PROVIDER_SE_TRAFIKVERKET", -"PROVIDER_SE_NATURVARDSVERKET", -"PROVIDER_IE_GOVERNMENT", -"PROVIDER_IE_ORDNANCE_SURVEY_IRELAND", -"PROVIDER_LU_GOVERNMENT", -"PROVIDER_LU_P_AND_T_LUXEMBOURG", -"PROVIDER_LU_ADMINISTRATION_DU_CADASTRE_ET_DE_LA_TOPOGRAPHIE", -"PROVIDER_LU_NATIONAL_TOURIST_OFFICE", -"PROVIDER_MAPFLOW", -"PROVIDER_TKARTOR", -"PROVIDER_JUMPSTART", -"PROVIDER_EPTISA", -"PROVIDER_MC_GOVERNMENT", -"PROVIDER_MC_PRINCIPAUTE_DE_MONACO", -"PROVIDER_MONOLIT", -"PROVIDER_ENVIRONMENTAL_SYSTEMS_RESEARCH_INSTITUTE", -"PROVIDER_MODIS", -"PROVIDER_GEOX", -"PROVIDER_GEODIRECTORY", -"PROVIDER_GEOPLAN", -"PROVIDER_INFODIREKT", -"PROVIDER_GEOGLOBAL", -"PROVIDER_DEUTSCHE_POST", -"PROVIDER_TRACASA", -"PROVIDER_CORREOS", -"PROVIDER_ES_GOVERNMENT", -"PROVIDER_ES_CENTRO_NACIONAL_DE_INFORMACION_GEOGRAFICA", -"PROVIDER_EDIMAP", -"PROVIDER_VERIZON", -"PROVIDER_NATIONAL_GEOGRAPHIC_MAPS", -"PROVIDER_PROMAPS", -"PROVIDER_CONSODATA", -"PROVIDER_DE_AGOSTINI", -"PROVIDER_FEDERPARCHI", -"PROVIDER_NAVIGO", -"PROVIDER_ITALIAMAPPE", -"PROVIDER_CZECOT", -"PROVIDER_NATURAL_EARTH", -"PROVIDER_REGIO", -"PROVIDER_SHIPWRECK_CENTRAL", -"PROVIDER_RUTGERS_STATE_UNIVERSITY", -"PROVIDER_TWINICE", -"PROVIDER_NORTHERN_IRELAND_TOURIST_BOARD", -"PROVIDER_INFOGROUP", -"PROVIDER_TNET", -"PROVIDER_CTT_CORREIOS_DE_PORTUGAL", -"PROVIDER_EUROPARC", -"PROVIDER_IUPPITER", -"PROVIDER_MICHAEL_BAUER_INTERNATIONAL", -"PROVIDER_LEPTON", -"PROVIDER_MAPPOINT", -"PROVIDER_GEODATA", -"PROVIDER_RU_GOVERNMENT", -"PROVIDER_RU_FNS_KLADR", -"PROVIDER_BR_GOVERNMENT", -"PROVIDER_BR_INSTITUTO_BRASILEIRO_DO_MEIO_AMBIENTE_E_DOS_RECURSOS_NATURAIS_RENOVAVEIS", -"PROVIDER_BR_MINISTERIO_DO_MEIO_AMBIENTE", -"PROVIDER_BR_AGENCIA_NACIONAL_DE_AGUAS", -"PROVIDER_BR_INSTITUTO_BRASILEIRO_DE_GEOGRAFIA_E_ESTATISTICA", -"PROVIDER_BR_FUNDACAO_NACIONAL_DO_INDIO", -"PROVIDER_BR_DEPARTAMENTO_NACIONAL_DE_INFRAESTRUTURA_DE_TRANSPORTES", -"PROVIDER_AZAVEA", -"PROVIDER_NORTHSTAR", -"PROVIDER_COMMEDI", -"PROVIDER_NEXUS_GEOGRAFICS", -"PROVIDER_INFOERA", -"PROVIDER_AD_GOVERNMENT", -"PROVIDER_AD_AREA_DE_CARTOGRAFIA", -"PROVIDER_MAXXIMA", -"PROVIDER_SI_GOVERNMENT", -"PROVIDER_SI_AGENCY_FOR_ENVIRONMENT", -"PROVIDER_TRANSPORT_HI_TECH_CONSULTANTS", -"PROVIDER_L1_TECHNOLOGIES", -"PROVIDER_TELEMEDIA", -"PROVIDER_CDCOM_PROGOROD", -"PROVIDER_MIT_CITYGUIDE", -"PROVIDER_SUNCART", -"PROVIDER_MICROMAPPER", -"PROVIDER_RICHI", -"PROVIDER_FORUM44", -"PROVIDER_SEAT", -"PROVIDER_VALASSIS", -"PROVIDER_NAVICOM", -"PROVIDER_COLTRACK", -"PROVIDER_PSMA_AUSTRALIA", -"PROVIDER_PT_DUTA_ASTAKONA_GIRINDA", -"PROVIDER_CA_GOVERNMENT", -"PROVIDER_STATISTICS_CANADA", -"PROVIDER_TOCTOC", -"PROVIDER_RMSI", -"PROVIDER_TRUE_TECHNOLOGY", -"PROVIDER_INCREMENT_P_CORPORATION", -"PROVIDER_GOJAVAS", -"PROVIDER_GEOINFORMATION_GROUP", -"PROVIDER_CYBERSOFT", -"PROVIDER_TSENTR_EFFEKTIVNYKH_TEKHNOLOGIY", -"PROVIDER_EE_GOVERNMENT", -"PROVIDER_EE_MAA_AMET", -"PROVIDER_GASBUDDY", -"PROVIDER_DK_GOVERNMENT", -"PROVIDER_DK_GEODATASTYRELSEN", -"PROVIDER_MURCIA_REGION_GOVERNMENT", -"PROVIDER_CORREIOS", -"PROVIDER_WEST_WORLD_MEDIA", -"PROVIDER_INTERNATIONAL_MAPPING_ASSOCIATION", -"PROVIDER_MEDICARE", -"PROVIDER_POLARIS", -"PROVIDER_TW_GOVERNMENT", -"PROVIDER_TW_MINISTRY_OF_THE_INTERIOR_SURVEYING_AND_MAPPING_CENTER", -"PROVIDER_NORDECA", -"PROVIDER_AFRIMAPPING", -"PROVIDER_OVERDRIVE", -"PROVIDER_PROVIDER_NETWORK_DIRECTORIES", -"PROVIDER_BR_MINISTERIO_DA_SAUDE", -"PROVIDER_DIGITAL_EGYPT", -"PROVIDER_INRIX", -"PROVIDER_ARPINDO", -"PROVIDER_IT_GOVERNMENT", -"PROVIDER_ISTITUTO_GEOGRAFICO_MILITARE", -"PROVIDER_EAST_END_GROUP", -"PROVIDER_INGEOLAN", -"PROVIDER_SEMACONNECT", -"PROVIDER_BLINK", -"PROVIDER_EVGO", -"PROVIDER_CHARGEPOINT", -"PROVIDER_TPL_TRAKKER", -"PROVIDER_OI", -"PROVIDER_MAPARADAR", -"PROVIDER_SINGAPORE_POST", -"PROVIDER_CHARGEMASTER", -"PROVIDER_TESLA", -"PROVIDER_VISICOM", -"PROVIDER_GEOLYSIS", -"PROVIDER_ZEPHEIRA", -"PROVIDER_HUBJECT", -"PROVIDER_PODPOINT", -"PROVIDER_CHARGEFOX", -"PROVIDER_KR_GOVERNMENT", -"PROVIDER_KR_MOLIT", -"PROVIDER_KR_MINISTRY_OF_THE_INTERIOR_AND_SAFETY", -"PROVIDER_CRITCHLOW", -"PROVIDER_EIFRIG", -"PROVIDER_GIREVE", -"PROVIDER_CN_NAVINFO", -"PROVIDER_JAPAN_CHARGE_NETWORK", -"PROVIDER_NOBIL", -"PROVIDER_INDIA_BANKS", -"PROVIDER_INDONESIA_ELECTION_KPU", -"PROVIDER_CAREERS360", -"PROVIDER_SOURCE_LONDON", -"PROVIDER_EVBOX", -"PROVIDER_JP_GOVERNMENT", -"PROVIDER_JP_MINISTRY_OF_THE_ENVIRONMENT", -"PROVIDER_YUMYUM", -"PROVIDER_HWW_AUSTRALIA", -"PROVIDER_CINERGY", -"PROVIDER_MTIME", -"PROVIDER_KULTUNAUT", -"PROVIDER_BLITZ", -"PROVIDER_PIA", -"PROVIDER_INTERPARK", -"PROVIDER_CINEMA_ONLINE", -"PROVIDER_BELBIOS", -"PROVIDER_MOVIESEER", -"PROVIDER_SODAMEDYA", -"PROVIDER_ATMOVIES", -"PROVIDER_HOTELBEDS", -"PROVIDER_VERICRED", -"PROVIDER_CIRRANTIC", -"PROVIDER_GOGO_LABS", -"PROVIDER_ELECTRIFY_AMERICA", -"PROVIDER_CMS_MPPUF", -"PROVIDER_DIGIROAD", -"PROVIDER_KONTEX_GEOMATICS", -"PROVIDER_NZ_GOVERNMENT", -"PROVIDER_NZ_LINZ", -"PROVIDER_NZ_DOC", -"PROVIDER_FASTNED", -"PROVIDER_DESTINY_CS", -"PROVIDER_IONITY", -"PROVIDER_EV_CONNECT", -"PROVIDER_PANPAGES", -"PROVIDER_ETECNIC", -"PROVIDER_VOLTA", -"PROVIDER_NISSAN_MEXICO", -"PROVIDER_BMW_GROUP_LATIN_AMERICA", -"PROVIDER_FEDERAL_ELECTRICITY_COMMISSION_MEXICO", -"PROVIDER_VOLVO_CARS_BRASIL", -"PROVIDER_CHARGE_AND_PARKING", -"PROVIDER_DEDUCE_TECHNOLOGIES", -"PROVIDER_SK_TELECOM", -"PROVIDER_ECO_MOVEMENT", -"PROVIDER_GOOGLE_GMS", -"PROVIDER_EASYWAY", -"PROVIDER_PHYSICIAN_COMPARE", -"PROVIDER_HOSPITAL_COMPARE", -"PROVIDER_ENDOLLA_BARCELONA", -"PROVIDER_BE_CHARGE", -"PROVIDER_ONE_NETWORK", -"PROVIDER_CARENAV_DUPLEX", -"PROVIDER_CARENAV_POI", -"PROVIDER_IN_GOVERNMENT", -"PROVIDER_SURVEY_OF_INDIA", -"PROVIDER_E_ON", -"PROVIDER_ELECTRIFY_CANADA", -"PROVIDER_GRIDCARS", -"PROVIDER_DRIVECO", -"PROVIDER_GREEN_ACTION_STUDIOS", -"PROVIDER_GREEN_ACTION_STUDIO", -"PROVIDER_EVINY", -"PROVIDER_MASTERCARD", -"PROVIDER_VATTENFALL", -"PROVIDER_VIETGIS", -"PROVIDER_UNITE", -"PROVIDER_NEOGY", -"PROVIDER_AMPUP", -"PROVIDER_LOOP", -"PROVIDER_ZEST", -"PROVIDER_EZVOLT", -"PROVIDER_JOLT", -"PROVIDER_CHARGESMITH", -"PROVIDER_PLUGO", -"PROVIDER_ELECTRIC_ERA", -"PROVIDER_FLO", -"PROVIDER_DIGITAL_CHARGING_SOLUTIONS", -"PROVIDER_ELECTRIC_PE", -"PROVIDER_PLUGSURFING" -], -"enumDeprecated": [ -false, -false, -true, -false, -true, -true, -true, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -false, -true, -false, -true, -false, -true, -false, -false, -false, -false, -true, -false, -false, -true, -false, -false, -true, -true, -false, -false, -false, -false, -false, -true, -true, -true, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -true, -false, -false, -true, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -true, -false, -true, -false, -false, -true, -true, -false, -true, -false, -true, -true, -false, -true, -false, -false, -false, -false, -true, -true, -true, -true, -true, -true, -false, -false, -false, -true, -false, -true, -false, -true, -true, -true, -false, -true, -true, -true, -false, -false, -true, -true, -true, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -true, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -true, -true, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"ABSTRACT The root of all provider types. This should never be present on an actual feature, but can be useful when calling InCategory.", -"not actually a legal value, used as sentinel", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"All new \"Google\" provider entries must be full ints. The next available ID is: 0x111730C2", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"This is an internal *only* provider meant for sending wipeout requests to mapfacts.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Never rely on source infos with this provider to identify whether or not a feature is a Prominent Place! Instead, use the proper API, localsearch_clustering::QualityTierHelper::IsProminentPlace().", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"UMBRELLA", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"UMBRELLA", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"UMBRELLA", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Shopping Attributes Discovery", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"UMBRELLA", -"", -"", -"", -"UMBRELLA", -"", -"The next new \"Google\" provider entries should be placed above.", -"UMBRELLA", -"", -"", -"", -"This is a testing provider for teams that wish to integrate with components of the Geo Data Infrastructure that require a valid provider. No production data should ever be sent using this provider.", -"", -"UMBRELLA", -"", -"", -"", -"UMBRELLA", -"0x1117F must not be used, since its range extends the PROVIDER_GOOGLE hierarchy.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Deprecated in favor of PROVIDER_GOOGLE_STRUCTURED_DATA (for attributes) and PROVIDER_GOOGLE_GEO_TIGER (for categories).", -"", -"0x1117FF should not be used, since its range further extends the PROVIDER_GOOGLE hierarchy. aka Local AI.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"No data is obtained from this provider. It is only used to identify features that must be served on MapMaker.", -"", -"", -"", -"", -"", -"", -"0x1117FFF should not be used, since its range further extends the PROVIDER_GOOGLE hierarchy. Synthetically generated areas (sublocalities/neighborhoods/ postal codes/etc) based on dropped terms from approximate geocoding. More info on go/syntheticareas.", -"", -"", -"", -"Similar to Google Transit, a provider that aggregates positions of bicycle rental points that we have agreements with to show on maps", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"This range has been depleted. For new Ids see PROVIDER_GOOGLE_SUBRANGE above.", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"Small Scale International Boundary Lines", -"", -"NOAA", -"PGC", -"USDA", -"National Provider Identifier Registry", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"old name for PROVIDER_NAVIGO", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"See b/33687395", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"UMBRELLA", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"ABSTRACT", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"ABSTRACT", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"ABSTRACT", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"ABSTRACT", -"IBAMA", -"MMA", -"ANA", -"IBGE", -"FUNAI", -"DNIT", -"", -"", -"", -"", -"", -"ABSTRACT", -"Department of Cartography", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"0x12 and 0x120 are not to be used. OOO CET", -"ABSTRACT", -"Estonian Land Board", -"", -"ABSTRACT", -"Danish Geodata Agency", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"Ministry of land, infrastructure and transport, \uad6d\ud1a0\uad50\ud1b5\ubd80, Guktogyotongbu", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Use PROVIDER_FI_NATIONAL_ROAD_ADMINISTRATION.", -"", -"ABSTRACT", -"Land Information New Zealand", -"NZ Department of Conservation", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"UMBRELLA", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Note: Next available value is 0x1276." -], -"type": "string" -} -}, -"type": "object" -}, -"GeostoreKnowledgeGraphReferenceProto": { -"description": "The reference to an entity in the KnowledgeGraph. For details on the KnowledgeGraph see http://goto/kg.", -"id": "GeostoreKnowledgeGraphReferenceProto", -"properties": { -"id": { -"description": "KG Identifier (MID). For details, see http://go/ke-bg-knowledge-graph#mids.", -"type": "string" -} -}, -"type": "object" -}, -"GeostoreNameProto": { -"description": "A name for a Feature (street name, point of interest, city, building, etc). We currently use NameProto for two essentially disjoint purposes: 1. Common names, which can be language-specific, or have other kinds of variations. 2. Opaque IDs, such as postal codes, which only have the `text` field set, and potentially some flags. This includes internal-only features like template ids. Each NameProto representing a common name corresponds to an assertion that a fluent speaker or writer of a language would recognize NameProto.text to name the given feature in that language. As such, NameProtos are stored in a repeated field, often having: 1. multiple names with the same text and varying languages, and 2. multiple names with the same language and varying texts.", -"id": "GeostoreNameProto", -"properties": { -"flag": { -"description": "clang-format on The set of flags that apply to this name.", -"items": { -"enum": [ -"FLAG_ANY", -"FLAG_IN_LOCAL_LANGUAGE", -"FLAG_PREFERRED", -"FLAG_OFFICIAL", -"FLAG_OBSCURE", -"FLAG_ON_SIGNS", -"FLAG_EXIT_NAME_NUMBER", -"FLAG_EXIT_NAME", -"FLAG_INTERCHANGE_NAME", -"FLAG_EXIT_NUMBER", -"FLAG_INTERCHANGE_NUMBER", -"FLAG_TRANSIT_HEADSIGN", -"FLAG_CONNECTS_DIRECTLY", -"FLAG_CONNECTS_INDIRECTLY", -"FLAG_INTERSECTION_NAME", -"FLAG_VANITY", -"FLAG_ROUTE_NUMBER", -"FLAG_COUNTRY_CODE_2", -"FLAG_ABBREVIATED", -"FLAG_ID", -"FLAG_DESIGNATED_MARKET_AREA_ID", -"FLAG_IATA_ID", -"FLAG_ICAO_ID", -"FLAG_ISO_3166_2", -"FLAG_COUNTRY_SPECIFIC_ID", -"FLAG_LANGUAGE_CODE", -"FLAG_TIMEZONE_ID", -"FLAG_PHONE_NUMBER_PREFIX", -"FLAG_PHONE_NUMBER_AREA_CODE", -"FLAG_TRANSLITERATED", -"FLAG_NOT_ON_SIGNS", -"FLAG_NOT_IN_LOCAL_LANGUAGE", -"FLAG_ROUNDABOUT_ROUTE", -"FLAG_NEVER_DISPLAY", -"FLAG_BICYCLE_ROUTE", -"FLAG_MACHINE_GENERATED", -"FLAG_SUSPICIOUS" -], -"enumDeprecated": [ -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -true -], -"enumDescriptions": [ -"ABSTRACT", -"This name is in one of the local languages. A local language is one readable by local people, where all language/script/region subtags in the language field are local. E.g. \"ru\" is local in Russia, but \"ru-Latn\" (transliterated in Latin script) is not local. This is the opposite of FLAG_NOT_IN_LOCAL_LANGUAGE. In general, a given name should have either FLAG_IN_LOCAL_LANGUAGE or FLAG_NOT_IN_LOCAL_LANGUAGE specified. Importers that are unsure should not set either flag. It doesn't make sense to set this flag unless you also specify a language. NOTE: unlike most other flags in this enumeration, this flag has to do with the language field, NOT to the text (and {raw,short}_text fields).", -"This is the most commonly recognized name for this feature (for a given language, when languages apply). This flag is not compatible with the following flags: - FLAG_NEVER_DISPLAY - FLAG_OBSCURE", -"This name is officially recognized by the government. This flag is not compatible with FLAG_SUSPICIOUS.", -"This name is not commonly known. This flag is used on names that are not commonly known, or not \"standard\", but which we wish to have so clients can search on them. An example would be \"Philly\" instead of \"Philadelphia\".", -"ABSTRACT", -"This name is an exit name/number found on signs.", -"This flag is used to differentiate exit names from exit numbers on signs that have both.", -"The highway sign is labeling a highway interchange instead of an exit. In several European countries interchanges are differentiated from highway exits.", -"This flag is used to differentiate exit numbers from exit names on signs that have both. This flag is not compatible with FLAG_ROUTE_NUMBER.", -"The highway sign is labeling a highway interchange the same manner as FLAG_INTERCHANGE_NAME.", -"The headsign of a transit vehicle, often the name of the destination.", -"The road sign target is directly connected (e.g., at end of ramp).", -"The road sign target is not directly connected (e.g., must travel some additional distance).", -"This name is an intersection name found on signs. Usually we can just use the name of a TYPE_INTERSECTION_GROUP feature. However, there are road signs on some intersections in Japan, especially in Hokkaido region where the intersection name is considered \"directional\" (i.e. an intersection could have multiple names depending on directions drivers or pedestrians approach from). Many people think of them as \"intersection names\", but that's not really what they are. We want to model them as road signs, because that's really what they are. This flag is supposed to be used by Pathfinder to generate the appropriate maneuver texts where such a named intersection is involved.", -"This is a vanity name (usually an alternate name for a section of road in honor of some person).", -"This name is a route number from an official numbering system for highways or similar routes (like bicycle routes). Street names (even numbered ones like in Manhattan) are excluded. The name (both text and short_text) should follow a strictly-defined format determined by the official numbering system. Route numbers may be assigned to segments on city streets as well as highways. (US-101 passing through San Francisco is an example that has both.) Historic route names that are no longer part of an official numbering system (like the former US-66) are not route numbers. This flag is not compatible with FLAG_EXIT_NUMBER.", -"This name is a two-letter ISO 3166-1 country code. It has code 0x81 instead of 0x8 for historical reasons (FLAG_COUNTRY_CODE and FLAG_COUNTRY_CODE_3 were removed in the belief that we only want one way to represent a country code in the Geo Schema).", -"An abbreviated version of the name, for example \"CA\" for California. This flag should be used for postal abbreviations that one would expect to see in an address. It should also be used for names where one of the component words is abbreviated (e.g. \"Mass.\" for Massachusetts, \"NWFP\" for the North-West Frontier Province in Pakistan, or \"L\" for the Lobby level in a building). Shortened forms of names (e.g. \"Kingston\" rather than \"Kingston-upon-Hull\") should be marked obscure rather than abbreviated. This flag should be used for names that are feature specific abbreviations. For shortened name versions based on regular, per-term transformations (ex: '1st Street' -> '1st St'), use the short_text field instead.", -"ABSTRACT", -"This name is a Designated Market Area ID number (ex: 501)", -"This name is a three-letter IATA airport code (ex SFO, ZRH).", -"This name is a four-letter ICAO airport code (ex KSFO, LSZH).", -"This name is the ISO 3166-2 country subdivision code.", -"This name is the country specific ID. For example, China government specifies an admin code for each administrative area (province, city and district).", -"This name is an IETF BCP 47 language code, for example \"fr-CA\". Previously used for names of locales. See locale.proto for new way of defining this information.", -"This name is a timezone identifier in the Olson database, for example \"Europe/Zurich\". All timezones have an Olson identifier, understood by POSIX and Google's i18n/identifiers libraries. This flag applies only to features of TYPE_TIMEZONE type.", -"This name is the prefix for a phone number, starting with + and followed by a country code. This flag applies only to features of TYPE_PHONE_NUMBER_PREFIX type and at most one name should have this flag set.", -"This name is the commonly used name for the area code of a phone number, including the national prefix if applicable. This flag applies only to features of TYPE_PHONE_NUMBER_AREA_CODE type and at most one name should have this flag set.", -"The flag used to indicate the name was transliterated from some other character set. For example, this flag would be set on names transliterated from the Cyrillic or Greek alphabets to a Latin alphabet. The correct approach is to use the Google III language code to specify the appropriate language. For example, Greek transliterated into a Latin alphabet should have a language code of \"el-Latn\".", -"There are two kinds of street signs: \"location signs\" and \"guidance signs\". Location signs are the ones you see that tell you where you are. \"Ah, I'm on 85th Street and I'm crossing 6th Avenue.\" Guidance signs are the ones that give you hints about how to get where you want to go. \"Ah, I should go that way to get on I-5 to Seattle.\" This flag is talking about location signs. You'll find this flag on route names when then name is never posted on location signs. This flag is not compatible with flags in the FLAG_ON_SIGNS category.", -"This name is not in one of the local languages. A local language is one readable by local people, where all language/script/region subtags in the language field are local. E.g. \"ru\" is local in Russia, but \"ru-Latn\" (transliterated in Latin script) is not local. This is the opposite of FLAG_IN_LOCAL_LANGUAGE. In general, a given name should have either FLAG_IN_LOCAL_LANGUAGE or FLAG_NOT_IN_LOCAL_LANGUAGE specified. Importers that are unsure should not set either flag. It doesn't make sense to set this flag unless you also specify a language. NOTE: unlike most other flags in this enumeration, this flag has to do with the language field, NOT to the text (and {raw,short}_text fields).", -"This flag is set on routes attached to roundabout segments if and only if this name does not appear on any of the segments incident on the roundabout. This flag can be used by clients to determine which names on roundabouts are more useful than others when displaying to users.", -"Never display this name to a user. This flag is typically used for politically sensitive names such as \"Taiwan, Province of China\". Any feature which has a name with this flag should have another name without it so we have something to display to the user.", -"Routes with these names are common bicycle routes. This includes bicycle trails and routes along shared roadways to popular destinations for cyclists. Unnamed bicycle routes along named shared roadways should not have names of this type. This flag exists so that we can avoid showing bicycle route names in driving directions, while still showing them in bicycling directions.", -"This name is generated automatically by the transliteration pipeline based on an existing name in a different language. Contact Maps Translation team (go/maps-translation) for details.", -"This name may not be a correct name for a feature. It communicates to clients that the name may not be trustworthy. Examples are names of features that are too general (\"swimming pool\", \"hardware store\" etc) or those that incorrectly match names of prominent political features (businesses, transit stations etc named after sublocalities). This flag is not compatible with FLAG_OFFICIAL." -], -"type": "string" -}, -"type": "array" -}, -"language": { -"description": "The external form of a Google International Identifiers Initiative (III) LanguageCode object. See google3/i18n/identifiers/languagecode.h for details. These strings should be treated as opaque blobs. You can use LanguageCodeConverter::FromOther to convert the string to a LanguageCode reference. You can then call methods on the LanguageCode class to extract language/script/region subtags (if any). See also http://g3doc/i18n/identifiers/g3doc/using-iii. We place extra restrictions on languages in addition to what the III library requires. See go/geo-schema-reference/feature-properties/languages. This field may be missing if the name does not have a concept of language but should be set if the language is unknown.", -"type": "string" -}, -"metadata": { -"$ref": "GeostoreFieldMetadataProto", -"description": "Field-level metadata for this name. NOTE: there are multiple NameProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.name[]." -}, -"rawText": { -"deprecated": true, -"description": "** DEPRECATED ** The name text provided in the original source data (UTF-8 encoding). This is the text provided in the source data unmodified with the exception of being converted to UTF-8 and stripping extra leading, trailing and duplicate whitespaces (if necessary).", -"type": "string" -}, -"shortText": { -"description": "The short name text (UTF-8 encoding). Acronyms/abbreviations should be consistently used, for example \"NE 57th St\" rather than \"Northeast 57th Street\", \"N.E 57th St.\" or some other variant. This field should be populated with the chosen canonical version of the shortened name, based on per-term transformations. For feature specific abbreviations (such as 'CA' for 'California'), one should define a separate name with FLAG_ABBREVIATED set. For other variants of the shortened name that are not the canonical one, devise client based logic (ex: query rewriting rules).", -"type": "string" -}, -"temporaryData": { -"$ref": "MessageSet", -"description": "A place for clients to attach arbitrary data to a name. Never set in MapFacts." -}, -"text": { -"description": "The name text (UTF-8 encoding). Acronyms/abbreviations should be fully expanded, for example \"Northeast 57th Street\" rather than \"NE 57th St\". They can be shortened at display or geocode time. This decision prevents ambiguity over such issues as whether \"St\" represents \"Street\" or \"Saint\". However, it pushes language-specific knowledge into code. We will have libraries and data files to contract acronyms/abbreviations at run-time.", -"type": "string" -} -}, -"type": "object" -}, -"GeostorePointProto": { -"id": "GeostorePointProto", -"properties": { -"latE7": { -"format": "uint32", -"type": "integer" -}, -"lngE7": { -"format": "uint32", -"type": "integer" -}, -"metadata": { -"$ref": "GeostoreFieldMetadataProto", -"description": "NOTE: If removing metadata, remove 'option objc_class_prefix = \"GS\";' together. See cl/189921100. Field-level metadata for this point. NOTE: there are multiple PointProto fields in the Geo Schema. Metadata here is only expected to be present on FeatureProto.point[] and FeatureProto.center." -}, -"temporaryData": { -"$ref": "MessageSet", -"description": "A place for clients to attach arbitrary data to a point. Never set in MapFacts." -} -}, -"type": "object" -}, -"GeostoreRectProto": { -"description": "A latitude-longitude rectangle, represented as two diagonally opposite points \"lo\" and \"hi\". The rectangle is considered to be a closed region, i.e. it includes its boundary. The latitude bounds must be in the range -90 to 90 degrees inclusive, and the longitude bounds must be in the range -180 to 180 degrees inclusive. Various cases include: - If lo == hi, the rectangle consists of a single point. - If lo.longitude > hi.longitude, the longitude range is \"inverted\" (the rectangle crosses the 180 degree longitude line). - If lo.longitude == -180 degrees and hi.longitude = 180 degrees, the rectangle includes all longitudes. - If lo.longitude = 180 degrees and hi.longitude = -180 degrees, the longitude range is empty. - If lo.latitude > hi.latitude, the latitude range is empty.", -"id": "GeostoreRectProto", -"properties": { -"hi": { -"$ref": "GeostorePointProto" -}, -"lo": { -"$ref": "GeostorePointProto" -} -}, -"type": "object" -}, -"GetCustomerIndexStatsResponse": { -"id": "GetCustomerIndexStatsResponse", -"properties": { -"averageIndexedItemCount": { -"description": "Average item count for the given date range for which billing is done.", -"format": "int64", -"type": "string" -}, -"stats": { -"description": "Summary of indexed item counts, one for each day in the requested range.", -"items": { -"$ref": "CustomerIndexStats" -}, -"type": "array" -} -}, -"type": "object" -}, -"GetCustomerQueryStatsResponse": { -"id": "GetCustomerQueryStatsResponse", -"properties": { -"stats": { -"items": { -"$ref": "CustomerQueryStats" -}, -"type": "array" -}, -"totalQueryCount": { -"description": "Total successful query count (status code 200) for the given date range.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, -"GetCustomerSearchApplicationStatsResponse": { -"description": "Response format for search application stats for a customer.", -"id": "GetCustomerSearchApplicationStatsResponse", -"properties": { -"averageSearchApplicationCount": { -"description": "Average search application count for the given date range.", -"format": "int64", -"type": "string" -}, -"stats": { -"description": "Search application stats by date.", -"items": { -"$ref": "CustomerSearchApplicationStats" -}, -"type": "array" -} -}, -"type": "object" -}, -"GetCustomerSessionStatsResponse": { -"id": "GetCustomerSessionStatsResponse", -"properties": { -"stats": { -"items": { -"$ref": "CustomerSessionStats" -}, -"type": "array" -} -}, -"type": "object" -}, -"GetCustomerUserStatsResponse": { -"id": "GetCustomerUserStatsResponse", -"properties": { -"stats": { -"items": { -"$ref": "CustomerUserStats" -}, -"type": "array" -} -}, -"type": "object" -}, -"GetDataSourceIndexStatsResponse": { -"id": "GetDataSourceIndexStatsResponse", -"properties": { -"averageIndexedItemCount": { -"description": "Average item count for the given date range for which billing is done.", -"format": "int64", -"type": "string" -}, -"stats": { -"description": "Summary of indexed item counts, one for each day in the requested range.", -"items": { -"$ref": "DataSourceIndexStats" -}, -"type": "array" -} -}, -"type": "object" -}, -"GetSearchApplicationQueryStatsResponse": { -"description": "Response format for getting query stats for a search application between given dates.", -"id": "GetSearchApplicationQueryStatsResponse", -"properties": { -"stats": { -"description": "Query stats per date for a search application.", -"items": { -"$ref": "SearchApplicationQueryStats" -}, -"type": "array" -}, -"totalQueryCount": { -"description": "Total successful query count (status code 200) for the given date range.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, -"GetSearchApplicationSessionStatsResponse": { -"id": "GetSearchApplicationSessionStatsResponse", -"properties": { -"stats": { -"items": { -"$ref": "SearchApplicationSessionStats" -}, -"type": "array" -} -}, -"type": "object" -}, -"GetSearchApplicationUserStatsResponse": { -"id": "GetSearchApplicationUserStatsResponse", -"properties": { -"stats": { -"items": { -"$ref": "SearchApplicationUserStats" -}, -"type": "array" -} -}, -"type": "object" -}, -"HtmlOperatorOptions": { -"description": "Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", -"id": "HtmlOperatorOptions", -"properties": { -"operatorName": { -"description": "Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:* show results only where the value of the property named *subjectLine* matches **. By contrast, a search that uses the same ** without an operator return all items where ** matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", -"type": "string" -} -}, -"type": "object" -}, -"HtmlPropertyOptions": { -"description": "The options for html properties.", -"id": "HtmlPropertyOptions", -"properties": { -"operatorOptions": { -"$ref": "HtmlOperatorOptions", -"description": "If set, describes how the property should be used as a search operator." -}, -"retrievalImportance": { -"$ref": "RetrievalImportance", -"description": "Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE." -} -}, -"type": "object" -}, -"HtmlValues": { -"description": "List of html values.", -"id": "HtmlValues", -"properties": { -"values": { -"description": "The maximum allowable length for html values is 2048 characters.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"IPBlockInfoProto": { -"id": "IPBlockInfoProto", -"properties": { -"asn": { -"description": "ASN of the block. Only present when return_organisational is set in the request options.", -"type": "string" -}, -"carrierName": { -"type": "string" -}, -"cookiePopulation": { -"deprecated": true, -"format": "float", -"type": "number" -}, -"dnsDomain": { -"description": "DNS and organisational info, only present when return_organisational is set in the request options. Currently (November 2010) this data comes from the raw Quova import.", -"type": "string" -}, -"homeIndicator": { -"description": "True, if it is a home IP. Data is from Neustar.", -"type": "boolean" -}, -"ipsEstimate": { -"description": "Day averages for this block of number of .. Currently (May 2011) not filled in. .. active IPs", -"format": "float", -"type": "number" -}, -"isicCode": { -"description": "ISIC code, data from Neustar.", -"type": "string" -}, -"lastChangedS": { -"description": "Seconds since epoch any data constituting this block last changed. Currently (May 2011) not filled in.", -"format": "int32", -"type": "integer" -}, -"naicsCode": { -"description": "NAICS code, data from Neustar.", -"type": "string" -}, -"netstats": { -"$ref": "NetStatsProto", -"description": "Data from the NetDB project, see net/ipmap/..., only present when return_netstats is set in the request options." -}, -"organisationName": { -"type": "string" -}, -"organizationType": { -"description": "Neustar's organization_type data.", -"type": "string" -}, -"proxyClassification": { -"$ref": "ProxyClassificationProto", -"description": "Proxy classification of the block. Only present when return_proxy_classification is set in the request options." -}, -"ranges": { -"description": "For historical reasons, the 'ranges' field is repeated, but actually it occurs at most once. If present, the range is a set of consecutive IP addresses to which the IPGeo result (including the information in the IPBlockInfoProto as well as other info in the IPGeoResponseProto / LocationResult) applies. This means that when the netstats are present, this will be the intersection of the range from the ipgeo index with the range from the netstats index; when the proxy classification is present, this will be intersected with the IP range to which the proxy classification applies. Caveat: intersection with HHI (household income) IP range is currently not implemented.", -"items": { -"$ref": "IPRangeProto" -}, -"type": "array" -}, -"reallocFracEstimate": { -"description": "Estimate of the fraction of IPs that get reallocated per day. Currently (May 2011) not filled in.", -"format": "float", -"type": "number" -}, -"routingtype": { -"description": "Routing type, only present if return_organisational is set in the request options. Currently (June 2012) this data is not filled in.", -"enum": [ -"UNKNOWN", -"INTERNATIONAL_PROXY", -"MOBILE_GATEWAY" -], -"enumDescriptions": [ -"", -"ANONYMIZER = 2; AOLDIALUP = 3; AOLPOP = 4; AOLPROXY = 5; CACHE_PROXY = 6; FIXED = 7;", -"POP = 10; REGIONAL_PROXY = 11; SATELLITE = 12; SUPERPOP = 13;" -], -"type": "string" -}, -"trafficEstimate": { -"description": ".. queries", -"format": "float", -"type": "number" -} -}, -"type": "object" -}, -"IPRangeProto": { -"id": "IPRangeProto", -"properties": { -"packedIpBegin": { -"description": "A contiguous range [begin, end] of IPv4 or IPv6 addresses in packed binary form. 4 or 16 bytes, big endian", -"format": "byte", -"type": "string" -}, -"packedIpEnd": { -"description": "inclusive", -"format": "byte", -"type": "string" -} -}, -"type": "object" -}, -"IndexItemOptions": { -"id": "IndexItemOptions", -"properties": { -"allowUnknownGsuitePrincipals": { -"description": "Specifies if the index request should allow Google Workspace principals that do not exist or are deleted.", -"type": "boolean" -} -}, -"type": "object" -}, -"IndexItemRequest": { -"id": "IndexItemRequest", -"properties": { -"connectorName": { -"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", -"type": "string" -}, -"debugOptions": { -"$ref": "DebugOptions", -"description": "Common debug options." -}, -"indexItemOptions": { -"$ref": "IndexItemOptions" -}, -"item": { -"$ref": "Item", -"description": "The name of the item. Format: datasources/{source_id}/items/{item_id}" -}, -"mode": { -"description": "Required. The RequestMode for this request.", -"enum": [ -"UNSPECIFIED", -"SYNCHRONOUS", -"ASYNCHRONOUS" -], -"enumDescriptions": [ -"The priority is not specified in the update request. Leaving priority unspecified results in an update failure.", -"For real-time updates.", -"For changes that are executed after the response is sent back to the caller." -], -"type": "string" -} -}, -"type": "object" -}, -"InitializeCustomerRequest": { -"description": "Request message for `InitializeCustomer` method.", -"id": "InitializeCustomerRequest", -"properties": {}, -"type": "object" -}, -"IntegerFacetingOptions": { -"description": "Used to specify integer faceting options.", -"id": "IntegerFacetingOptions", -"properties": { -"integerBuckets": { -"description": "Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"IntegerOperatorOptions": { -"description": "Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", -"id": "IntegerOperatorOptions", -"properties": { -"greaterThanOperatorName": { -"description": "Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:* show results only where the value of the property named *priorityVal* is greater than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", -"type": "string" -}, -"lessThanOperatorName": { -"description": "Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:* show results only where the value of the property named *priorityVal* is less than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", -"type": "string" -}, -"operatorName": { -"description": "Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", -"type": "string" -} -}, -"type": "object" -}, -"IntegerPropertyOptions": { -"description": "The options for integer properties.", -"id": "IntegerPropertyOptions", -"properties": { -"integerFacetingOptions": { -"$ref": "IntegerFacetingOptions", -"description": "If set, describes integer faceting options for the given integer property. The corresponding integer property should be marked isFacetable." -}, -"maximumValue": { -"description": "The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value.", -"format": "int64", -"type": "string" -}, -"minimumValue": { -"description": "The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value.", -"format": "int64", -"type": "string" -}, -"operatorOptions": { -"$ref": "IntegerOperatorOptions", -"description": "If set, describes how the integer should be used as a search operator." -}, -"orderedRanking": { -"description": "Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false.", -"enum": [ -"NO_ORDER", -"ASCENDING", -"DESCENDING" -], -"enumDescriptions": [ -"There is no ranking order for the property. Results are not adjusted by this property's value.", -"This property is ranked in ascending order. Lower values indicate lower ranking.", -"This property is ranked in descending order. Lower values indicate higher ranking." -], -"type": "string" -} -}, -"type": "object" -}, -"IntegerValues": { -"description": "List of integer values.", -"id": "IntegerValues", -"properties": { -"values": { -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"Interaction": { -"description": "Represents an interaction between a user and an item.", -"id": "Interaction", -"properties": { -"interactionTime": { -"description": "The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.", -"format": "google-datetime", -"type": "string" -}, -"principal": { -"$ref": "Principal", -"description": "The user that acted on the item." -}, -"type": { -"enum": [ -"UNSPECIFIED", -"VIEW", -"EDIT" -], -"enumDescriptions": [ -"Invalid value.", -"This interaction indicates the user viewed the item.", -"This interaction indicates the user edited the item." -], -"type": "string" -} -}, -"type": "object" -}, -"Item": { -"description": "Represents a single object that is an item in the search index, such as a file, folder, or a database record.", -"id": "Item", -"properties": { -"acl": { -"$ref": "ItemAcl", -"description": "Access control list for this item." -}, -"content": { -"$ref": "ItemContent", -"description": "Item content to be indexed and made text searchable." -}, -"itemType": { -"description": "The type for this item.", -"enum": [ -"UNSPECIFIED", -"CONTENT_ITEM", -"CONTAINER_ITEM", -"VIRTUAL_CONTAINER_ITEM" -], -"enumDescriptions": [ -"", -"An item that is indexed for the only purpose of serving information. These items cannot be referred in containerName or inheritAclFrom fields.", -"An item that gets indexed and whose purpose is to supply other items with ACLs and/or contain other items.", -"An item that does not get indexed, but otherwise has the same purpose as CONTAINER_ITEM." -], -"type": "string" -}, -"metadata": { -"$ref": "ItemMetadata", -"description": "The metadata information." -}, -"name": { -"description": "The name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.", -"type": "string" -}, -"payload": { -"description": "Additional state connector can store for this item. The maximum length is 10000 bytes.", -"format": "byte", -"type": "string" -}, -"queue": { -"description": "Queue this item belongs to. The maximum length is 100 characters.", -"type": "string" -}, -"status": { -"$ref": "ItemStatus", -"description": "Status of the item. Output only field." -}, -"structuredData": { -"$ref": "ItemStructuredData", -"description": "The structured data for the item that should conform to a registered object definition in the schema for the data source." -}, -"version": { -"description": "Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations).", -"format": "byte", -"type": "string" -} -}, -"type": "object" -}, -"ItemAcl": { -"description": "Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls).", -"id": "ItemAcl", -"properties": { -"aclInheritanceType": { -"description": "Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.", -"enum": [ -"NOT_APPLICABLE", -"CHILD_OVERRIDE", -"PARENT_OVERRIDE", -"BOTH_PERMIT" -], -"enumDescriptions": [ -"The default value when this item does not inherit an ACL. Use NOT_APPLICABLE when inheritAclFrom is empty. An item without ACL inheritance can still have ACLs supplied by its own readers and deniedReaders fields.", -"During an authorization conflict, the ACL of the child item determines its read access.", -"During an authorization conflict, the ACL of the parent item specified in the inheritAclFrom field determines read access.", -"Access is granted only if this item and the parent item specified in the inheritAclFrom field both permit read access." -], -"type": "string" -}, -"deniedReaders": { -"description": "List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.", -"items": { -"$ref": "Principal" -}, -"type": "array" -}, -"inheritAclFrom": { -"description": "The name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.", -"type": "string" -}, -"owners": { -"description": "Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.", -"items": { -"$ref": "Principal" -}, -"type": "array" -}, -"readers": { -"description": "List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.", -"items": { -"$ref": "Principal" -}, -"type": "array" -} -}, -"type": "object" -}, -"ItemContent": { -"description": "Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded.", -"id": "ItemContent", -"properties": { -"contentDataRef": { -"$ref": "UploadItemRef", -"description": "Upload reference ID of a previously uploaded content via write method." -}, -"contentFormat": { -"enum": [ -"UNSPECIFIED", -"HTML", -"TEXT", -"RAW" -], -"enumDescriptions": [ -"Invalid value.", -"contentFormat is HTML.", -"contentFormat is free text.", -"contentFormat is raw bytes." -], -"type": "string" -}, -"hash": { -"description": "Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", -"type": "string" -}, -"inlineContent": { -"description": "Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB).", -"format": "byte", -"type": "string" -} -}, -"type": "object" -}, -"ItemCountByStatus": { -"id": "ItemCountByStatus", -"properties": { -"count": { -"description": "Number of items matching the status code.", -"format": "int64", -"type": "string" -}, -"indexedItemsCount": { -"description": "Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code.", -"format": "int64", -"type": "string" -}, -"statusCode": { -"description": "Status of the items.", -"enum": [ -"CODE_UNSPECIFIED", -"ERROR", -"MODIFIED", -"NEW_ITEM", -"ACCEPTED" -], -"enumDescriptions": [ -"Input-only value. Used with Items.list to list all items in the queue, regardless of status.", -"Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", -"Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", -"Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", -"API has accepted the up-to-date data of this item." -], -"type": "string" -} -}, -"type": "object" -}, -"ItemMetadata": { -"description": "Available metadata fields for the item.", -"id": "ItemMetadata", -"properties": { -"containerName": { -"description": "The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.", -"type": "string" -}, -"contentLanguage": { -"description": "The BCP-47 language code for the item, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.", -"type": "string" -}, -"contextAttributes": { -"description": "A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.", -"items": { -"$ref": "ContextAttribute" -}, -"type": "array" -}, -"createTime": { -"description": "The time when the item was created in the source repository.", -"format": "google-datetime", -"type": "string" -}, -"hash": { -"description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", -"type": "string" -}, -"interactions": { -"description": "A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.", -"items": { -"$ref": "Interaction" -}, -"type": "array" -}, -"keywords": { -"description": "Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.", -"items": { -"type": "string" -}, -"type": "array" -}, -"mimeType": { -"description": "The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.", -"type": "string" -}, -"objectType": { -"description": "The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.", -"type": "string" -}, -"searchQualityMetadata": { -"$ref": "SearchQualityMetadata", -"description": "Additional search quality metadata of the item" -}, -"sourceRepositoryUrl": { -"description": "Link to the source repository serving the data. Seach results apply this link to the title. Whitespace or special characters may cause Cloud Seach result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.", -"type": "string" -}, -"title": { -"description": "The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.", -"type": "string" -}, -"updateTime": { -"description": "The time when the item was last modified in the source repository.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, -"ItemStatus": { -"description": "This contains item's status and any errors.", -"id": "ItemStatus", -"properties": { -"code": { -"description": "Status code.", -"enum": [ -"CODE_UNSPECIFIED", -"ERROR", -"MODIFIED", -"NEW_ITEM", -"ACCEPTED" -], -"enumDescriptions": [ -"Input-only value. Used with Items.list to list all items in the queue, regardless of status.", -"Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", -"Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", -"Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", -"API has accepted the up-to-date data of this item." -], -"type": "string" -}, -"processingErrors": { -"description": "Error details in case the item is in ERROR state.", -"items": { -"$ref": "ProcessingError" -}, -"type": "array" -}, -"repositoryErrors": { -"description": "Repository error reported by connector.", -"items": { -"$ref": "RepositoryError" -}, -"type": "array" -} -}, -"type": "object" -}, -"ItemStructuredData": { -"description": "Available structured data fields for the item.", -"id": "ItemStructuredData", -"properties": { -"hash": { -"description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", -"type": "string" -}, -"object": { -"$ref": "StructuredDataObject", -"description": "The structured data object that should conform to a registered object definition in the schema for the data source." -} -}, -"type": "object" -}, -"ListDataSourceResponse": { -"id": "ListDataSourceResponse", -"properties": { -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -}, -"sources": { -"items": { -"$ref": "DataSource" -}, -"type": "array" -} -}, -"type": "object" -}, -"ListItemNamesForUnmappedIdentityResponse": { -"id": "ListItemNamesForUnmappedIdentityResponse", -"properties": { -"itemNames": { -"items": { -"type": "string" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -} -}, -"type": "object" -}, -"ListItemsResponse": { -"id": "ListItemsResponse", -"properties": { -"items": { -"items": { -"$ref": "Item" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -} -}, -"type": "object" -}, -"ListOperationsResponse": { -"description": "The response message for Operations.ListOperations.", -"id": "ListOperationsResponse", -"properties": { -"nextPageToken": { -"description": "The standard List next-page token.", -"type": "string" -}, -"operations": { -"description": "A list of operations that matches the specified filter in the request.", -"items": { -"$ref": "Operation" -}, -"type": "array" -} -}, -"type": "object" -}, -"ListQuerySourcesResponse": { -"description": "List sources response.", -"id": "ListQuerySourcesResponse", -"properties": { -"nextPageToken": { -"type": "string" -}, -"sources": { -"items": { -"$ref": "QuerySource" -}, -"type": "array" -} -}, -"type": "object" -}, -"ListSearchApplicationsResponse": { -"id": "ListSearchApplicationsResponse", -"properties": { -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -}, -"searchApplications": { -"items": { -"$ref": "SearchApplication" -}, -"type": "array" -} -}, -"type": "object" -}, -"ListUnmappedIdentitiesResponse": { -"id": "ListUnmappedIdentitiesResponse", -"properties": { -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -}, -"unmappedIdentities": { -"items": { -"$ref": "UnmappedIdentity" -}, -"type": "array" -} -}, -"type": "object" -}, -"LocationExtractorFeatureletAnnotationSet": { -"description": "A set of featurelet annotations for an alternate policy.", -"id": "LocationExtractorFeatureletAnnotationSet", -"properties": { -"annotations": { -"description": "The featurelet annotations for the alternate policy.", -"items": { -"enum": [ -"TRIMMED_BY_QUALITY_FILTERING" -], -"enumDescriptions": [ -"Indicate that a featurelet should not be used. This annotation is applied during ApplyQualityFiltering for feature \"trimming\" or added by the PolicyStore as a result of quality score calculation." -], -"type": "string" -}, -"type": "array" -}, -"name": { -"description": "The name of the alternate policy.", -"type": "string" -} -}, -"type": "object" -}, -"LocationExtractorInterpretation": { -"description": "An interpretation is a place on earth, an annotated query s-tree and a 'legend' grouping tokens into terms, and mapping those to the hierarchy of featurelets inside the location. An interpretation is returned as part of the LocationExtractionResponse and not meant to be used directly. Next tag: 15", -"id": "LocationExtractorInterpretation", -"properties": { -"location": { -"$ref": "LocationExtractorLocation", -"description": "Location on Earth, containing featurelets ordered from most to least specific. These are referred to in the featurelet_index field below. In case of directions queries, this field contains departure location." -}, -"query": { -"description": "serialized s-expr annotated with :loc", -"type": "string" -}, -"term": { -"items": { -"$ref": "LocationExtractorInterpretationTerm" -}, -"type": "array" -} -}, -"type": "object" -}, -"LocationExtractorInterpretationTerm": { -"description": "This group provides details about what we found in the query as a set of non-overlapping 'terms', each referring to a separate political feature. E.g. query of \"Pizza near Mt View CA\" would (in one of the geocodes) contain two terms: \"Mt View\" and \"CA\". All terms are given in left-to-right order. Note that not all featurelets necessarily occur as a term. Some may have been inferred from the political hierarchy. E.g. in the example above there would be a featurelet for the US after the one for \"CA\".", -"id": "LocationExtractorInterpretationTerm", -"properties": { -"featureletIndex": { -"description": "index into location().featurelet() array (above).", -"format": "int32", -"type": "integer" -}, -"tokenEnd": { -"description": "1+last token covered by this term.", -"format": "int32", -"type": "integer" -}, -"tokenStart": { -"description": "These token indexes refer to the non-negated tokens of the query returned by the Interpretation. Note: That means you have to parse the query field with the SqueryParser, use QueryTreeUtils::FindOriginalNonNegatedWordNodes to get the original tokens, and use these 1-based indexes to retrieve the appropriate tokens from the result. You can NOT just split the original raw query on whitespace and use this as an offset. first token covered by this term.", -"format": "int32", -"type": "integer" -}, -"unexpectedLanguageMatch": { -"description": "Whether this term matched in a language that is \"unexpected\". For this purpose, expected languages are: request language, languages spoken in request country, English, unknown languages, and languages of the feature's country.", -"type": "boolean" -} -}, -"type": "object" -}, -"LocationExtractorLocation": { -"description": "A Location message represents a geographical feature with an associated confidence level. Within a LocationExtractionServerResponse message, this message is used to specify possible locations of the user, and possible locations the user may be interested in. Next tag: 41", -"id": "LocationExtractorLocation", -"properties": { -"addressRank": { -"deprecated": true, -"description": "Copy of FeatureProto->RankDetailsProto->address_rank", -"format": "float", -"type": "number" -}, -"areaRank": { -"deprecated": true, -"description": "Copy of FeatureProto->RankDetailsProto->area_rank", -"format": "float", -"type": "number" -}, -"boundingbox": { -"$ref": "LocationExtractorLocationBoundingBox", -"deprecated": true -}, -"center": { -"$ref": "LocationExtractorLocationCenter", -"deprecated": true -}, -"confidence": { -"deprecated": true, -"description": "Represents the Location Extraction Server's confidence that this Location is correct.", -"format": "float", -"type": "number" -}, -"featurelet": { -"items": { -"$ref": "LocationExtractorLocationFeaturelet" -}, -"type": "array" -}, -"ipblockinfo": { -"$ref": "IPBlockInfoProto", -"description": "Information about an ip block, like range, speed etc." -}, -"populationRank": { -"deprecated": true, -"description": "Copy of FeatureProto->RankDetailsProto->population_rank", -"format": "float", -"type": "number" -} -}, -"type": "object" -}, -"LocationExtractorLocationBoundingBox": { -"description": "Defines the bounding box for the area. The values specify a rectangle defined from low to high. Latitude and longitude (in degrees) x 10,000,000. We use sfixed32 (fixed-size int32) because they get transmitted using 4 bytes while int32 gets transmitted using 10 bytes.", -"id": "LocationExtractorLocationBoundingBox", -"properties": { -"highLatitudeE7": { -"format": "int32", -"type": "integer" -}, -"highLongitudeE7": { -"format": "int32", -"type": "integer" -}, -"lowLatitudeE7": { -"format": "int32", -"type": "integer" -}, -"lowLongitudeE7": { -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"LocationExtractorLocationCenter": { -"description": "Latitude and longitude of the area center (in degrees) x 10,000,000", -"id": "LocationExtractorLocationCenter", -"properties": { -"latitudeE7": { -"format": "int32", -"type": "integer" -}, -"longitudeE7": { -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"LocationExtractorLocationExtractionResponse": { -"description": "A LocationExtractionResponse message represents a response from the Location Extraction Server. If a location and / or area of interest was found, they will be included in the response. Next tag: 8", -"id": "LocationExtractorLocationExtractionResponse", -"properties": { -"interpretation": { -"description": "The request.max_interpretation() most likely interpretations of the input sexpr or raw_query. The ordering of interpretations is determined by request.scorer().", -"items": { -"$ref": "LocationExtractorInterpretation" -}, -"type": "array" -}, -"tainted": { -"description": "True if the results are unreliable, for example due to a deadline being broken.", -"type": "boolean" -}, -"userLocation": { -"description": "Represents the location of the end user, either from the ip or the user_address field in the request. For historical reasons, this is up to 3 separate locations that form a political hierarchy. See location/extractor/client/public/location.h:MergeLocations for a function to merge them into one. NOTE: the user_location does NOT influence the interpretations below. see the remarks about the ip field above. Conversely, this field is the ONLY field that changes depending on ip or user_address input.", -"items": { -"$ref": "LocationExtractorLocation" -}, -"type": "array" -} -}, -"type": "object" -}, -"LocationExtractorLocationFeaturelet": { -"description": "A location must have one or more Featurelets, each of which correspond to a single GeoStore Feature. The first Featurelet is considered to be the primary component of the location, and any additional Featurelets should be considered supplementary. For example, the Location \"Brooklyn\" might have Featurelets: 1) Brooklyn (borough) 2) New York (city) 3) New York (state) 4) United States (country) LINT.IfChange", -"id": "LocationExtractorLocationFeaturelet", -"properties": { -"additionalData": { -"$ref": "MessageSet", -"description": "A field to attach additional data about the feature. For example, the location extraction server uses this field to include the ads criteria id of the featurelet if available. As specified by MessageSet, all types within the set must be unique. Using the changelist number where the message was created is a good method of ensuring uniqueness." -}, -"alternateAnnotations": { -"description": "Alternate annotations on this featurelet.", -"items": { -"$ref": "LocationExtractorFeatureletAnnotationSet" -}, -"type": "array" -}, -"annotations": { -"description": "Annotations applied to this featurelet. This field is modified by the policy store.", -"items": { -"enum": [ -"TRIMMED_BY_QUALITY_FILTERING" -], -"enumDescriptions": [ -"Indicate that a featurelet should not be used. This annotation is applied during ApplyQualityFiltering for feature \"trimming\" or added by the PolicyStore as a result of quality score calculation." -], -"type": "string" -}, -"type": "array" -}, -"areaRank": { -"description": "Copy of FeatureProto->RankDetailsProto->area_rank", -"format": "float", -"type": "number" -}, -"boundingbox": { -"$ref": "LocationExtractorLocationFeatureletBoundingBox" -}, -"center": { -"$ref": "LocationExtractorLocationFeatureletCenter" -}, -"confidence": { -"description": "Represents the Location Extraction Server's confidence that this featurelet is correct. This is currently not populated by LES. Oolong will parse the LES response for IP addreses and combine multiple locations into a single location with multiple featurelets. This confidence will be populated by Oolong by looking into confidences from each of the locations.", -"format": "float", -"type": "number" -}, -"establishmentType": { -"description": "This field contains original feature's establishment type if it had one.", -"enum": [ -"TYPE_ANY", -"TYPE_UNDEFINED", -"TYPE_DEPRECATED_AVIATION", -"TYPE_BUSINESS", -"TYPE_TRAVEL_SERVICE", -"TYPE_LODGING", -"TYPE_HOTEL", -"TYPE_RESORT", -"TYPE_MOTEL", -"TYPE_HOSTEL", -"TYPE_GUESTHOUSE", -"TYPE_VACATION_RENTAL", -"TYPE_GAS_STATION", -"TYPE_REST_AREA", -"TYPE_CASH_MACHINE", -"TYPE_CAR_RENTAL", -"TYPE_CAR_REPAIR", -"TYPE_TAXI_STAND", -"TYPE_TRAVEL_AGENT", -"TYPE_BICYCLE_RENTAL_POINT", -"TYPE_ELECTRIC_VEHICLE_CHARGING_STATION", -"TYPE_SHOPPING", -"TYPE_GROCERY", -"TYPE_ANTIQUES", -"TYPE_APPAREL", -"TYPE_GIFTS", -"TYPE_JEWELRY", -"TYPE_SPORTING_GOODS", -"TYPE_VEHICLE", -"TYPE_SHOPPING_CENTER", -"TYPE_SUPERMARKET", -"TYPE_FAIRGROUNDS", -"TYPE_MARKET", -"TYPE_PRODUCE_MARKET", -"TYPE_FARMERS_MARKET", -"TYPE_LIQUOR_STORE", -"TYPE_SOUVENIR_SHOP", -"TYPE_INDUSTRIAL", -"TYPE_CONSTRUCTION", -"TYPE_BUILDING_MATERIAL", -"TYPE_SECURITY_PRODUCTS", -"TYPE_MECHANICAL", -"TYPE_TEXTILE", -"TYPE_CHEMICAL", -"TYPE_METAL", -"TYPE_TRANSPORTATION", -"TYPE_FREIGHT", -"TYPE_AVIATION", -"TYPE_COURIER", -"TYPE_MOVING", -"TYPE_PACKAGING", -"TYPE_RAIL", -"TYPE_PUBLIC_TRANSIT", -"TYPE_WAREHOUSE", -"TYPE_DEFENSE", -"TYPE_AGRICULTURE", -"TYPE_PLANTATION", -"TYPE_PLANT_NURSERY", -"TYPE_DESIGN", -"TYPE_UTILITIES", -"TYPE_POWER_PLANT", -"TYPE_SEWAGE_TREATMENT_PLANT", -"TYPE_WATER_TREATMENT_PLANT", -"TYPE_SUBSTATION", -"TYPE_MANUFACTURING", -"TYPE_BIOTECH", -"TYPE_MATERIALS", -"TYPE_MINING", -"TYPE_QUARRY", -"TYPE_TANNERY", -"TYPE_OIL_REFINERY", -"TYPE_ADVERTISING_MARKETING", -"TYPE_LEGAL", -"TYPE_FAMILY_LAW", -"TYPE_IP_LAW", -"TYPE_LABOR_LAW", -"TYPE_PERSONAL_INJURY_LAW", -"TYPE_CRIMINAL_LAW", -"TYPE_PERSONAL_FINANCE", -"TYPE_LIFE_INSURANCE", -"TYPE_LENDING", -"TYPE_ACCOUNTING", -"TYPE_INVESTING", -"TYPE_BANKING", -"TYPE_HEALTH", -"TYPE_HEALTH_EQUIPMENT", -"TYPE_NURSING", -"TYPE_HEALTH_INSURANCE", -"TYPE_HEALTH_FACILITY", -"TYPE_DIAGNOSTIC_CENTER", -"TYPE_HEALTH_RESOURCES", -"TYPE_NUTRITION", -"TYPE_VISION", -"TYPE_COUNSELING", -"TYPE_MASSAGE", -"TYPE_BLOOD_BANK", -"TYPE_HEARING", -"TYPE_HOME_GARDEN", -"TYPE_INTERIOR_DECOR", -"TYPE_DOMESTIC_SERVICES", -"TYPE_APPLIANCES", -"TYPE_PEST_CONTROL", -"TYPE_GARDENING", -"TYPE_ELECTRONICS", -"TYPE_COMPUTER", -"TYPE_COMPUTER_HARDWARE", -"TYPE_COMPUTER_SECURITY", -"TYPE_COMPUTER_SOFTWARE", -"TYPE_COMPUTER_SUPPORT", -"TYPE_AUDIO_DEVICES", -"TYPE_VIDEO_DEVICES", -"TYPE_REAL_ESTATE", -"TYPE_OFFICE_SERVICES", -"TYPE_ENTERTAINMENT", -"TYPE_GAMES", -"TYPE_CASINO", -"TYPE_LOTTO", -"TYPE_VIDEO", -"TYPE_CLUBS", -"TYPE_DISCOTHEQUE", -"TYPE_ANIMATION", -"TYPE_MODELING", -"TYPE_HUMOR", -"TYPE_MOVIES", -"TYPE_MOVIE_RENTAL", -"TYPE_MOVIE_THEATER", -"TYPE_MUSIC", -"TYPE_RADIO", -"TYPE_TV", -"TYPE_BAR", -"TYPE_PRINT_MEDIA", -"TYPE_ADULT", -"TYPE_SEXUAL_SERVICES", -"TYPE_ANIMALS", -"TYPE_PETS", -"TYPE_FISHERY", -"TYPE_ARTS", -"TYPE_BOOKS", -"TYPE_PERFORMING_ARTS", -"TYPE_GALLERY", -"TYPE_AUTOMOTIVE", -"TYPE_PARTS", -"TYPE_AUTO_FINANCE", -"TYPE_AUTO_INSURANCE", -"TYPE_RV", -"TYPE_MOTORCYCLES", -"TYPE_CARS", -"TYPE_TRUCKS_SUVS", -"TYPE_LICENSING", -"TYPE_MAINTENANCE", -"TYPE_PERSONAL_CARE", -"TYPE_BODY_ART", -"TYPE_COSMETICS", -"TYPE_FITNESS", -"TYPE_YOGA_CENTER", -"TYPE_GYM", -"TYPE_HAIR_CARE", -"TYPE_SPA", -"TYPE_BEAUTY_SALON", -"TYPE_CORPORATE_EVENTS", -"TYPE_HUMAN_RESOURCES", -"TYPE_FOOD_AND_DRINK", -"TYPE_BEVERAGE", -"TYPE_RECIPES", -"TYPE_COOKWARE", -"TYPE_CULINARY", -"TYPE_RETAIL", -"TYPE_RESTAURANT", -"TYPE_COFFEE", -"TYPE_BAKERY", -"TYPE_FOOD_CENTER", -"TYPE_TEA", -"TYPE_CAFE", -"TYPE_WINERY", -"TYPE_BREWERY", -"TYPE_FAST_FOOD", -"TYPE_FOOD_DELIVERY", -"TYPE_INTERNET", -"TYPE_WEB_DESIGN", -"TYPE_WEB_HOSTING", -"TYPE_WEB_SERVICES", -"TYPE_LIFESTYLE", -"TYPE_PHOTO_VIDEO", -"TYPE_ACTIVITIES", -"TYPE_BOATING", -"TYPE_CYCLING", -"TYPE_EQUESTRIAN", -"TYPE_FISHING", -"TYPE_HIKING", -"TYPE_HUNTING", -"TYPE_SWIMMING", -"TYPE_GOLF", -"TYPE_GOLF_COURSE", -"TYPE_BASEBALL", -"TYPE_BASKETBALL", -"TYPE_HOCKEY", -"TYPE_MOTOR_SPORTS", -"TYPE_WINTER_SPORTS", -"TYPE_FOOTBALL", -"TYPE_SOCCER", -"TYPE_ICE_SKATING", -"TYPE_BOXING", -"TYPE_CRICKET", -"TYPE_ROWING", -"TYPE_RUGBY", -"TYPE_RACQUET_SPORTS", -"TYPE_ROCK_CLIMBING", -"TYPE_REFERENCES", -"TYPE_MAPS", -"TYPE_TIME", -"TYPE_SCIENTIFIC_EQUIPMENT", -"TYPE_TELECOMMUNICATIONS", -"TYPE_EVENT_VENUE", -"TYPE_BANQUET_HALL", -"TYPE_CONFERENCE_HALL", -"TYPE_WEDDING_HALL", -"TYPE_EXHIBITION_HALL", -"TYPE_COMMUNITY_CENTER", -"TYPE_AUDITORIUM", -"TYPE_FUNCTION_HALL", -"TYPE_CONCERT_HALL", -"TYPE_AMPHITHEATER", -"TYPE_LAUNDRY", -"TYPE_LAUNDROMAT", -"TYPE_DRY_CLEANER", -"TYPE_MORTUARY", -"TYPE_REPAIR_AND_MAINTENANCE", -"TYPE_GOVERNMENT", -"TYPE_BORDER_CROSSING", -"TYPE_CITY_HALL", -"TYPE_COURTHOUSE", -"TYPE_EMBASSY", -"TYPE_LIBRARY", -"TYPE_PRISON", -"TYPE_TAX_OFFICE", -"TYPE_PROSECUTORS_OFFICE", -"TYPE_CONGRESS", -"TYPE_TOWN_COUNCIL", -"TYPE_CAPITOL_BUILDING", -"TYPE_VOTING_FACILITY", -"TYPE_CHECKPOINT", -"TYPE_SCHOOL", -"TYPE_UNIVERSITY", -"TYPE_ORPHANAGE", -"TYPE_KINDERGARTEN", -"TYPE_DAYCARE", -"TYPE_ACADEMY", -"TYPE_TRADE_SCHOOL", -"TYPE_SKILL_INSTRUCTION", -"TYPE_EMERGENCY", -"TYPE_HOSPITAL", -"TYPE_PHARMACY", -"TYPE_POLICE", -"TYPE_FIRE", -"TYPE_DOCTOR", -"TYPE_DENTIST", -"TYPE_VETERINARIAN", -"TYPE_FIRST_AID", -"TYPE_CIVIL_DEFENSE", -"TYPE_TOURIST_DESTINATION", -"TYPE_ECO_TOURIST_DESTINATION", -"TYPE_BIRD_WATCHING", -"TYPE_NATURE_RESERVE", -"TYPE_MUSEUM", -"TYPE_VISITOR_CENTER", -"TYPE_OBSERVATION_DECK", -"TYPE_OBSERVATORY", -"TYPE_SCENIC_POINT", -"TYPE_ZOO", -"TYPE_AQUARIUM", -"TYPE_AMUSEMENT_PARK", -"TYPE_MONUMENT", -"TYPE_PALACE", -"TYPE_FORT", -"TYPE_TOWER", -"TYPE_LIGHTHOUSE", -"TYPE_TEMPLE", -"TYPE_CHURCH", -"TYPE_GURUDWARA", -"TYPE_HINDU_TEMPLE", -"TYPE_MOSQUE", -"TYPE_SYNAGOGUE", -"TYPE_BUDDHIST_TEMPLE", -"TYPE_JAIN_TEMPLE", -"TYPE_BAHAI_TEMPLE", -"TYPE_SHINTO_TEMPLE", -"TYPE_MORMON_TEMPLE", -"TYPE_SPORTS_COMPLEX", -"TYPE_STADIUM", -"TYPE_BOWLING", -"TYPE_BADMINTON", -"TYPE_TENNIS", -"TYPE_TABLE_TENNIS", -"TYPE_PARK", -"TYPE_LOCAL_PARK", -"TYPE_NATIONAL_PARK", -"TYPE_US_NATIONAL_PARK", -"TYPE_US_NATIONAL_MONUMENT", -"TYPE_NATIONAL_FOREST", -"TYPE_NATIONAL_GRASSLAND", -"TYPE_NATIONAL_PRESERVE", -"TYPE_NATIONAL_RECREATION_AREA", -"TYPE_NATIONAL_MONUMENT", -"TYPE_NATIONAL_HISTORIC_AREA", -"TYPE_NATIONAL_SCENIC_AREA", -"TYPE_NATIONAL_SCENIC_ROADWAY_AREA", -"TYPE_NATIONAL_SCENIC_RIVER_AREA", -"TYPE_PROVINCIAL_PARK", -"TYPE_PROVINCIAL_FOREST", -"TYPE_CAMPGROUNDS", -"TYPE_WILDERNESS_AREA", -"TYPE_WILDLIFE_AREA", -"TYPE_BOTANICAL_GARDEN", -"TYPE_GARDEN", -"TYPE_ARBORETUM", -"TYPE_MARINE_PROTECTED_AREA", -"TYPE_AIRPORT", -"TYPE_TARMAC", -"TYPE_HELIPORT", -"TYPE_SEAPLANE_BASE", -"TYPE_MILITARY_AIRBASE", -"TYPE_CEMETERY", -"TYPE_MILITARY", -"TYPE_ENCLOSED_TRAFFIC_AREA", -"TYPE_PARKING", -"TYPE_OFF_ROAD_AREA", -"TYPE_POST_OFFICE", -"TYPE_HOUSING_DEVELOPMENT", -"TYPE_BRIDGE", -"TYPE_ARCHAEOLOGICAL", -"TYPE_HISTORICAL", -"TYPE_RUINS", -"TYPE_TUNNEL", -"TYPE_RESIDENTIAL_DWELLING", -"TYPE_DETACHED_DWELLING", -"TYPE_ATTACHED_DWELLING", -"TYPE_APARTMENT", -"TYPE_GATED_COMMUNITY", -"TYPE_RETIREMENT_HOME", -"TYPE_TOLL_BOOTH", -"TYPE_CULTURAL", -"TYPE_CULTURAL_CENTER", -"TYPE_OVERPASS", -"TYPE_REST_ROOM", -"TYPE_PUBLIC_PHONE", -"TYPE_PHONE_BOOTH", -"TYPE_MANNED_PCO", -"TYPE_RESEARCH_INSTITUTE", -"TYPE_NON_GOVERNMENTAL_ORGANIZATION", -"TYPE_OFFICE_PARK", -"TYPE_MEDITATION_CENTER", -"TYPE_RELIGIOUS", -"TYPE_MONASTERY", -"TYPE_ASHRAM", -"TYPE_PAGODA", -"TYPE_MISSION", -"TYPE_PILGRIM_DESTINATION", -"TYPE_SOCIAL_SERVICE", -"TYPE_RANGER_STATION", -"TYPE_TRANSIT_STATION", -"TYPE_BUS_STATION", -"TYPE_TRAMWAY_STATION", -"TYPE_TRAIN_STATION", -"TYPE_SUBWAY_STATION", -"TYPE_FERRY_TERMINAL", -"TYPE_CABLE_CAR_STATION", -"TYPE_GONDOLA_LIFT_STATION", -"TYPE_FUNICULAR_STATION", -"TYPE_HORSE_CARRIAGE_STATION", -"TYPE_MONORAIL_STATION", -"TYPE_SEAPORT", -"TYPE_NATURAL_FEATURE", -"TYPE_ELEVATED", -"TYPE_PEAK" -], -"enumDescriptions": [ -"ABSTRACT", -"Can be used for features where no establishment information is available. For example, if an importer generates a TYPE_ESTABLISHMENT_BUILDING feature, but source data does not have any information on the actual purpose of the building, the importer should use TYPE_UNDEFINED for establishment type.", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Note: 0xF213F is reserved to extend TYPE_INDUSTRIAL", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"0xF6F is reserved and any new types should start with 0xF6F1", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"State parks, county parks, city parks, wilderness areas. This also includes underwater preserves, wild and scenic rivers, etc. Should we have things like baseball diamonds?", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Wildlife management area. This includes preservation areas for fish, game, and birds.", -"", -"", -"", -"", -"", -"An airport is a location where aircraft such as fixed-wing aircraft, helicopters, and blimps takeoff and land. NOTE: TYPE_TARMAC establishment type has been deprecated in favor of TYPE_TARMAC feature type. Once all data is modeled using the new feature type, the entry below should be removed.", -"DEPRECATED", -"A heliport is a small airport suitable only for use by helicopters.", -"A seaplane base is a special airport suitable for seaplanes.", -"An airbase (sometimes referred to correctly as an airfield, military airport, or Royal Air Force Station or Air Force Station) is a military airfield that provides basing and support of military aircraft.", -"", -"", -"The term \"enclosed traffic area\" is used extensively in Europe. It generally refers to a parking lot or other similar area through which traffic passes but are not generally considered to be a road. Another example is a piazza in an Italian town.", -"Establishment TYPE_PARKING is used for parking lots or garages. The actual feature type can be TYPE_ESTABLISHMENT_GROUNDS or TYPE_ESTABLISHMENT_BUILDING to distinguish between those.", -"", -"", -"In some country (like China), there will have a small area of housing development. Normally covers one or more city blocks.", -"In the Australian data we get bridges as POIs effectively. We'd like to include them so we can mapsearch for \"Sydney Harbour Bridge\" and others. Many other data sets have bridges modeled directly as segments, and so don't require this.", -"", -"In some countries historical objects are well known and important.", -"", -"Feature must be TYPE_ESTABLISHMENT_GROUNDS.", -"These types, when used with appropriate feature type (TYPE_ESTABLISHMENT_BUILDING, TYPE_ESTABLISHMENT_GROUNDS) can refer to a single building or a residential area (respectively).", -"", -"", -"All multi-unit housing such as duplex, condominium, apartment belongs to this.", -"", -"", -"In Korea most toll booths have their own names, and are often used as reference points. If an importer generates TYPE_TOLL_BOOTH establishment features with exact positions and names, then mapsearch will index them. Also this can be used to render them.", -"", -"", -"An overpass, or flyover is a structure that passes over another road or railway.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Hierarchy of transit station types. See go/transit-schema for more details.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"" -], -"type": "string" -}, -"featureId": { -"$ref": "GeostoreFeatureIdProto", -"description": "The GeoStore Feature ID for this feature. This field will be present when the featurelet was derived from or maps to an oyster feature." -}, -"kgReference": { -"$ref": "GeostoreKnowledgeGraphReferenceProto", -"description": "The reference to an entity in the KnowledgeGraph." -}, -"name": { -"description": "Each Featurelet includes the list of names that are associated with the corresponding GeoStore Feature.", -"items": { -"$ref": "GeostoreNameProto" -}, -"type": "array" -}, -"populationRank": { -"description": "Copy of FeatureProto->RankDetailsProto->population_rank", -"format": "float", -"type": "number" -}, -"type": { -"description": "The GeoStore Feature type.", -"enum": [ -"TYPE_ANY", -"TYPE_TRANSPORTATION", -"TYPE_ROUTE", -"TYPE_DEPRECATED_HIGHWAY_DO_NOT_USE", -"TYPE_HIGHWAY", -"TYPE_HIGHWAY_1", -"TYPE_HIGHWAY_2", -"TYPE_HIGHWAY_3", -"TYPE_HIGHWAY_4", -"TYPE_HIGHWAY_5", -"TYPE_HIGHWAY_6", -"TYPE_HIGHWAY_7", -"TYPE_HIGHWAY_8", -"TYPE_HIGHWAY_9", -"TYPE_BICYCLE_ROUTE", -"TYPE_TRAIL", -"TYPE_SEGMENT", -"TYPE_ROAD", -"TYPE_RAILWAY", -"TYPE_STANDARD_TRACK", -"TYPE_JR_TRACK", -"TYPE_NARROW_TRACK", -"TYPE_MONORAIL_TRACK", -"TYPE_SUBWAY_TRACK", -"TYPE_LIGHT_RAIL_TRACK", -"TYPE_BROAD_TRACK", -"TYPE_HIGH_SPEED_RAIL", -"TYPE_TROLLEY_TRACK", -"TYPE_FERRY", -"TYPE_FERRY_BOAT", -"TYPE_FERRY_TRAIN", -"TYPE_VIRTUAL_SEGMENT", -"TYPE_INTERSECTION", -"TYPE_TRANSIT", -"TYPE_TRANSIT_STATION", -"TYPE_BUS_STATION", -"TYPE_TRAMWAY_STATION", -"TYPE_TRAIN_STATION", -"TYPE_SUBWAY_STATION", -"TYPE_FERRY_TERMINAL", -"TYPE_AIRPORT", -"TYPE_AIRPORT_CIVIL", -"TYPE_AIRPORT_MILITARY", -"TYPE_AIRPORT_MIXED", -"TYPE_HELIPORT", -"TYPE_SEAPLANE_BASE", -"TYPE_AIRSTRIP", -"TYPE_CABLE_CAR_STATION", -"TYPE_GONDOLA_LIFT_STATION", -"TYPE_FUNICULAR_STATION", -"TYPE_SPECIAL_STATION", -"TYPE_HORSE_CARRIAGE_STATION", -"TYPE_MONORAIL_STATION", -"TYPE_SEAPORT", -"TYPE_TRANSIT_STOP", -"TYPE_TRANSIT_TRIP", -"TYPE_TRANSIT_DEPARTURE", -"TYPE_TRANSIT_LEG", -"TYPE_TRANSIT_LINE", -"TYPE_TRANSIT_AGENCY_DEPRECATED_VALUE", -"TYPE_TRANSIT_TRANSFER", -"TYPE_SEGMENT_PATH", -"TYPE_ROAD_SIGN", -"TYPE_INTERSECTION_GROUP", -"TYPE_PATHWAY", -"TYPE_RESTRICTION_GROUP", -"TYPE_TOLL_CLUSTER", -"TYPE_POLITICAL", -"TYPE_COUNTRY", -"TYPE_ADMINISTRATIVE_AREA", -"TYPE_ADMINISTRATIVE_AREA1", -"TYPE_US_STATE", -"TYPE_GB_COUNTRY", -"TYPE_JP_TODOUFUKEN", -"TYPE_ADMINISTRATIVE_AREA2", -"TYPE_GB_FORMER_POSTAL_COUNTY", -"TYPE_GB_TRADITIONAL_COUNTY", -"TYPE_ADMINISTRATIVE_AREA3", -"TYPE_ADMINISTRATIVE_AREA4", -"TYPE_ADMINISTRATIVE_AREA5", -"TYPE_ADMINISTRATIVE_AREA6", -"TYPE_ADMINISTRATIVE_AREA7", -"TYPE_ADMINISTRATIVE_AREA8", -"TYPE_ADMINISTRATIVE_AREA9", -"TYPE_COLLOQUIAL_AREA", -"TYPE_RESERVATION", -"TYPE_LOCALITY", -"TYPE_GB_POST_TOWN", -"TYPE_JP_GUN", -"TYPE_JP_SHIKUCHOUSON", -"TYPE_JP_SUB_SHIKUCHOUSON", -"TYPE_COLLOQUIAL_CITY", -"TYPE_SUBLOCALITY", -"TYPE_US_BOROUGH", -"TYPE_GB_DEPENDENT_LOCALITY", -"TYPE_JP_OOAZA", -"TYPE_JP_KOAZA", -"TYPE_JP_GAIKU", -"TYPE_GB_DOUBLE_DEPENDENT_LOCALITY", -"TYPE_JP_CHIBAN", -"TYPE_JP_EDABAN", -"TYPE_SUBLOCALITY1", -"TYPE_SUBLOCALITY2", -"TYPE_SUBLOCALITY3", -"TYPE_SUBLOCALITY4", -"TYPE_SUBLOCALITY5", -"TYPE_NEIGHBORHOOD", -"TYPE_CONSTITUENCY", -"TYPE_DESIGNATED_MARKET_AREA", -"TYPE_SCHOOL_DISTRICT", -"TYPE_LAND_PARCEL", -"TYPE_DISPUTED_AREA", -"TYPE_POLICE_JURISDICTION", -"TYPE_STATISTICAL_AREA", -"TYPE_CONSTITUENCY_FUTURE", -"TYPE_PARK", -"TYPE_GOLF_COURSE", -"TYPE_LOCAL_PARK", -"TYPE_NATIONAL_PARK", -"TYPE_US_NATIONAL_PARK", -"TYPE_US_NATIONAL_MONUMENT", -"TYPE_NATIONAL_FOREST", -"TYPE_PROVINCIAL_PARK", -"TYPE_PROVINCIAL_FOREST", -"TYPE_CAMPGROUNDS", -"TYPE_HIKING_AREA", -"TYPE_BUSINESS", -"TYPE_GOVERNMENT", -"TYPE_BORDER_CROSSING", -"TYPE_CITY_HALL", -"TYPE_COURTHOUSE", -"TYPE_EMBASSY", -"TYPE_LIBRARY", -"TYPE_SCHOOL", -"TYPE_UNIVERSITY", -"TYPE_EMERGENCY", -"TYPE_HOSPITAL", -"TYPE_PHARMACY", -"TYPE_POLICE", -"TYPE_FIRE", -"TYPE_DOCTOR", -"TYPE_DENTIST", -"TYPE_VETERINARIAN", -"TYPE_TRAVEL_SERVICE", -"TYPE_LODGING", -"TYPE_RESTAURANT", -"TYPE_GAS_STATION", -"TYPE_PARKING", -"TYPE_POST_OFFICE", -"TYPE_REST_AREA", -"TYPE_CASH_MACHINE", -"TYPE_CAR_RENTAL", -"TYPE_CAR_REPAIR", -"TYPE_SHOPPING", -"TYPE_GROCERY", -"TYPE_TOURIST_DESTINATION", -"TYPE_ECO_TOURIST_DESTINATION", -"TYPE_BIRD_WATCHING", -"TYPE_FISHING", -"TYPE_HUNTING", -"TYPE_NATURE_RESERVE", -"TYPE_TEMPLE", -"TYPE_CHURCH", -"TYPE_GURUDWARA", -"TYPE_HINDU_TEMPLE", -"TYPE_MOSQUE", -"TYPE_SYNAGOGUE", -"TYPE_STADIUM", -"TYPE_BAR", -"TYPE_MOVIE_RENTAL", -"TYPE_COFFEE", -"TYPE_GOLF", -"TYPE_BANK", -"TYPE_DOODLE", -"TYPE_GROUNDS", -"TYPE_AIRPORT_GROUNDS", -"TYPE_BUILDING_GROUNDS", -"TYPE_CEMETERY", -"TYPE_HOSPITAL_GROUNDS", -"TYPE_INDUSTRIAL", -"TYPE_MILITARY", -"TYPE_SHOPPING_CENTER", -"TYPE_SPORTS_COMPLEX", -"TYPE_UNIVERSITY_GROUNDS", -"TYPE_DEPRECATED_TARMAC", -"TYPE_ENCLOSED_TRAFFIC_AREA", -"TYPE_PARKING_LOT", -"TYPE_PARKING_GARAGE", -"TYPE_OFF_ROAD_AREA", -"TYPE_BORDER", -"TYPE_BUILDING", -"TYPE_GEOCODED_ADDRESS", -"TYPE_NATURAL_FEATURE", -"TYPE_TERRAIN", -"TYPE_SAND", -"TYPE_BEACH", -"TYPE_DUNE", -"TYPE_ROCKY", -"TYPE_ICE", -"TYPE_GLACIER", -"TYPE_BUILT_UP_AREA", -"TYPE_VEGETATION", -"TYPE_SHRUBBERY", -"TYPE_WOODS", -"TYPE_AGRICULTURAL", -"TYPE_GRASSLAND", -"TYPE_TUNDRA", -"TYPE_DESERT", -"TYPE_SALT_FLAT", -"TYPE_WATER", -"TYPE_OCEAN", -"TYPE_BAY", -"TYPE_BIGHT", -"TYPE_LAGOON", -"TYPE_SEA", -"TYPE_STRAIT", -"TYPE_INLET", -"TYPE_FJORD", -"TYPE_LAKE", -"TYPE_SEASONAL_LAKE", -"TYPE_RESERVOIR", -"TYPE_POND", -"TYPE_RIVER", -"TYPE_RAPIDS", -"TYPE_DISTRIBUTARY", -"TYPE_CONFLUENCE", -"TYPE_WATERFALL", -"TYPE_SPRING", -"TYPE_GEYSER", -"TYPE_HOT_SPRING", -"TYPE_SEASONAL_RIVER", -"TYPE_WADI", -"TYPE_ESTUARY", -"TYPE_WETLAND", -"TYPE_WATER_NAVIGATION", -"TYPE_FORD", -"TYPE_CANAL", -"TYPE_HARBOR", -"TYPE_CHANNEL", -"TYPE_REEF", -"TYPE_REEF_FLAT", -"TYPE_REEF_GROWTH", -"TYPE_REEF_EXTENT", -"TYPE_REEF_ROCK_SUBMERGED", -"TYPE_IRRIGATION", -"TYPE_DAM", -"TYPE_DRINKING_WATER", -"TYPE_CURRENT", -"TYPE_WATERING_HOLE", -"TYPE_TECTONIC", -"TYPE_WATERING_HOLE_DEPRECATED", -"TYPE_VOLCANO", -"TYPE_LAVA_FIELD", -"TYPE_FISSURE", -"TYPE_FAULT", -"TYPE_LAND_MASS", -"TYPE_CONTINENT", -"TYPE_ISLAND", -"TYPE_ATOLL", -"TYPE_OCEAN_ROCK_EXPOSED", -"TYPE_CAY", -"TYPE_PENINSULA", -"TYPE_ISTHMUS", -"TYPE_ELEVATED", -"TYPE_PEAK", -"TYPE_NUNATAK", -"TYPE_SPUR", -"TYPE_PASS", -"TYPE_PLATEAU", -"TYPE_RIDGE", -"TYPE_RAVINE", -"TYPE_CRATER", -"TYPE_KARST", -"TYPE_CLIFF", -"TYPE_VISTA", -"TYPE_DIGITAL_ELEVATION_MODEL", -"TYPE_UPLAND", -"TYPE_TERRACE", -"TYPE_SLOPE", -"TYPE_CONTOUR_LINE", -"TYPE_PAN", -"TYPE_UNSTABLE_HILLSIDE", -"TYPE_MOUNTAIN_RANGE", -"TYPE_UNDERSEA", -"TYPE_SUBMARINE_SEAMOUNT", -"TYPE_SUBMARINE_RIDGE", -"TYPE_SUBMARINE_GAP", -"TYPE_SUBMARINE_PLATEAU", -"TYPE_SUBMARINE_DEEP", -"TYPE_SUBMARINE_VALLEY", -"TYPE_SUBMARINE_BASIN", -"TYPE_SUBMARINE_SLOPE", -"TYPE_SUBMARINE_CLIFF", -"TYPE_SUBMARINE_PLAIN", -"TYPE_SUBMARINE_FRACTURE_ZONE", -"TYPE_CAVE", -"TYPE_ROCK", -"TYPE_ARCHIPELAGO", -"TYPE_POSTAL", -"TYPE_POSTAL_CODE", -"TYPE_POSTAL_CODE_PREFIX", -"TYPE_PREMISE", -"TYPE_SUB_PREMISE", -"TYPE_SUITE", -"TYPE_POST_TOWN", -"TYPE_POSTAL_ROUND", -"TYPE_META_FEATURE", -"TYPE_DATA_SOURCE", -"TYPE_LOCALE", -"TYPE_TIMEZONE", -"TYPE_BUSINESS_CHAIN", -"TYPE_PHONE_NUMBER_PREFIX", -"TYPE_PHONE_NUMBER_AREA_CODE", -"TYPE_BUSINESS_CORRIDOR", -"TYPE_ADDRESS_TEMPLATE", -"TYPE_TRANSIT_AGENCY", -"TYPE_FUTURE_GEOMETRY", -"TYPE_EVENT", -"TYPE_EARTHQUAKE", -"TYPE_HURRICANE", -"TYPE_WEATHER_CONDITION", -"TYPE_TRANSIENT", -"TYPE_ENTRANCE", -"TYPE_CARTOGRAPHIC", -"TYPE_HIGH_TENSION", -"TYPE_SKI_TRAIL", -"TYPE_SKI_LIFT", -"TYPE_SKI_BOUNDARY", -"TYPE_WATERSHED_BOUNDARY", -"TYPE_TARMAC", -"TYPE_WALL", -"TYPE_PICNIC_AREA", -"TYPE_PLAY_GROUND", -"TYPE_TRAIL_HEAD", -"TYPE_GOLF_TEEING_GROUND", -"TYPE_GOLF_PUTTING_GREEN", -"TYPE_GOLF_ROUGH", -"TYPE_GOLF_SAND_BUNKER", -"TYPE_GOLF_FAIRWAY", -"TYPE_GOLF_HOLE", -"TYPE_DEPRECATED_GOLF_SHOP", -"TYPE_CAMPING_SITE", -"TYPE_DESIGNATED_BARBECUE_PIT", -"TYPE_DESIGNATED_COOKING_AREA", -"TYPE_CAMPFIRE_PIT", -"TYPE_WATER_FOUNTAIN", -"TYPE_LITTER_RECEPTACLE", -"TYPE_LOCKER_AREA", -"TYPE_ANIMAL_ENCLOSURE", -"TYPE_CARTOGRAPHIC_LINE", -"TYPE_ESTABLISHMENT", -"TYPE_ESTABLISHMENT_GROUNDS", -"TYPE_ESTABLISHMENT_BUILDING", -"TYPE_ESTABLISHMENT_POI", -"TYPE_ESTABLISHMENT_SERVICE", -"TYPE_CELESTIAL", -"TYPE_ROAD_MONITOR", -"TYPE_PUBLIC_SPACES_AND_MONUMENTS", -"TYPE_STATUE", -"TYPE_TOWN_SQUARE", -"TYPE_LEVEL", -"TYPE_COMPOUND", -"TYPE_COMPOUND_GROUNDS", -"TYPE_COMPOUND_BUILDING", -"TYPE_COMPOUND_SECTION", -"TYPE_TERMINAL_POINT", -"TYPE_REGULATED_AREA", -"TYPE_LOGICAL_BORDER", -"TYPE_GCONCEPT_ONLY", -"TYPE_DO_NOT_USE_RESERVED_TO_CATCH_GENERATED_FILES", -"TYPE_UNKNOWN" -], -"enumDeprecated": [ -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -false, -true, -true, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -true, -true, -true, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -true, -false, -false, -true, -true, -true, -true, -true, -true, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -true, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false -], -"enumDescriptions": [ -"ABSTRACT", -"ABSTRACT", -"A route is any section of road (or rails, etc.) that has a name. This includes city streets as well as highways. Road segments can belong to multiple routes (e.g. El Camino, CA-82).", -"DEPRECATED", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"A designated bicycle route, whose segments may consist of any combination of bicycle paths, bicycle lanes, or city streets.", -"A designated trail, which may consist of paved walkways, dirt paths, fire road, streets or highways, etc.", -"ABSTRACT", -"", -"Railroads use several different incompatible track types.", -"", -"", -"", -"", -"", -"", -"", -"", -"Tracks for streetcars, cable-cars, etc. Ferries are services that are part of the road network but are not roads. They typically involve fares and scheduled departure times.", -"ABSTRACT", -"The vast majority of ferries are ferry boats.", -"Also called a \"car transport\", a ferry train is a rail service that carries passengers and their vehicles across undrivable terrain. The Channel Tunnel (\"Chunnel\") is the most famous example, but they are also common in the Alps where they connect neighboring valleys otherwise separated by impassable mountains.", -"Any plausible 1-dimensional path through a 2+ dimensional space, for the purposes of making graph-search-based routing possible. Such segments can be used to model paths through parking lots, squares, floors of buildings and other areas.", -"An intersection consists of a collection of segments that terminate at the same location. This is topological definition: it may not match what a typical user would think of as an \"intersection\". See TYPE_INTERSECTION_GROUP, below, for more information. Each segment terminating at an intersection has an \"endpoint type\" that specifies how that segment is terminated: stop sign, yield sign, three-way light, etc.", -"ABSTRACT", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"A transit line is a collection of transit legs, associated with some invariant properties of the trips that run over the legs. See also transitline.proto", -"TYPE_TRANSIT_AGENCY was moved to 0xC91. This deprecated enum value still exists for debugging purposes only.", -"DEPRECATED", -"ABSTRACT", -"Road sign features have names, point geometry, etc. They also have segment_path data (see below) which lists the segments that refer to the sign. See segment.proto for the reference from the segment to the road sign.", -"Our TYPE_INTERSECTION feature, above, models the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an \"intersection\". Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. This TYPE_INTERSECTION_GROUP is used to model the user's concept of a complex intersection.", -"RESERVED", -"A restriction group describes a set of segment restrictions that belong together and have a name or an associated event. See also restriction_group.proto", -"DEPRECATED", -"ABSTRACT", -"", -"ABSTRACT", -"", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"", -"DEPRECATED", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"", -"e.g. Silicon Valley", -"A reservation is a region collectively held or governed by indigenous people and officially recognized by the country\u2019s government at the federal or state level. A reservation may be fully contained within an administrative feature or partially contained within two or more. These regions are referred to by different categorical names depending on country and even by state, including but not limited to: \u201cIndian Reservations\u201d, \u201cIndian Reserves\u201d, \u201cLand Claim Settlement Lands\u201d, \u201cIndian Lands\u201d, \u201cTreaty Lands\u201d, \u201cIndigenous Territories\u201d, etc. A reservation is not a historic indigenous territory boundary or a region which has applied for land rights but has not yet received official recognition.", -"", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"An entity widely considered to be a city, that may itself be made up of smaller political entities, some of which are cities/towns/villages themselves. For example, the colloquial view of Sydney, Australia actually comprises many smaller cities, but is regarded as a city itself. This type is not suitable for modeling official metro-/micropolitan or other statistical areas.", -"ABSTRACT", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"", -"Designated Market Areas (or DMAs) are used by marketing and ratings companies (such as the Nielsen Media Research company) to describe geographical regions (such as the greater New York metropolitan area) that are covered by a set of television stations. (See http://www.schooldata.com/pdfs/DMA.pdf) In the United States, DMAs should have a DMA numeric ID name, tagged with the FLAG_DESIGNATED_MARKET_AREA_ID flag.", -"", -"", -"Eventually we'll have more data for disputed areas (e.g., who makes claims on the area, who has de facto control, etc.). For the moment, we just define a type so we can simply mark areas as disputed.", -"Boundaries representing the jurisdiction of a particular police station.", -"An area used for aggregating statistical data, eg, a census region. Note that TYPE_STATISTICAL_AREA has a third nibble so we can add an abstract parent above it later if need be at 0x2E1 (and rename TYPE_STATISTICAL_AREA as TYPE_STATISTICAL_AREA1).", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"A line representing the boundary between two features. See border.proto for details.", -"DEPRECATED", -"An association of a point with an address, with no other information.", -"ABSTRACT", -"Expanses of land that share common surface attributes. These areas would look more or less uniform from a high altitude.", -"", -"", -"", -"", -"", -"", -"Terrain that looks populated.", -"Terrain that is covered in vegetation.", -"", -"", -"", -"", -"", -"", -"A flat expanse of salt left by the evaporation of a body of salt water.", -"Features can be TYPE_WATER if we don't have enough information to properly type the body of water. TYPE_WATER is also used as the type for child features that compose a TYPE_RIVER feature.", -"One of the large salt-water bodies that covers most of the globe.", -"An ocean subdivision formed by a coastal indentation. Includes coves and gulfs.", -"An open body of water formed by a slight coastal indentation.", -"", -"An ocean subdivision more or less confined by land and islands.", -"A long narrow ocean subdivision. Includes sounds.", -"", -"", -"An inland body of standing water.", -"A lake that dries up part of the year.", -"An artificial body of water, possibly created by a dam, often used for irrigation or house use.", -"", -"An inland body of moving water, or parts associated with it in which there is little or no current (backwater).", -"", -"A branch which flows away from the main river. Includes deltas.", -"A place where two or more rivers join.", -"", -"A place where ground water flows naturally out of the ground.", -"", -"", -"A river that dries up part of the year.", -"A dry riverbed that occasionally receives flashfloods.", -"A place at the end of a river where fresh and salt water mix. Includes tidal creeks and limans.", -"Land that is usually flooded. Includes bogs, marshes, flats, moors, and swamps.", -"", -"A shallow place where water may be waded through.", -"A narrow passage used by boats. Normally artificial.", -"A deep place near a shore where ships commonly drop anchor.", -"A deep part in a body of water that is suitable for navigation. Includes narrows.", -"Rocks, coral, sandbars, or other features beneath the surface of the water that pose a hazard to passing ships. Includes shoals.", -"A relatively shallow zone of the back reef located closest to the shore, that may be exposed at low tide.", -"A small section of rocks, coral, sandbars, or other features beneath the surface of the water that forms part of a reef.", -"The full extent of the reef complex.", -"A submerged rock in the water.", -"Man-made (and sometimes natural) channels used to move water. This type was used for both dam structures and water that is hold back by dams. We should use TYPE_COMPOUND_BUILDING for dam structures and TYPE_RESERVOIR for water.", -"DEPRECATED", -"", -"Includes overfalls.", -"A natural depression filled with water where animals come to drink.", -"This type is incorrectly under TYPE_TECTONIC instead of TYPE_WATER. This was a mistake and is now fixed. See TYPE_WATERING_HOLE for the replacement.", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"", -"", -"An exposed rock in the water.", -"A small, low-elevation, sandy island formed on the surface of coral reefs", -"A stretch of land projecting into water. Includes capes and spits.", -"A strip of land connecting two larger land masses, such as continents.", -"Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", -"Elevations that have a distinctive peak.", -"A peak or ridge of a mountain that extends through a glacier.", -"A subsidiary peak of a mountain.", -"A route over an otherwise difficult to traverse feature. Includes saddle.", -"Elevations that are flat on top. Includes mesas and buttes.", -"A ridge is a geographical feature consisting of a chain of mountains or hills that form a continuous elevated crest with a single ridgeline for some distance.", -"Steep declines usually carved by erosion. Includes valleys, canyons, ditches, and gorges.", -"Depressions causes by impact, explosion, and sometimes sink-holes.", -"Topography formed on limestone and gypsum by dissolution with sinkholes, caves, etc.", -"A vertical or nearly vertical slope. Includes escarpments.", -"An elevated place that is notable for having a good view. Raster digital elevation data. This is not a type to be used by providers or consumed by clients.", -"RESERVED", -"Land along streams higher than the alluvial plain or stream terrace.", -"", -"Land not so steep as a cliff, but changing elevation. Includes slides.", -"All the points on the polygon are at the same elevation.", -"A near-level shallow, natural depression or basin, usually containing an intermittent lake, pond, or pool.", -"", -"A series of mountains or hills ranged in a line and connected by high ground. Mountain ranges usually consist of many smaller ridges. For example, the Himalayas, the Andes. the Alps, etc.", -"Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", -"includes peaks, ranges, and spurs", -"", -"includes saddles", -"", -"", -"includes trenches and troughs", -"", -"", -"", -"", -"", -"Don't use 0xA7. Use 8 bits for additional types under TYPE_NATURAL_FEATURE, so we don't run out of space. The following are miscellaneous natural features that don't fit any of the categories above.", -"", -"A feature representing a group or chain of islands. ", -"ABSTRACT", -"This is the type for postal codes which are complete and independent enough that there should be a feature for them (e.g. US 5-digit ZIP codes). For even more detailed suffixes that further subdivide a postal code (such as the +4 component in US ZIP codes), store the information in a TYPE_POSTAL_CODE_SUFFIX address component. When a range or set of postal codes share the same geographical area, e.g. because a precise subdivision does not exist or this subdivision is unknown, this type is used for each individual postal code.", -"A prefix portion of a postal code which does not meet the requirements for TYPE_POSTAL_CODE, but which is useful to search for, for example UK outcodes.", -"DEPRECATED", -"DEPRECATED This is deprecated and we want to use TYPE_COMPOUND_SECTION instead.", -"DEPRECATED", -"The term \"post town\" is used for a locality-like-entity that is only used for postal addresses.", -"DEPRECATED", -"ABSTRACT", -"Every data source used in constructing a data repository has a corresponding feature that provides more information about that data source. The extra information is stored in the optional data_source field below.", -"A locale feature provides region specific conventions such as preferred language and formatting details for time, date, and currency values. Locales aren't necessary defined by physical geographic features, so they are classified as meta-features.", -"A timezone feature is used to specify the region covering an international timezone. When a point is covered by multiple timezone features, the most specific one can be used to compute the local time at this point. Most specific implies a much smaller region or the one that is closer to the center. A feature's timezone can be specified in the repeated related_timezone field.", -"A business chain feature is used to represent a chain, e.g. Starbucks, McDonald's, etc. Other features representing specific stores/franchises of this chain may refer to one such feature via RELATION_MEMBER_OF_CHAIN. This is not strictly reserved to commercial chains but can also be used to model organizations such as the Red Cross or the United Nations.", -"A phone number prefix feature is used to specify the region where phone numbers (typically fixed-line numbers) must begin with a certain prefix. Any phone number prefix down to any level of granularity could be represented by this type.", -"A phone number area code is a prefix which also coincides with the area code, or national destination code, of a particular region.", -"A Business Corridor is a dense cluster of semantically similar establishments. TYPE_BUSINESS_CORRIDOR features are distinguished from TYPE_COLLOQUIAL_AREA features because the corridors are not under the political hierarchy, are allowed to be nameless, and may not correspond to well-known real world locations. For more details, see go/geo-corridors-schema.", -"An address template feature provides region-specific conventions for structuring addresses. These features aren't necessarily defined by physical geographic features, so they are classified as meta-features.", -"A transit agency operates a number of lines, typically all in the same city, region or country. See also transitagency.proto", -"A feature whose geometry is planned to replace the geometry on another feature.", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"RESERVED", -"A portal of entry or exit to another feature. Examples: - Subway station entrance. - Parking lot entrance.", -"Cartographic features are used to capture real-world objects for which there is no current desire to model any specific attributes. These are only useful to make the map tiles look pretty.", -"DEPRECATED", -"Also see skitrail.proto", -"Also see skilift.proto", -"Also see skiboundary.proto", -"", -"Starting with TYPE_TARMAC, we use longer IDs, so that we can expand the number of feature types under TYPE_CARTOGRAPHIC.", -"Use TYPE_COMPOUND_GROUND and appropriate gcids for the next two.", -"DEPRECATED", -"DEPRECATED", -"", -"Sub-types within a golf course.", -"", -"", -"", -"", -"Use TYPE_ESTABLISHMENT_POI and gcid:golf_shop for golf shops instead.", -"DEPRECATED", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"Subtype within a zoo - a cage or fenced-off or otherwise delineated area containing animals.", -"A line for a cartographic detail. For example the international date line. Such features should have polyline geometry.", -"ABSTRACT This type is being replaced by TYPE_COMPOUND_GROUNDS. For further details, see go/compounds-v2", -"DEPRECATED This type has been replaced by TYPE_COMPOUND_BUILDING. For further details, see go/oyster-compounds", -"DEPRECATED", -"An establishment that has a physical location. Note that it *may* also have a service area (e.g. a restaurant that offers both dine-in and delivery). This type of business is also known as a \"hybrid\" Service Area Business. Establishment POIs can be referenced by TYPE_COMPOUND features using the RELATION_PRIMARILY_OCCUPIED_BY. This is the reciprocal relation of the RELATION_OCCUPIES.", -"NOTE(tcain): Using value 0xD441, since we could find ourselves with a need to differentiate service areas from online-only at this level in the future, but still benefit from being able to group those under a common parent, disjoint from TYPE_ESTABLISHMENT_POI.", -"The root of types of features that are in the sky, rather than on the earth. There will eventually be a hierarchy of types here.", -"Features responsible for monitoring traffic on roads (usually for speed). Includes cameras at particular points as well as monitors that cover larger spans. Features of this type should have a corresponding gcid that specifies the correct subtype (e.g. gcid:road_camera or gcid:speed_camera_zone). This type was originally named as TYPE_ROAD_CAMERA.", -"ABSTRACT", -"Note that this type does not distinguish the nature of the statue (religious, historical, memorial, tourist, ...).", -"Open space used for events, gathering, or as market-place.", -"A feature used to represent a logical level, e.g. floor.", -"ABSTRACT", -"e.g. campus, compound, parcel.", -"e.g. single family dwelling, office building.", -"e.g. suite, room, hallway, cubicle.", -"A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", -"An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone or an area under government sanctions. Features of this type should have one or more gcids corresponding to their specific regulation, and client handling of these features may vary based on the type of regulation.", -"A grouping of TYPE_BORDER features (\"border segments\"), which together represent a border between two features of the same type.", -"A generic feature type for any geo-type that cannot be modeled under existing feature types. No new feature type should be created within feature proto after this type.", -"DEPRECATED", -"A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." -], -"type": "string" -} -}, -"type": "object" -}, -"LocationExtractorLocationFeatureletBoundingBox": { -"description": "Defines the bounding box for the area. The values specify a rectangle defined from low to high. Latitude and longitude (in degrees) x 10,000,000. We use sfixed32 (fixed size int32) because they get transmitted using 4 bytes while int32 gets transmitted using 10 bytes. This is currently not populated by LES. Oolong will parse the LES response for IP addreses and combine multiple locations into a single location with multiple featurelets. This will be populated by Oolong by looking into bounding boxes from each location.", -"id": "LocationExtractorLocationFeatureletBoundingBox", -"properties": { -"highLatitudeE7": { -"format": "int32", -"type": "integer" -}, -"highLongitudeE7": { -"format": "int32", -"type": "integer" -}, -"lowLatitudeE7": { -"format": "int32", -"type": "integer" -}, -"lowLongitudeE7": { -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"LocationExtractorLocationFeatureletCenter": { -"description": "Latitude and longitude of the feature center (in degrees) x 10,000,000", -"id": "LocationExtractorLocationFeatureletCenter", -"properties": { -"latitudeE7": { -"format": "int32", -"type": "integer" -}, -"longitudeE7": { -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"LocationUnifiedActivityRecord": { -"description": "Represents a detected activity record. Next id 3.", -"id": "LocationUnifiedActivityRecord", -"properties": { -"confidence": { -"description": "The confidence of the detection. Range is [0, 100].", -"format": "int32", -"type": "integer" -}, -"type": { -"description": "The type of activity.", -"enum": [ -"IN_VEHICLE", -"ON_BICYCLE", -"ON_FOOT", -"STILL", -"UNKNOWN", -"TILTING", -"EXITING_VEHICLE", -"WALKING", -"RUNNING", -"OFF_BODY", -"TRUSTED_GAIT", -"FLOOR_CHANGE", -"ON_STAIRS", -"ON_ESCALATOR", -"IN_ELEVATOR", -"SLEEPING", -"IN_ROAD_VEHICLE", -"IN_RAIL_VEHICLE", -"IN_TWO_WHEELER_VEHICLE", -"IN_FOUR_WHEELER_VEHICLE", -"IN_CAR", -"IN_BUS", -"EXPERIMENTAL_EXTRA_PERSONAL_VEHICLE" -], -"enumDescriptions": [ -"LINT.IfChange", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"This is to support EXPERIMENTAL_EXTRA_PERSONAL_VEHICLE until Activity Recognition team figures out their API. LINT.ThenChange( //depot/google3/java/com/google/geo/sidekick/proto/detected_activity.proto, //depot/google3/personalization/context/proto/detected_activity/detected_activity.proto )" -], -"type": "string" -} -}, -"type": "object" -}, -"LocationUnifiedAnnotationSet": { -"description": "A set of annotations (e.g., those applied by some particular policy). Next tag: 6", -"id": "LocationUnifiedAnnotationSet", -"properties": { -"annotations": { -"description": "The annotations that have been applied by some policy.", -"items": { -"$ref": "LocationUnifiedLocationAnnotation" -}, -"type": "array" -}, -"clientId": { -"description": "If set then this set of annotations are originating from this client id for production use.", -"enum": [ -"CLIENT_UNKNOWN", -"CLIENT_CURIO", -"CLIENT_ONE_GOOGLE_SERVICE", -"CLIENT_EVALS", -"CLIENT_EVALS_ONESHOT", -"CLIENT_EVALS_UQS", -"CLIENT_BOOKS", -"CLIENT_BOND", -"CLIENT_CHROME_UMA", -"CLIENT_DOUBLECLICK_SEARCH", -"CLIENT_YOUTUBE_ISP_RATING", -"CLIENT_YOUTUBE_REAL_TIME_QOE", -"CLIENT_YOUTUBE_QOE_LIVYATAN", -"CLIENT_YOUTUBE", -"CLIENT_YOUTUBE_SHORTS_DESKTOP_GAIA", -"CLIENT_YOUTUBE_SHORTS_DESKTOP_ZWIEBACK", -"CLIENT_YOUTUBE_SHORTS_MOBILE_GAIA", -"CLIENT_YOUTUBE_SHORTS_MOBILE_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA", -"CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_LES", -"CLIENT_YOUTUBE_VIRAL_EXP_DESKTOP_GAIA", -"CLIENT_YOUTUBE_VIRAL_EXP_DESKTOP_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_EXP_MOBILE_GAIA", -"CLIENT_YOUTUBE_VIRAL_EXP_MOBILE_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_AXOLOTL", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_AXOLOTL", -"CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_AXOLOTL", -"CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_AXOLOTL", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_BADGER", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_BADGER", -"CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_BADGER", -"CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_BADGER", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_CHIPMUNK", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_CHIPMUNK", -"CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_CHIPMUNK", -"CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_CHIPMUNK", -"CLIENT_YOUTUBE_ADMIN_YURT", -"CLIENT_YOUTUBE_BAD_HARVEST", -"CLIENT_SPEECH", -"CLIENT_GMAIL", -"CLIENT_GMAIL_SPAM", -"CLIENT_CHROMECAST_WEB", -"CLIENT_PANCETTA", -"CLIENT_GOOGLE_LOCATION_SERVER", -"CLIENT_GOOGLE_FEEDBACK", -"CLIENT_ANDROID_METRICS_WAREHOUSE", -"CLIENT_USERMGMT", -"CLIENT_APPREMOTING", -"CLIENT_GAIA_PERMISSION_SERVER", -"CLIENT_ACTIONABLE_IPS", -"CLIENT_DISPLAY_ADS", -"CLIENT_DISPLAY_ADS_DEFAULT", -"CLIENT_DISPLAY_ADS_DESKTOP_GAIA", -"CLIENT_DISPLAY_ADS_DESKTOP_ZWIEBACK", -"CLIENT_DISPLAY_ADS_MOBILE_GAIA", -"CLIENT_DISPLAY_ADS_MOBILE_ZWIEBACK", -"CLIENT_DISPLAY_ADS_PREVIEW", -"CLIENT_HOBBES", -"CLIENT_NEWSSTAND", -"CLIENT_NEWSSTAND_EXPERIMENTAL", -"CLIENT_POLYNEWS", -"CLIENT_DOCS", -"CLIENT_ADWORDS_EXPRESS", -"CLIENT_TRACE_DEPOT", -"CLIENT_MAPSPRO", -"CLIENT_GEO_ONDEMAND", -"CLIENT_ACCESS_FILTER", -"CLIENT_DOMAIN_REGISTRAR", -"CLIENT_ASSISTANT", -"CLIENT_ASSISTANT_FRONTEND", -"CLIENT_ACCOUNT_LINKING", -"CLIENT_LEGAL_REMOVALS", -"CLIENT_CLOUD_CONSOLE", -"CLIENT_CLOUD_FREE_TRIAL", -"CLIENT_CLOUD_SOLUTIONS_CATALOG", -"CLIENT_CLOUD_MEDIA_ACCESS", -"CLIENT_DOTORG_G4NP", -"CLIENT_CRASH_INTERNAL", -"CLIENT_GOOGLE_WIFI_MONLOG", -"CLIENT_GOOGLE_VOICE", -"CLIENT_BLOGGER", -"CLIENT_THOR_BACKEND", -"CLIENT_NEWS", -"CLIENT_GOOGLE_PHOTOS", -"CLIENT_GOOGLE_PHOTOS_INFERRED_LOCATION", -"CLIENT_RANKBRAIN_DEBUG", -"CLIENT_HETERODYNE", -"CLIENT_FRAUDREVIEW", -"CLIENT_JAMBOARD", -"CLIENT_MARCONI", -"CLIENT_AART", -"CLIENT_CULTURAL", -"CLIENT_YOUTUBE_ECOMMERCE", -"CLIENT_ARES", -"CLIENT_LIS", -"CLIENT_STORE", -"CLIENT_DASHER_AUDITING", -"CLIENT_SHOPPING_LIST", -"CLIENT_ITEM_SUGGEST", -"CLIENT_SMART_BOOKS", -"CLIENT_GRADS", -"CLIENT_ADS_ROOT", -"CLIENT_SE_ROOT", -"CLIENT_YT_ORBIT", -"CLIENT_NOVA_APERTURE", -"CLIENT_LENA_SIGNUP_DEFAULTS", -"CLIENT_PLAY_APPS_PUBLISHER", -"CLIENT_FINSKY_ENTERPRISE", -"CLIENT_GOOGLE_ADMIN", -"CLIENT_CRYPTAUTH", -"CLIENT_GSA_UNIVERSAL_SERVER", -"CLIENT_TRAVEL_FRONTEND_TRANSIT", -"CLIENT_HOME_CLOUD", -"CLIENT_GSX_MALL", -"CLIENT_GOOGLE_DUO", -"CLIENT_GAIA_FRONTEND", -"CLIENT_ANDROID_MESSAGES", -"CLIENT_GOOGLE_LENS", -"CLIENT_CHROME_WEB_STORE", -"CLIENT_ACTIONS_ON_GOOGLE_CONSOLE", -"CLIENT_ANDROID_TV_CHANNELS", -"CLIENT_ASSISTANT_WEB_SETTINGS", -"CLIENT_PLAY_USER_DATA", -"CLIENT_ADS_INTEGRITY", -"CLIENT_ADS_INTEGRITY_MALVERTISING", -"CLIENT_FIREBASE_CONSOLE", -"CLIENT_AOG_FEED_VALIDATOR", -"CLIENT_PLUMERIA", -"CLIENT_PAISA", -"CLIENT_GOOGLE_PAY", -"CLIENT_GOOGLE_PAY_WEB", -"CLIENT_GOOGLE_WALLET", -"CLIENT_SCROOGLED", -"CLIENT_WAYMO", -"CLIENT_CROW", -"CLIENT_GSUITE_SECURITY_CENTER_SIT", -"CLIENT_EVENT_THREAT_DETECTION", -"CLIENT_PLAY_LOCATION", -"CLIENT_FOOTPLACER", -"CLIENT_DASHER_COMMERCE", -"CLIENT_SOCIAL_PEOPLE_ANALYTICS", -"CLIENT_CONTACTS_UI", -"CLIENT_GAFE4", -"CLIENT_PLACES_API", -"CLIENT_PLACES_SEARCH_API", -"CLIENT_DRIVE_WEB", -"CLIENT_ANDROID_OTA", -"CLIENT_PAISA_NEARBY_STORES", -"CLIENT_ISP_FIBER_FAS", -"CLIENT_SUPPORT_CONTENT", -"CLIENT_GWS_OFFROAD_LOGGING", -"CLIENT_CHANGEHISTORY", -"CLIENT_SESSION_RISK", -"CLIENT_ALPS", -"CLIENT_DISCOVER_NEWS_LOCATION", -"CLIENT_ASSISTANT_SNAPSHOT", -"CLIENT_HONEYCOMB", -"CLIENT_PLAY_MONETARY_ABUSE", -"CLIENT_SMALL_BUSINESS_ADVISORS", -"CLIENT_GPA_FEEDS", -"CLIENT_EDU_ORIGINALITY", -"CLIENT_PAIDTASKS", -"CLIENT_TRANSLATE", -"CLIENT_FUNDING_CHOICES", -"CLIENT_SEARCH_NOTIFICATIONS", -"CLIENT_VISUAL_SEMANTIC_SERVICE", -"CLIENT_CHROME_PREFETCH_PROXY", -"CLIENT_WEAR_FRONTEND", -"CLIENT_PAYMENTS_RISKENGINE", -"CLIENT_PAYMENTS_ORCHESTRATION", -"CLIENT_ANDROID_TV_IRDB", -"CLIENT_TRENDS_FRONTEND", -"CLIENT_COLABORATORY", -"CLIENT_SOCRATIC", -"CLIENT_PS1_LOCATION", -"CLIENT_DDM_REPORTING", -"CLIENT_HOMEROOM_BACKEND", -"CLIENT_CARS_CATEGORICAL", -"CLIENT_GPAY_MERCHANT_VERTICALS", -"CLIENT_RECAPTCHA_ACCOUNT_DEFENDER", -"CLIENT_RECAPTCHA_LITE", -"CLIENT_RECAPTCHA_FRAUD", -"CLIENT_AUTONT_ACCESS_LOCATION", -"CLIENT_TFAA_REPORT", -"CLIENT_IDAAS_IP_LOCATION", -"CLIENT_ONESTACK_METRIC_COLLECTION", -"CLIENT_GPAY_TRANSIT", -"CLIENT_CHRONICLE_SECURITY", -"CLIENT_CHRONICLE_SECURITY_UI", -"CLIENT_GPAY_MERCHANT_SPOT_ONBOARDING_TOOL", -"CLIENT_ADS_SCRAPING", -"CLIENT_CLOUD_SUPPORT_PORTAL", -"CLIENT_LAMDA", -"CLIENT_PINPOINT", -"CLIENT_SHOPPING_ORDER_HISTORY", -"CLIENT_NEST_CAMERA_CLOUD", -"CLIENT_PANOPTIC_EVAL", -"CLIENT_ABOUT_THIS_PAGE", -"CLIENT_PHOTOS_ANALYTICS_MARKETING", -"CLIENT_GMSCORE_GMSCOMPLIANCE", -"CLIENT_ANALYTICS_COLLECTION", -"CLIENT_PLAY_CONSOLE_ANDROID_VITALS", -"CLIENT_CRASHLYTICS_PLAY_CONSOLE_CRASHES", -"CLIENT_PAYMENTS_MERCHANT_STORIES", -"CLIENT_CLOUDTOP_CONNECTIVITY", -"CLIENT_CLOUD_WEB", -"CLIENT_RECORDING_CONSENT", -"CLIENT_DV3_FRONTEND", -"CLIENT_LENDING_DATA_MANAGER", -"CLIENT_CHROMEOS_DATA_FRESNEL", -"CLIENT_PPN", -"CLIENT_GEO_SEARCH_API", -"CLIENT_GOOGLE_ONE_SECURITY", -"CLIENT_GOOGLE_TV_LAVA", -"CLIENT_DYNAMITE_SERVER", -"CLIENT_BCE_CLIENT_CONNECTOR", -"CLIENT_DSE_REGULATORY_ANALYSIS", -"CLIENT_SEARCH_PINPOINT", -"CLIENT_CORPLOGIN", -"CLIENT_MONOSPACE", -"CLIENT_LIGHTER", -"CLIENT_P11", -"CLIENT_FIND_MY_DEVICE_WEB", -"CLIENT_YOUTUBE_TV", -"CLIENT_FITBIT_WEB", -"CLIENT_CHORD", -"CLIENT_FITBIT_FI", -"CLIENT_GOOGLE_ANALYTICS_SERVING", -"CLIENT_FONTS", -"CLIENT_ASSISTANT_BARD", -"CLIENT_NEST_GREENENERGY", -"CLIENT_DEEPMIND_LABS", -"CLIENT_ONE_PRESENCE", -"CLIENT_TRANSPARENCY_REPORT", -"CLIENT_GOOGLE_ONE_ML", -"CLIENT_GMP_PARTNER_GALLERY", -"CLIENT_MAKERSUITE", -"CLIENT_ADS_ADMANAGER_TOS", -"CLIENT_CHROME_REMOTE_DESKTOP", -"CLIENT_SOJI", -"CLIENT_WORKSPACE_LABS_SIGNUP", -"CLIENT_AIDA", -"CLIENT_TSP", -"CLIENT_AI_SANDBOX", -"CLIENT_LABS_TAILWIND", -"CLIENT_GMAIL_TASK_ASSIST", -"CLIENT_PIXEL_WEATHER", -"CLIENT_GPAY_CATEGORY_BILLERS", -"CLIENT_SUPPORT_CHANNELS_ZENDESK_WHATSAPP", -"CLIENT_PAYMENTS_TRANSACTION_MONITORING", -"CLIENT_DISCOVER_QUERY_RECOMMENDATIONS", -"CLIENT_COMMUNICATION_PREFERENCE_CENTER", -"CLIENT_PLAY_CONSOLE_DEVELOPER_IDENTITY_AND_ACCOUNTS", -"CLIENT_GNP_ONLINE_EVALUATION", -"CLIENT_LOCAL_SUGGESTED_SETS_DEMO_SERVER", -"CLIENT_SEARCH_LABS", -"CLIENT_CROWDSOURCE", -"CLIENT_TARSIER", -"CLIENT_WORKSPACE_SIDEKICK", -"CLIENT_GOOGLE_PHOTOS_REMINISCING", -"CLIENT_GEOX_CONTAMINATION", -"CLIENT_CLOUD_MESSAGE_STORE", -"CLIENT_IP_PROTECTION", -"CLIENT_SEARCH_HAMSA", -"CLIENT_ACCOUNT_LOCATION", -"CLIENT_ANDROID_BACKUP_AND_RESTORE", -"CLIENT_ADS_AWSM", -"CLIENT_STARGATE", -"CLIENT_ACCOUNT_MANAGEMENT", -"CLIENT_USER_ACCOUNT_CREATION", -"CLIENT_NETSENSE", -"CLIENT_FITBIT_LABS", -"CLIENT_LOCAL_SERVICES", -"CLIENT_USER_FEEDBACK_SERVICE", -"CLIENT_BARD_EVAL", -"CLIENT_SCENARIO_BASED_SEEDING_HOME_WORK", -"CLIENT_ACCOUNT_INTEGRITY_FEATURE_API", -"CLIENT_LABS_BETTANY", -"CLIENT_NECO_GENESIS", -"CLIENT_FITBIT_CAPABILITIES", -"CLIENT_ADS_MARKETING_AUTOMATION", -"CLIENT_ANDROID_TELEMETRY_WESTWORLD", -"CLIENT_DSPM_DETECTIVE_CONTROLS", -"CLIENT_CAA_INSIGHTS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK", -"CLIENT_GWS_TLD_MOBILE_GAIA", -"CLIENT_GWS_TLD_DESKTOP_GAIA", -"CLIENT_GWS_TLD_NON_PERSONALIZED", -"CLIENT_GWS_HOMEPAGE", -"CLIENT_ADS_DESKTOP_ZWIEBACK", -"CLIENT_ADS_DESKTOP_GAIA", -"CLIENT_ADS_MOBILE_ZWIEBACK", -"CLIENT_ADS_MOBILE_GAIA", -"CLIENT_ADS_NON_PERSONALIZED", -"CLIENT_ADS_TLD_NON_PERSONALIZED", -"CLIENT_ADS_EOM", -"CLIENT_ADS_TLD_EOM", -"CLIENT_ADS_ADMANAGER_SIGNUP", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK", -"CLIENT_GWS_NONTLD_MOBILE_GAIA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_EXP", -"CLIENT_GWS_TLD_DESKTOP_GAIA_EXP", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_EXP", -"CLIENT_GWS_TLD_MOBILE_GAIA_EXP", -"CLIENT_ADS_DESKTOP_ZWIEBACK_EXP", -"CLIENT_ADS_DESKTOP_GAIA_EXP", -"CLIENT_ADS_MOBILE_ZWIEBACK_EXP", -"CLIENT_ADS_MOBILE_GAIA_EXP", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_EXP", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_EXP", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_EXP", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_EXP", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_EXP", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_EXP", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_EXP", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_EXP", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ANDROMEDA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ANDROMEDA", -"CLIENT_GWS_TLD_MOBILE_GAIA_ANDROMEDA", -"CLIENT_GWS_TLD_DESKTOP_GAIA_ANDROMEDA", -"CLIENT_ADS_DESKTOP_ZWIEBACK_ANDROMEDA", -"CLIENT_ADS_MOBILE_ZWIEBACK_ANDROMEDA", -"CLIENT_ADS_DESKTOP_GAIA_ANDROMEDA", -"CLIENT_ADS_MOBILE_GAIA_ANDROMEDA", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ANDROMEDA", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_ANDROMEDA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ANDROMEDA", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_ANDROMEDA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ANDROMEDA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ANDROMEDA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ANDROMEDA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ANDROMEDA", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_BOOTES", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_BOOTES", -"CLIENT_GWS_TLD_MOBILE_GAIA_BOOTES", -"CLIENT_GWS_TLD_DESKTOP_GAIA_BOOTES", -"CLIENT_ADS_DESKTOP_ZWIEBACK_BOOTES", -"CLIENT_ADS_MOBILE_ZWIEBACK_BOOTES", -"CLIENT_ADS_DESKTOP_GAIA_BOOTES", -"CLIENT_ADS_MOBILE_GAIA_BOOTES", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_BOOTES", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_BOOTES", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_BOOTES", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_BOOTES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_BOOTES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_BOOTES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_BOOTES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_BOOTES", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_CASSIOPEIA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_CASSIOPEIA", -"CLIENT_GWS_TLD_MOBILE_GAIA_CASSIOPEIA", -"CLIENT_GWS_TLD_DESKTOP_GAIA_CASSIOPEIA", -"CLIENT_ADS_DESKTOP_ZWIEBACK_CASSIOPEIA", -"CLIENT_ADS_MOBILE_ZWIEBACK_CASSIOPEIA", -"CLIENT_ADS_DESKTOP_GAIA_CASSIOPEIA", -"CLIENT_ADS_MOBILE_GAIA_CASSIOPEIA", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_CASSIOPEIA", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_CASSIOPEIA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_CASSIOPEIA", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_CASSIOPEIA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_CASSIOPEIA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_CASSIOPEIA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_CASSIOPEIA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_CASSIOPEIA", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_DELPHINUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_DELPHINUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_DELPHINUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_DELPHINUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_DELPHINUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_DELPHINUS", -"CLIENT_ADS_DESKTOP_GAIA_DELPHINUS", -"CLIENT_ADS_MOBILE_GAIA_DELPHINUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_DELPHINUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_DELPHINUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_DELPHINUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_DELPHINUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_DELPHINUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_DELPHINUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_DELPHINUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_DELPHINUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ERIDANUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ERIDANUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_ERIDANUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_ERIDANUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_ERIDANUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_ERIDANUS", -"CLIENT_ADS_DESKTOP_GAIA_ERIDANUS", -"CLIENT_ADS_MOBILE_GAIA_ERIDANUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ERIDANUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_ERIDANUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ERIDANUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_ERIDANUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ERIDANUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ERIDANUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ERIDANUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ERIDANUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_FOMAX", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_FOMAX", -"CLIENT_GWS_TLD_MOBILE_GAIA_FOMAX", -"CLIENT_GWS_TLD_DESKTOP_GAIA_FOMAX", -"CLIENT_ADS_DESKTOP_ZWIEBACK_FOMAX", -"CLIENT_ADS_MOBILE_ZWIEBACK_FOMAX", -"CLIENT_ADS_DESKTOP_GAIA_FOMAX", -"CLIENT_ADS_MOBILE_GAIA_FOMAX", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_FOMAX", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_FOMAX", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_FOMAX", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_FOMAX", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_FOMAX", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_FOMAX", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_FOMAX", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_FOMAX", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_GEMINI", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_GEMINI", -"CLIENT_GWS_TLD_MOBILE_GAIA_GEMINI", -"CLIENT_GWS_TLD_DESKTOP_GAIA_GEMINI", -"CLIENT_ADS_DESKTOP_ZWIEBACK_GEMINI", -"CLIENT_ADS_MOBILE_ZWIEBACK_GEMINI", -"CLIENT_ADS_DESKTOP_GAIA_GEMINI", -"CLIENT_ADS_MOBILE_GAIA_GEMINI", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_GEMINI", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_GEMINI", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_GEMINI", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_GEMINI", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_GEMINI", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_GEMINI", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_GEMINI", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_GEMINI", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_HERCULES", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_HERCULES", -"CLIENT_GWS_TLD_MOBILE_GAIA_HERCULES", -"CLIENT_GWS_TLD_DESKTOP_GAIA_HERCULES", -"CLIENT_ADS_DESKTOP_ZWIEBACK_HERCULES", -"CLIENT_ADS_MOBILE_ZWIEBACK_HERCULES", -"CLIENT_ADS_DESKTOP_GAIA_HERCULES", -"CLIENT_ADS_MOBILE_GAIA_HERCULES", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_HERCULES", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_HERCULES", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_HERCULES", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_HERCULES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_HERCULES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_HERCULES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_HERCULES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_HERCULES", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_INDUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_INDUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_INDUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_INDUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_INDUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_INDUS", -"CLIENT_ADS_DESKTOP_GAIA_INDUS", -"CLIENT_ADS_MOBILE_GAIA_INDUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_INDUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_INDUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_INDUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_INDUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_INDUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_INDUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_INDUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_INDUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_LEO", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_LEO", -"CLIENT_GWS_TLD_MOBILE_GAIA_LEO", -"CLIENT_GWS_TLD_DESKTOP_GAIA_LEO", -"CLIENT_ADS_DESKTOP_ZWIEBACK_LEO", -"CLIENT_ADS_MOBILE_ZWIEBACK_LEO", -"CLIENT_ADS_DESKTOP_GAIA_LEO", -"CLIENT_ADS_MOBILE_GAIA_LEO", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_LEO", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_LEO", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_LEO", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_LEO", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_LEO", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_LEO", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_LEO", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_LEO", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_MENSA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_MENSA", -"CLIENT_GWS_TLD_MOBILE_GAIA_MENSA", -"CLIENT_GWS_TLD_DESKTOP_GAIA_MENSA", -"CLIENT_ADS_DESKTOP_ZWIEBACK_MENSA", -"CLIENT_ADS_MOBILE_ZWIEBACK_MENSA", -"CLIENT_ADS_DESKTOP_GAIA_MENSA", -"CLIENT_ADS_MOBILE_GAIA_MENSA", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_MENSA", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_MENSA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_MENSA", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_MENSA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_MENSA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_MENSA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_MENSA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_MENSA", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_NORMA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_NORMA", -"CLIENT_GWS_TLD_MOBILE_GAIA_NORMA", -"CLIENT_GWS_TLD_DESKTOP_GAIA_NORMA", -"CLIENT_ADS_DESKTOP_ZWIEBACK_NORMA", -"CLIENT_ADS_MOBILE_ZWIEBACK_NORMA", -"CLIENT_ADS_DESKTOP_GAIA_NORMA", -"CLIENT_ADS_MOBILE_GAIA_NORMA", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_NORMA", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_NORMA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_NORMA", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_NORMA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_NORMA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_NORMA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_NORMA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_NORMA", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ORION", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ORION", -"CLIENT_GWS_TLD_MOBILE_GAIA_ORION", -"CLIENT_GWS_TLD_DESKTOP_GAIA_ORION", -"CLIENT_ADS_DESKTOP_ZWIEBACK_ORION", -"CLIENT_ADS_MOBILE_ZWIEBACK_ORION", -"CLIENT_ADS_DESKTOP_GAIA_ORION", -"CLIENT_ADS_MOBILE_GAIA_ORION", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ORION", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_ORION", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ORION", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_ORION", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ORION", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ORION", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ORION", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ORION", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_PISCES", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_PISCES", -"CLIENT_GWS_TLD_MOBILE_GAIA_PISCES", -"CLIENT_GWS_TLD_DESKTOP_GAIA_PISCES", -"CLIENT_ADS_DESKTOP_ZWIEBACK_PISCES", -"CLIENT_ADS_MOBILE_ZWIEBACK_PISCES", -"CLIENT_ADS_DESKTOP_GAIA_PISCES", -"CLIENT_ADS_MOBILE_GAIA_PISCES", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_PISCES", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_PISCES", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_PISCES", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_PISCES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_PISCES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_PISCES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_PISCES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_PISCES", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_RETICULUM", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_RETICULUM", -"CLIENT_GWS_TLD_MOBILE_GAIA_RETICULUM", -"CLIENT_GWS_TLD_DESKTOP_GAIA_RETICULUM", -"CLIENT_ADS_DESKTOP_ZWIEBACK_RETICULUM", -"CLIENT_ADS_MOBILE_ZWIEBACK_RETICULUM", -"CLIENT_ADS_DESKTOP_GAIA_RETICULUM", -"CLIENT_ADS_MOBILE_GAIA_RETICULUM", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_RETICULUM", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_RETICULUM", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_RETICULUM", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_RETICULUM", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_RETICULUM", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_RETICULUM", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_RETICULUM", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_RETICULUM", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_SAGITTARIUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_SAGITTARIUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_SAGITTARIUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_SAGITTARIUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_SAGITTARIUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_SAGITTARIUS", -"CLIENT_ADS_DESKTOP_GAIA_SAGITTARIUS", -"CLIENT_ADS_MOBILE_GAIA_SAGITTARIUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_SAGITTARIUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_SAGITTARIUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_SAGITTARIUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_SAGITTARIUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_SAGITTARIUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_SAGITTARIUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_SAGITTARIUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_SAGITTARIUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_TAURUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_TAURUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_TAURUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_TAURUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_TAURUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_TAURUS", -"CLIENT_ADS_DESKTOP_GAIA_TAURUS", -"CLIENT_ADS_MOBILE_GAIA_TAURUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_TAURUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_TAURUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_TAURUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_TAURUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_TAURUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_TAURUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_TAURUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_TAURUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_URSA_MAJOR", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_URSA_MAJOR", -"CLIENT_GWS_TLD_MOBILE_GAIA_URSA_MAJOR", -"CLIENT_GWS_TLD_DESKTOP_GAIA_URSA_MAJOR", -"CLIENT_ADS_DESKTOP_ZWIEBACK_URSA_MAJOR", -"CLIENT_ADS_MOBILE_ZWIEBACK_URSA_MAJOR", -"CLIENT_ADS_DESKTOP_GAIA_URSA_MAJOR", -"CLIENT_ADS_MOBILE_GAIA_URSA_MAJOR", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_URSA_MAJOR", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_URSA_MAJOR", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_URSA_MAJOR", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_URSA_MAJOR", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_URSA_MAJOR", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_URSA_MAJOR", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_URSA_MAJOR", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_URSA_MAJOR", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_VIRGO", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_VIRGO", -"CLIENT_GWS_TLD_MOBILE_GAIA_VIRGO", -"CLIENT_GWS_TLD_DESKTOP_GAIA_VIRGO", -"CLIENT_ADS_DESKTOP_ZWIEBACK_VIRGO", -"CLIENT_ADS_MOBILE_ZWIEBACK_VIRGO", -"CLIENT_ADS_DESKTOP_GAIA_VIRGO", -"CLIENT_ADS_MOBILE_GAIA_VIRGO", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_VIRGO", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_VIRGO", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_VIRGO", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_VIRGO", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_VIRGO", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_VIRGO", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_VIRGO", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_VIRGO", -"CLIENT_LOGGED_CONTEXT", -"CLIENT_IPGEO_REGION", -"CLIENT_IPGEO_EVAL", -"CLIENT_GWS_TACTILE_INITIAL_VIEWPORT", -"CLIENT_GWS_MAPS_DESKTOP", -"CLIENT_GWS_MAPS_MOBILE", -"CLIENT_GWS_GMM_LOCATION_SHIFT", -"CLIENT_GWS_NONTLD_MAPS_DESKTOP_GAIA", -"CLIENT_GWS_NONTLD_MAPS_DESKTOP_ZWIEBACK", -"CLIENT_GWS_TLD_MAPS_DESKTOP_GAIA", -"CLIENT_GWS_TLD_MAPS_DESKTOP_ZWIEBACK", -"CLIENT_GWS_TLD_MAPS_MOBILE_GAIA", -"CLIENT_GWS_TLD_MAPS_MOBILE_ZWIEBACK", -"CLIENT_GWS_NONTLD_MAPS_DESKTOP_EXPERIMENTAL", -"CLIENT_GWS_NONTLD_MAPS_MOBILE_EXPERIMENTAL", -"CLIENT_SESSIONS", -"CLIENT_MANUAL", -"CLIENT_NONTLD_DEFAULT", -"CLIENT_NO_LOCATION", -"CLIENT_ONLY_LEGAL", -"CLIENT_TESTING", -"CLIENT_COARSEN_ALL_TESTING", -"CLIENT_GWS_TLD_DESKTOP_ORACLE", -"CLIENT_GWS_TLD_MOBILE_ORACLE", -"CLIENT_GWS_NONTLD_DESKTOP_ORACLE", -"CLIENT_GWS_NONTLD_MOBILE_ORACLE", -"CLIENT_COMPARE_DL", -"CLIENT_COMPARE_IP", -"CLIENT_COMPARE_IPDL", -"CLIENT_MAGICEYE_DIMENSIONS", -"CLIENT_MAPS_GUIDE_DIRECTIONS", -"CLIENT_SAFE_BROWSING", -"CLIENT_GWS_NONTLD_DESKTOP", -"CLIENT_GWS_NONTLD_MOBILE" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true -], -"enumDescriptions": [ -"Unset client ID. Never use it in production code.", -"Curio team (go/curio). Contact: curio-team@.", -"OneGoogle Service (OGS): OGS will fetch the LocationContext for the frontends that have not talked to LES yet.", -"Client id used by evaluation tools. Contact: davidreis@", -"Same as CLIENT_EVALS, but less strict, so can be used to avoid a hack when some use cases needed to send the request twice with different client ID. Contact: bohdant@", -"Client id used by go/unified-query-sourcing. Contact: query-sampling-team@", -"Client id used by Play Books. Contact: ocean-team@", -"Client id used by Bond team. Contact: sterman@ and/or id-devices-eng@", -"Client id used by Chrome User Metrics Analysis (UMA, go/chrome-data)", -"Client id used by DoubleClick Search. Contact: wdtseng@, ds3data@, go/ds", -"Client id used by youtube QoE frontend. Contact: pfish@, kathyqian@, qoe-team@", -"Client id used by youtube Real-Time QoE. Contact: jeffcohen@, tnavien@, qoe-team@", -"Client id used by youtube QoE Livyatan. Contact: kathyqian@, gaozhiquan@, qoe-team@", -"Client id used by YouTube serving frontend and shared by all downstreams of the frontend server. Contact: tubbs@, yt-serving-platform@", -"Client ids used by YouTube Shorts. See go/oolong-changes-for-yt-le for details.", -"", -"", -"", -"Client ids used by Youtube Viral.", -"", -"", -"", -"", -"Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", -"", -"", -"", -"Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", -"", -"", -"", -"Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", -"", -"", -"", -"Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", -"", -"", -"", -"Client id used by YouTube admin review tools. Contact: yurt-eng@", -"Client id used by YouTube Bad Harvest (go/badharvest). Contact: bad-harvest-eng@", -"Client id used by the speech team. Contact: xuedong@", -"Client id used by Gmail team. Contact: shine@, lianglin@", -"Client id used by Gmail/Spam. Contact: gmail-spam-eng@", -"Client id used by chromecast web interface. Contact: pierred@, bquinlan@, eureka-team@", -"Defaults to NONTLD_DEFAULT Contact: jamesjw@, pancetta-eng@", -"Client id used by GLS (Google Location Server) Contact: lmohanan@, tsuwei@, lbs-team@", -"Contact: feedback-eng@", -"Client id used by Android Metrics team. Contact: androidmetrics-eng@", -"Client id used by AdWords Usermgmt (go/usermgmt). Contact: timthom@, ads-usermgmt-eng@", -"Client id used by appremoting VM management stack which is further used by Looking Glass and Developer Shell products. Contact: looking-glass-team@, hekate-eng@.", -"Client id used by the login protections server. (go/hijacking) Contact: hijacking-eng@, danmogo@.", -"Client id used by Actionable IPs. (go/actionable-ips). Contact: amirha@, ncmec-actionableips-eng@.", -"Client id used by Display Ads. Contact: local-display@.", -"CLIENT_DISPLAY_ADS_DEFAULT is the same as CLIENT_DISPLAY_ADS, but excludes postal code trimming. This client is used to make the ProcessLocationContext call.", -"", -"", -"", -"", -"Client id used by Display Ads Preview Service. Contact: fletch-eng@.", -"Client id used by Hobbes(go/hobbes). Contact: hobbes-team@google.com", -"Client id used by Newsstand(go/dots). Contact: gnews-infra@.", -"", -"Client id used by Panoptic (News Ranking + Backend) Contact: polynews-eng@.", -"Client id used by Google Docs. Contact: doplar-eng@, jameshong@", -"Client id used by AdWords Express. Contact: boost-eng@, stephenleung@", -"Client id used by TraceDepot server. Contact: tibrewal@, kjs@", -"Client id used by MapsPro Contact: obrien@, jiazheng@", -"Client id used by Madden (go/madden) Contact: madden-eng@", -"Client id used by AccessFilter Contact: ishwarya@", -"Client id used by Google Domains (go/domain-registrar) Contact: domain-registrar-eng@", -"Client id used by Google Assistant (go/opa) Contact: assistant-infra-core@", -"", -"Client id user by Google Account Linking (go/account-linking) Contact: account-linking-team@", -"Client id used by Legal Removals. Contact: legal-removals-eng@", -"Client id used by Cloud Console (Pantheon) Contact: paninfra-sfo@.", -"Client id used by Cloud New User for Free Trial Contact: coe-nu-eng@", -"Client id used by Solutions Catalog Contact: coe-solutions@", -"Client id used by cloud media access team, go/cloud-media-access Contact: cloud-media-access-team@", -"Client id used by Dotorg G4NP Contact: g4np-eng@", -"Client id used by Crash Internal Contact: crash-team@", -"Client id used by Monlog in access/infrastructure Contact: monlog-eng@", -"Client id used by GoogleVoice Contact: voice-eng@", -"Client id used by Blogger Contact: blogger-tech@, eitzenb@", -"Thor/Google Meet backend. Contact: comms-work-backend-team@.", -"Client id used by News Contact: news-frontend-eng-team@.", -"Client id used by Google Photos", -"Client id used by Google Photos for inferred location tagging.", -"Client id used by RankBrain Debug (go/rankbrain-debug).", -"Client id used by Heterodyne (go/heterodyne) Contact: ph-eng@", -"Client id used by fraudreview (go/fraudreview) Contact: pf-review-tools@", -"Client id used by Jamboard (go/jamboard) for go/jamboard-scheduled-otas Contact: jamboard-eng@", -"Client id used by Marconi (go/marconi) Contact: marconi-eng@", -"Client id used by Aart (go/aart-docs) Contact: aart-team@", -"Client id used by the Google Arts And Culture (go/artsandculture) Contact: ci-eng@", -"Client id used by Youtube Ecommerce (go/ypc) Contact: ytr-eng@", -"Client id used by Ares managed feature providers (go/project-ares) Contact: ares-eng@", -"Client id used by LIS and the UUDE framework (go/uude) Contact: lis-eng@", -"Client id used by Google Store smashberry (go/smashberry) Contact: smashberry-eng@", -"Client id used by Dasher Auditing (go/dasher-auditing) Contact: dasher-auditing-eng@", -"Client id used by the Shopping List Server (go/shopping-list-server) Contact: shoppinglist-eng@", -"Client ID used by the Drive Item Suggest service (go/itemsuggest)", -"Client ID used by Smart Books (go/smart-books) Contact: smart-books-team@", -"Client ID used by GRADS (go/grads)", -"Client ID used by AdsRoot (go/adsroot)", -"Client ID used by Service Engine (go/seroot)", -"Client ID used by Orbit (go/ytorbit)", -"Client ID used by Project Fi (nova). This client was initially created for Nova aperture (go/aperture) but all Nova clients are recommended to use this one.", -"Client ID used by Lena Signup Defaults (go/lena-prd)", -"Client ID used by the Play Console (go/fc) Contact: play-dev-console-platform@", -"Client ID used by Finsky Enterprise (go/pfw)", -"Client ID used by Google Admin (go/google-admin)", -"Client ID used by CryptAuth (go/cryptauth, go/authzen-pdd, go/gnubby-pdd)", -"Client ID used by the GsaUniversalServer (go/gus)", -"Client ID used by the TravelFrontendTransitServer web app.", -"Client ID used by Home Cloud services (go/home-cloud)", -"Client ID used by Google Shopping Express (go/gsx)", -"Client ID used by Google Duo (go/duo)", -"Client ID used by Gaia Frontend (go/gaiafe)", -"Client ID used by Android Messages (go/bugle)", -"Client ID used by Google Lens (go/lens) Contact: lens-frontend-server-eng@", -"Client ID used by Chrome Web Store (go/cws)", -"Client ID used by Actions on Google console (go/aog-console) Contact: actions-on-google-console-eng@", -"Client ID used by Android TV Channels (go/android-tv-channels)", -"Client ID used by Assistant Web Settings (go/assistant-settings-web-ui-design)", -"Client ID used by Play User Data Server (go/play-user-data-server)", -"Client ID used by Ads Integrity (go/ads-integrity) Contact: ads-integrity-risk@", -"Client ID used by Ragnarok (go/ragnarok) Contact: ads-integrity-wat@", -"Client ID used by Firebase Console (go/fireconsole) Contact: fireconsole-contrib@", -"Client ID used by AoG Feed Validator (http://go/aog-feed-validator)", -"Client ID used by Plumeria (go/plumeria-legal-eng-intro) Contact: plumeria-eng@", -"Client ID used by Paisa (http://go/paisa) Contact: paisa-eng@", -"Client ID used by Google Pay (go/googlepay)", -"Client ID used by the Google Pay web serving stack.", -"Client ID used by Google Wallet (go/wallet)", -"Client ID used by Scroogled (go/scroogled). Contact: hijacking-team@.", -"Client ID used by Waymo ride-hailing services. Client referenced in a silo: waymo/taas/frontend3/handlers/test_base.cc Contact: taas-offboard@, chauffeur-hailing@", -"Client ID used by CROW team. Contact: crow-team@", -"Client ID used by the Security Investigation Tool of GSuite Security Center(go/security-investigation-tool). Contact: gsc-sit-eng@", -"Client ID used by the Event Threat Detection team (go/etd). Contact: etd-team@", -"Client ID used by Play Location Server (go/play-location-server). Contact: play-experiment-team@", -"Client ID used by Footplacer (go/footplacer). Contact: footplacer-eng@", -"used by dasher commerce team (go/acom) Contact: dasher-commerce-eng@", -"Client ID used by Social People Analytics (go/spa-docs). Contact: social-people-analytics@", -"Client ID used by Contacts UI surfaces (go/web-contacts). Contact: contactsplus-eng@, custard-eng@", -"Client ID used by Google Analytics (go/gafe4). Contact: gafe4-eng+code@", -"Client ID used by Places API (go/places-api). Contact: geo-enterprise-metrics@", -"", -"Client ID used by Drive Web Frontend. Contact: drive-frontend-eng@", -"Client ID used by Android OTA (go/android-ota). Contact: android-auto-ota-dev@", -"Clients of nearby stores. Contact: payments-microapps-pek-team@", -"Clients used by Fiber Address Service (gfiber-weaver-infra-team@).", -"Client ID used by Support Content (go/supportcontent) Contact: support-content-eng@", -"Logging anonymization for Offroad (GMM offline) search/suggest.", -"Client id used by Google Ads Change History (go/ch). Contact: leonxie@, kluo@, ch-dev@", -"Client ID used by Session Risk (go/session-risk). Contact: session-protection-eng@", -"Client ID used by Alps (go/alps). Contact: address-understanding-team@", -"Client ID used by discover for resolving locations according to the user's news preferences. Contact: newsx@", -"Client Id for Assistant Snapshot.", -"Client ID used by Area 120 Honeycomb (go/honeycomb) Contact: honeycomb-eng@", -"Client ID used by Play Monetary Abuse service to detect location abuse. Contact: play-monetary-abuse@", -"Client ID used by Small Business Advisors (GMB Assisted Activation). Contact: gmb-assisted-activation@", -"Client ID used by GPA Feeds Ingestion. Contact: gpa-feeds-eng@", -"Client ID used by EDU originality reports (go/plagiarism). Contact: plagiarism-eng@", -"Client ID used by Paidtasks to grab user ipgeo information. Contact: 402-eng@", -"Client ID used by Translate for country level IPGeo. Contact: website-translation-team@", -"Client ID used by Funding Choices to determine the legal jurisdiction that a user belongs to, for example, GDPR (EEA) or CCPA (California), etc. More information: go/funding-choices Contact: oncall/xads, funding-choices-eng-core@", -"Client ID used by Search Notifications (go/sno). Contact: now-push-eng-team@", -"Client ID used by Visual Semantic Service (go/vss). Contact: vss-team@", -"Client ID used by the Chrome Prefetch Proxy (go/chrome-p4)", -"Wear OS clients Contact: wear-lon-backend@", -"Client ID used by Payments Risk (go/risk-eng) Contact: payments-risk-team@", -"Client ID used by Payments Orchestration/Orchestration2 server (go/o2) Contact: payments-orchestration-eng@", -"Client ID used by Android TV IRDB (go/sabrina-irdb-service) Contact: project-axel-eng@", -"Client ID used by Trends (go/trends-eng) Contact: trends@", -"Client ID used by Colab (go/colab) Contact: colab-team@", -"Client ID for Socratic (go/bloom) Contact: bloom-edu-eng@", -"Client ID for go/ps1-location Contact: location-infra@", -"Client ID for DDM Reporting Processing go/proc Contact: ddm-reporting-stateless@", -"Client ID for go/hr-be Contact: homeroom-backend@", -"Client ID for cars categorical Contact: cars-eng@", -"Client ID used by Gpay MerchantVerticals VerticalsDiscoveryService go/vertical-discovery Contact: merchant-verticals-discovery-eng@", -"Client ID used by reCAPTCHA's Account Protections team. Shared ID used by both Account Defender and SMS Fraud Detection services. go/recaptcha-account-defender-u-bad Contact: recaptcha-account-protections@", -"Client ID used by reCAPTCHA Lite. go/recaptcha-asn-reputation-design-doc Contact: recaptcha-waf-eng@", -"Client ID used by reCAPTCHA Fraud Prevention. go/recaptcha-fraud-geocoding Contact: recatpcha-fraud@", -"Client ID used by AutoNT DNS mapchecker module. go/autont Contact: autont-team@", -"Client ID used by Transparency for All Ads Report. go/tfaar Contact: tfaa-report-eng@", -"Client ID used by GCIP Location Service. go/cicp-team Contact: cicp-eng@", -"Client ID used by OneStack Metric Collection service.", -"Client ID used by GPay Transit TapAndPay Frontend Service go/transit-recommended-agencies Contact: tp2-transit-eng@", -"Client ID used by Chronicle Security (go/malachite). go/chronicle:theres-waldo Contact: malachite-dip-engg@ Contact: malachite-eng@", -"Client ID used by the UI for Chronicle Security (go/malachite). go/chronicle-i18n-design Contact: chronicle-ui@ Contact: malachite-eng@", -"Client ID used by GPay Merchant Spot Onboarding Tool (b/186640782). Contact: gtech-google-pay-food-fte@ Contact: edisonc@", -"Client ID used by Ads scraping tool owned by Ads ExpandedMatch. go/ads-scraping-tool Contact: ads-expmatch-eng@", -"Client ID for cloud support portal frontend go/xpp-lite Contact: xpp-eng@", -"Client ID used by the LaMDA team. Contact: srrvnn@, lamda-team@ // NOTYPO NOTYPO", -"Client ID used by Pinpoint (go/jsuite-pinpoint) Contact: backlight-eng@", -"Client ID used by Google Shopping Order History (go/shopping-order-history)", -"Client ID used by Nest camera cloud team contact: nest-camera-cloud@google.com", -"Client ID used by Panoptic SxS contact: yukang@, deepakverma@, local-fcr@google.com", -"Client ID used for About This Page external API. contact: beaton, diner-team@, go/project-diner", -"Client ID used for the Photos Analytics marketing pipeline. contact: guillo, photos-analytics@", -"Client ID for the gmscompliance server (UDEVS) contact: gmscore-trust-team@google.com", -"Client ID for Analytics Collection contact: tag-serving-eng@, go/tag-serving", -"Client ID for play console android vitals contact: play-dev-quality-all@google.com", -"Client ID for crashlytics play console crashes contact: play-dev-quality-all@google.com", -"Client ID for Payments Merchant Stories contact: merry-eng@, go/merry", -"Client ID for Cloudtop Connectivity contact: cloudtop-eng@, go/cloudtop", -"Client ID for Cloud Web (cloud.google.com) contact: cloudx-platform-eng@", -"Client for go/speakeasy-meet-consent-frontend Contact: ccp-pegasus@", -"Client for Display & Video 360 (DV3, Xbid) frontend. Contact: qypeng@, xbid-fe-eng@", -"Client for lending data manager. Contact: nest-data-infra-eng@", -"Client for ChromeOS Data Fresnel service. Contact: chromeos-data-eng@", -"Client for PPN team to provide VPN service.", -"Client ID used by Geo API Platform (go/geo:api). Contact: geo-apis-platform@", -"Client for Google One security to access Oolong data. Contact: g1-security-eng@", -"Client ID used by the Google TV Web player (go/lava) Contact: lava-eng@", -"Client ID used by the dynamite server. Contact: dynamite-eng@", -"Client ID used by the bce-client-connector. Contact: bce-client-connector-eng@", -"Client ID used by go/rde team pipeline. Contact: rde-team@.", -"Client ID used by Pinpoint UI tools (go/pinpoint). Contact: pinpoint-team@", -"Client ID for Corplogin Contact: sso-team@", -"Client ID for Monospace (go/monospace) Contact: monospace-team@", -"Client ID used by the Lighter (go/lighter). Contact: lighter-backend-eng@", -"Client ID used by P11 (go/p11-eng) Contact: eleven-sw-eng@", -"Client ID used by the new Find My Device website. Contact: fmd-eng@", -"Client ID used by Youtube TV. Contact: ott-platform-serving", -"Client ID used by Fitbit WebAccounts Contact fitbit-uam@", -"Client ID used for Chord (go/chord-g3doc) Contact: chord-eng@", -"Client ID used by Fitbit-Fi Contact fdp-gallery@", -"Client ID used by Google-Analytics-Serving Contact ga-gold-query-engine@", -"Client ID used by Google Fonts Contact fonts-eng@", -"Client ID used by project Bard Contact bard-team@", -"Client ID used by Nest Renew (go/apollo-eng) Contact apollo-energy-eng@", -"Client ID used by DeepMind Labs Contact deepmind-goodall@", -"Client ID used by One Presence Profiles Contact mcf-profiles-eng-team@", -"Client ID used by Transparency Report (go/transparency-eng) Contact: transparency-report-leads@", -"Client for Google One ML team to access Oolong data. Contact: g1-ml-eng@", -"Client for GMP Partner Gallery team to access Oolong data. Contact: gmppartnergallery-team@", -"Client for MakerSuite. Contact: makersuite-team@", -"Client for Ad Manager ToS Contact: drx-fe-infra@", -"Client ID for Chrome Remote Desktop. contact: chromotin-eng-team@, go/chromoting", -"Client for OSLO Soji (go/soji). Contact: soji-team@", -"Client ID for Workspace labs signup page. Contact: workspace-labs-signup-eng@", -"Client AIDA Contact: aida-api-team@", -"Client ID for Trust Signals Platform Contact: trust-signals-eng@", -"Client Id for AI Test Kitchen Contact: ai-sandbox-eng@", -"Client Id for Labs Tailwind Contact: labs-tailwind-eng-team@", -"Client Id for Gmail Task Assist. Contact: task-assist-eng@", -"Client Id for Pixel Weather service. Contact: pixel-apps-weather-boq-team@", -"Client Id for GPay Geo-based category billers. (go/gpay-category-biller-suggestions-design-doc) Contact: nityam-eng@, gpay-server-infra@", -"Client Id for Support Channels WhatsApp Zendesk integration. (go/cecsi-whatsapp-dd) Contact: voice-channels-eng@", -"Client ID used by Payments Anti-Financial Crimes Transaction Monitoring pipeline to fetch country-level IPGeo information.", -"Client ID for the offline batch pipeline creating the Discover query recommendation corpus.", -"Client id used by Preference Center (go/preference-center). Contact: preference-center-eng@", -"Client ID used by Developer Identity and Accounts Contact: play-dev-dia-epu@google.com.", -"Client ID used by GNP Online Evaluation Contact: gnp-ginger-eng@google.com", -"Client ID used by local suggested sets demo server (go/local-sets-demo-server-dd) Contact: local-sets-quality@", -"Client ID used by Search Labs Contact: search-labs-frontend@google.com", -"Client ID for Crowdsource Contact: crowdsource-eng@google.com", -"Client ID for Tarsier Contact: tarsier-team@google.com", -"Client Id for WorkSpace SideKick. Contact: kopi-eng@", -"Client id used by Google Photos for reminising features.", -"Client Id for Geox contamination. Contact: amt-geox-core@", -"Client Id for CloudMessageStore. Contact:tachyon-backend-eng@", -"Client Id for IP Protection Contact: ip-protection-team@", -"Client Id for Search MCF Hamsa. Contact: search-mcf-hamsa@", -"Client Id for Account Location (go/accountlocation). Contact emmett-eng@google.com, compliance-signals-eng@google.com", -"Client Id for Android Backup & Restore (http://go/br-home). Contact android-backup-server-eng@google.com", -"Client Id for Google Ads AWSM. Contact awsm-eng@google.com", -"Client Id for Stargate satellite messaging. Contact dune-server-eng-team@google.com", -"Client Id for Account Management (go/ams). Contact account-management-eng@google.com, compliance-signals-eng@google.com.", -"Client Id for User Account Creation (go/id-eco-infra:account-creation). Contact account-ecosystem-infra-team@google.com, compliance-signals-eng@google.com.", -"Client Id for Netsense (go/netsense). Contact trapdoor-team@google.com,", -"Client ID used by Fitbit Labs (go/fitbit-labs). Contact fitbit-labs-eng@", -"Client ID used by Local Services Ads. Contact sab-eng@", -"Client ID used by the User Feedback Service (go/user-feedback-service). Contact ads-integrity-transparency-team@", -"Client ID used by Bard/Gemini evals to spoof location data. Contact bard-eval-infra@ This should only be used with spoofed location data. For real user data, follow the onboarding steps at go/use-current-location", -"Client ID used by the Scenario-based Seeding Home & Work seeder. Contact loki-prod@google.com", -"Client ID used by the ADI Feature API (go/adi-feature-api)", -"Client Id for Labs Bettany Contact: bettany-eng@", -"Client Id for neco-genesis Contact: neco-eng@", -"Client ID used by Fitbit Capabilities Service (go/fitbit-capabilities). Contact fitbit-app-platform@", -"Client ID for Ads Marketing Automation (go/ce-ama) Contact: ads-marketing-automation-eng@", -"Client ID for Android Telemetry Westworld Contact: android-telemetry-infra-server@", -"Client ID for Data Security Posture Management (DSPM) Detective Controls Contact: dspm-controls-eng@", -"Client ID for CAA Insights Contact: policy-decision-service-eng@", -"Gws. Contact: oolong-team@.", -"", -"", -"", -"", -"", -"Search Ads clients providing similar user location to Search.", -"", -"", -"", -"", -"", -"", -"", -"Ad manager user sign up location by IP address", -"Use these within GWS iff the project is not using TLD (e.g. www.google.ch).", -"", -"", -"", -"Client Ids for Assistant via Oolong Service.", -"", -"", -"", -"Gws tld experimental clients", -"", -"", -"", -"Ads experimental clients", -"", -"", -"", -"Gws nontld experimental clients", -"", -"", -"", -"Assistant experimental clients", -"", -"", -"", -"Clients for Andromeda experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Bootes experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Cassiopeia experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Delphinus experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Eridanus experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Fomax experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Gemini experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Hercules experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Indus experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Leo experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Mensa experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Norma experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Orion experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Pisces experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Reticulum experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Sagittarius experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Taurus experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Ursa Major experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Virgo experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Use for LoggedContext re-geocoding. Do not use for LocationContext processing.", -"Client useful for country level IPGeo. It accepts any country regardless of the confidence. Do not use this client for any location other than country. It can be used while migrating from legacy googledata/ipgeo index. Contact: oolong-team@.", -"Client similar to CLIENT_IPGEO_REGION, but adapted to IPGeo Eval purpose. Contact: ipgeo-team@.", -"Tactile initial viewport policy. Contact: oolong-team@ Note that maps clients don't adhere to TLD restrictions.", -"", -"", -"", -"Maps clients that use glassbox.", -"", -"", -"", -"", -"", -"Experimental maps clients.", -"", -"Session IP geocoding. Contact: oolong-team@.", -"Use this client ID if you are not using oolong legal/quality annotations. A sample usecase is reverse geocoding a set of lat/lngs or mids/featureids. NOTE: do not use oolong annotations if this client is set.", -"Default client to use when TLD restrictions are not applied. This policy can change without notice. If you care about particular quality assumptions, then create a custom client id. Contact: oolong-team@", -"Does NOT annotate anything with UNIQUE_SELECTED_FOR_USER_LOCATION", -"Client id that only applies legal annotations.", -"Use for testing only. Never use this in production.", -"", -"Used for oracle eval.", -"", -"", -"", -"Clients used to compare different location source combinations.", -"", -"", -"Client used for country field in Magic Eye dimensions (go/core-dimensions).", -"Used for the go/mapsguide directions prototype.", -"Deprecated clients SafeBrowsing Team. Contact: anov@.", -"Use CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK or _GAIA Contact oolong-team@", -"Use CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK or _GAIA Contact oolong-team@" -], -"type": "string" -}, -"name": { -"description": "The name of this set.", -"type": "string" -}, -"policyResult": { -"$ref": "LocationUnifiedPolicyResult", -"description": "The policy result that corresponds to the alternate policy." -}, -"sourceDescription": { -"description": "The source description for this result in the alternate policy.", -"enum": [ -"SOURCE_DESCRIPTION_UNSPECIFIED", -"FROM_YOUR_INTERNET_ADDRESS", -"FROM_YOUR_LOCATION_HISTORY", -"BASED_ON_YOUR_LOCATION_HISTORY", -"FROM_YOUR_DEVICE", -"BASED_ON_YOUR_PAST_ACTIVITY", -"FROM_YOUR_PLACES_HOME", -"FROM_YOUR_PLACES_WORK" -], -"enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"LocationUnifiedExtractorFlags": { -"id": "LocationUnifiedExtractorFlags", -"properties": { -"gwsJurisdictionCountryExtractorEnabled": { -"type": "boolean" -}, -"hostDomainExtractorEnabled": { -"type": "boolean" -}, -"ipAlternateExtractorEnabled": { -"type": "boolean" -}, -"ipExtractorEnabled": { -"type": "boolean" -}, -"queryExtractorEnabled": { -"description": "If true, any query found in the request will be included in geocoding and the location context.", -"type": "boolean" -}, -"uuleCookieExtractorEnabled": { -"type": "boolean" -}, -"xgeoHeaderExtractorEnabled": { -"type": "boolean" -} -}, -"type": "object" -}, -"LocationUnifiedFeatureIdProto": { -"description": "A copy of //geostore/base/proto/featureid.proto. Because Oolong descriptors are intended to be publicly available, we don't want to depend on other protos. This proto is tag-compatible with the original. Note that this could be used for non-Oyster identifiers if distinguished by some appropriate producer. Otherwise, it is assumed to be an Oyster ID. The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION.", -"id": "LocationUnifiedFeatureIdProto", -"properties": { -"cellId": { -"description": "The S2CellId corresponding to the approximate centroid of this feature.", -"format": "uint64", -"type": "string" -}, -"fprint": { -"description": "A 64-bit fingerprint used to distinguish between multiple features at the same location.", -"format": "uint64", -"type": "string" -} -}, -"type": "object" -}, -"LocationUnifiedFeatureReference": { -"description": "A featurelet in the location result's hierarchy. This references the feature pool for base data (like names and geometry), and contains additional fields that are set by the policy.", -"id": "LocationUnifiedFeatureReference", -"properties": { -"alternateAnnotations": { -"description": "Alternate annotations applied to this featurelet.", -"items": { -"$ref": "LocationExtractorFeatureletAnnotationSet" -}, -"type": "array" -}, -"annotations": { -"description": "Annotations applied to this featurelet by the policy store.", -"items": { -"enum": [ -"TRIMMED_BY_QUALITY_FILTERING" -], -"enumDescriptions": [ -"Indicate that a featurelet should not be used. This annotation is applied during ApplyQualityFiltering for feature \"trimming\" or added by the PolicyStore as a result of quality score calculation." -], -"type": "string" -}, -"type": "array" -}, -"confidence": { -"description": "The confidence that this featurelet is correct.", -"format": "float", -"type": "number" -}, -"featureId": { -"$ref": "GeostoreFeatureIdProto", -"description": "The feature ID, which is used as key for looking up the featurelet from the LocationContext's feature pool." -} -}, -"type": "object" -}, -"LocationUnifiedFieldOfView": { -"description": "A description of the field of view of a camera. Used in conjunction with location and rotation to indicate how much of a scene is being rendered inside the camera.", -"id": "LocationUnifiedFieldOfView", -"properties": { -"fieldOfViewXDegrees": { -"description": "Horizontal degrees of view, i.e. the angle between the left and right clipping planes.", -"format": "float", -"type": "number" -}, -"fieldOfViewYDegrees": { -"description": "Vertical degrees of view, i.e. the angle between the top and bottom clipping planes.", -"format": "float", -"type": "number" -}, -"screenWidthPixels": { -"description": "Pixel dimensions of a device screen. This is currently only used by Tactile and should not be used elsewhere without good reason, at which point we would probably rename the field. Pixels are assumed to be square.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"LocationUnifiedInterpretationData": { -"id": "LocationUnifiedInterpretationData", -"properties": { -"query": { -"description": "Serialized s-expr annotated with :loc.", -"type": "string" -}, -"term": { -"description": "This group provides details about what we found in the query as a set of non-overlapping 'terms', each referring to a separate political feature. E.g. query of \"Pizza near Mt View CA\" would (in one of the geocodes) contain two terms: \"Mt View\" and \"CA\". All terms are given in left-to-right order. Note that not all featurelets necessarily occur as a term. Some may have been inferred from the political hierarchy. E.g. in the example above there would be a featurelet for the US after the one for \"CA\".", -"items": { -"$ref": "LocationExtractorInterpretationTerm" -}, -"type": "array" -} -}, -"type": "object" -}, -"LocationUnifiedLatLng": { -"description": "A latitude and longitude used to describe a point. Units are degrees x 10^7 and rounded to the nearest integer). When used to describe a point, the latitudes should be in the range +/- 90 degrees and the longitude should be in the range +/- 180 degrees (inclusive). LatLng message was also used to describe a span, but it turns out full longitude span (360 degrees * 10^7) does not fit in signed int32. Thus, using LatLng for a span is deprecated. Please use LatLngRect instead. The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION.", -"id": "LocationUnifiedLatLng", -"properties": { -"latitudeE7": { -"format": "int32", -"type": "integer" -}, -"longitudeE7": { -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, -"LocationUnifiedLatLngRect": { -"description": "A latitude-longitude rectangle, represented as two diagonally opposite points \"lo\" and \"hi\". The rectangle is considered to be a closed region, i.e. it includes its boundary. The latitude bounds must be in the range -90 to 90 degrees inclusive, and the longitude bounds must be in the range -180 to 180 degrees inclusive. Both points must be normalized, with lo.latitude <= hi.latitude. If lo.latitude > hi.latitude, the latitude range is considered empty and there will be a warning the first 100 times Oolong sees such proto. \"lo\" point is the lower-left corner and \"hi\" point is the upper-right corner of the resulting rectangle. Various special cases include: - If lo == hi, the rectangle consists of a single point. - If lo.longitude > hi.longitude, the longitude range is \"inverted\" (the rectangle crosses the 180 degree longitude line). - If lo.longitude == -180 degrees and hi.longitude = 180 degrees, the rectangle includes all longitudes. - If lo.longitude = 180 degrees and hi.longitude = -180 degrees, the longitude range is empty. The code in logs/storage/validator/logs_validator_traits.cc treats this type as if it were annotated as ST_LOCATION.", -"id": "LocationUnifiedLatLngRect", -"properties": { -"hi": { -"$ref": "LocationUnifiedLatLng" -}, -"lo": { -"$ref": "LocationUnifiedLatLng" -} -}, -"type": "object" -}, -"LocationUnifiedLocationAnnotation": { -"description": "Used to distinguish locations within a location context (e.g., indicate those locations selected by a policy).", -"id": "LocationUnifiedLocationAnnotation", -"properties": { -"details": { -"description": "Optional debug information associated with this annotation. For human consumption only.", -"type": "string" -}, -"type": { -"description": "Indicates the purpose of this annotation.", -"enum": [ -"UNKNOWN_ANNOTATION", -"UNIQUE_SELECTED_FOR_CONTEXT", -"UNIQUE_SELECTED_FOR_USER_LOCATION", -"SELECTED_FOR_EXPLICIT_IMMEDIATE_LOCATION", -"UNIQUE_SELECTED_FOR_NON_QUERY_ROLES", -"UNIQUE_TRUSTED_CURRENT_LOCATION", -"UNIQUE_TRUSTED_CURRENT_COUNTRY", -"UNIQUE_JURISDICTION_COUNTRY", -"SELECTED_FOR_JURISDICTION_COUNTRIES", -"DOES_NOT_CONFORM_TO_TLD", -"MARKED_FOR_POLICY_REMOVAL", -"FINE_GRAINED_CURRENT_LOCATION", -"UNIQUE_SELECTED_FOR_CONTEXT_EXPERIMENTAL_QREF", -"SELECTED_FOR_RTBF_COUNTRIES", -"UNIQUE_SELECTED_FOR_RTBF_DOMAIN", -"PRODUCER_ABLATED_FOR_EXPERIMENT", -"SELECTED_FOR_AREA_OF_INTEREST", -"SELECTED_FOR_FREQUENT_LOCATION", -"STRIPPED_FROM_LIVE_RESPONSE", -"UNIQUE_SELECTED_FOR_ROLE", -"LOW_CONFIDENCE", -"DO_NOT_USE_FOR_SEARCHING", -"EXPERIMENTAL", -"UNIQUE_SELECTED_LOCALE", -"UNIQUE_SELECTED_FOR_SEMANTIC_USER_LOCATION", -"ADDITIONAL_USER_LOCATION", -"REMOVED_DEVICE_LOCATION" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -true, -true, -true, -true, -true, -true, -true, -true -], -"enumDescriptions": [ -"THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors.", -"A descriptor with this annotation has been selected by some policy as the single descriptor to be used for this request. This selects a result that prefers explicit location set by the user over our best guess for the user location. If you think you need to use this annotation, please contact oolong-team@ first. Use SELECTED_FOR_EXPLICIT_IMMEDIATE_LOCATION and UNIQUE_SELECTED_FOR_USER_LOCATION, if you need access to user provided locations and/or implicit user locations respectively. Invariant: At most one descriptor in a context can have an annotation of this type.", -"A descriptor with this annotation has been selected by some policy as the single descriptor to be used for current user location (physical location). Note that this is our best guess about actual user location which may be spoofed by malicious user. If you need stronger guarantees about user country of presence, use UNIQUE_TRUSTED_CURRENT_LOCATION annotation defined below (if in doubt, contact oolong-team for advise). Invariant: At most one descriptor in a context can have this annotation.", -"Descriptors with this annotation have been selected by the policy as the set of locations that can be used as explicit immediate locations. Note that the set will not contain current user location (e.g. location with annotation UNIQUE_SELECTED_FOR_USER_LOCATION). It may contain query location, viewport or a location that has been specified by the user for a given request, such as the &near param. For more details see: https://docs.google.com/a/google.com/document/d/1aTiZG-r-hrLRGiGCJvjIAk45hUPSi07idxySzvzaQvk/edit", -"A descriptor with this annotation has been selected by some policy as the single descriptor to be used for this request, excluding any locations present in the user query. This will be the descriptor that would have the annotation UNIQUE_SELECTED_FOR_CONTEXT if all QUERY role descriptors were removed from the context. Invariant: At most one descriptor in a context can have this annotation.", -"A descriptor with this annotation has been selected by some policy as the single descriptor in the context that can be trusted to represent the user's current location (i.e., it is not user specified and is hard to spoof). TLD does not affect this annotation. This annotation can be used to apply restrictions on services based on a user's \"physical\" location. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team (and possibly Legal). It can only be used in very specific circumstances.", -"A descriptor with this annotation has been selected by some policy as the single descriptor in the context that can be trusted to represent the user's current country (i.e., it is not user specified and is hard to spoof). TLD does not affect this annotation. This annotation can be used to apply restrictions on services based on a user's \"physical\" location. This is the country-level-only version of UNIQUE_TRUSTED_CURRENT_LOCATION. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team (and possibly Legal). It can only be used in very specific circumstances.", -"A descriptor with this annotation has been selected by some policy as the single descriptor in the context that represents the country of jurisdiction for the user. Some restrictions can be applied based on the location country in this descriptor. This annotation can be used to apply restrictions on services based on a user's \"logical\" location. Results annotated with UNIQUE_JURISDICTION_COUNTRY are not guaranteed to have a TYPE_COUNTRY feature if the result is within a disputed area. See also SELECTED_FOR_JURISDICTION_COUNTRIES below. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team (and possibly Legal). It can only be used in very specific circumstances.", -"SELECTED_FOR_JURISDICTION_COUNTRIES is always added to the result annotated with UNIQUE_JURISDICTION_COUNTRY. If the UNIQUE_JURISDICTION_COUNTRY result matches a disputed area in http://google3/googledata/location/unified/location_service/disputed_areas_jurisdiction_countries.txt, then SELECTED_FOR_JURISDICTION_COUNTRIES is additionally added to synthetic results with the country codes specified in that file. For example, if a result in Crimea is annotated with UNIQUE_JURISDICTION_COUNTRY, then SELECTED_FOR_JURISDICTION_COUNTRIES will be present: - on the Crimea location; - on a synthetic result in Russia (with country code RU); and - on a synthetic result in Ukraine (with country code UA). DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team (and possibly Legal). It can only be used in very specific circumstances.", -"A descriptor with this annotation means that it was an implicit (ie IP, not NEAR) location and the country of the result does not match the country of the TLD. Results with these annotations should not be used without first consulting oolong-team.", -"This annotation means that the descriptor is not allowed by the policy that was applied. It may appear in alternate annotations in a merged LocationContext. Results with this annotation should be removed when the merged LocationContext is split. For example, Ads essential-only mode clients forbid the use of UULE device locations. Results with this annotation should generally not have any of the \"Search selected\" or \"Legal selected\" annotations.", -"A descriptor with this annotation means that it is a very precise user location, such as a GPS location. This annotation is applied to locations with UNIQUE_SELECTED_FOR_USER_LOCATION annotation.", -"This annotation has been introduced for the purpose of transitioning from LES query geocoding to QREF query geocoding. Clients who wish to use QREF query annotations, should consider using this annotation as a replacement for UNIQUE_SELECTED_FOR_CONTEXT. It has identical semantics to UNIQUE_SELECTED_FOR_CONTEXT with a difference that QREF annotations are used. Note that this is a temporary annotation and should eventually be removed once migration to QREF is complete.", -"This annotation selects the countries for RTBF content restriction. The union of restrictions of all countries with this annotation should be applied.", -"This annotation selects the country based on which all european RTBF content restrictions should be applied if the selected country is european.", -"This annotation indicates that the result has a producer that was removed as asked by the Oolong__producers_to_ablate flag and re-added.", -"This annotation indicates that the location has been selected by some policy as an area of interest, i.e. the location is of significance to the user. Areas of interest are usually implicit, i.e. not part of the current query. See go/oolong-aoi. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team.", -"This annotation indicates that the location has been selected by some policy as a frequent location. Frequent locations are places where we expect a user to spend extended amounts of time. See go/oolong-serving-flops. DO NOT USE THIS ANNOTATION WITHOUT TALKING TO oolong-team.", -"This annotation should never been seen at serving time, yet it will be present in logs to indicate when a specific location was stripped at serving time. For example, when a location is not accessible by any location view.", -"DEPRECATED annotations", -"", -"", -"", -"Use UNIQUE_SELECTED_FOR_USER_LOCATION instead", -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"LocationUnifiedLocationAttributesProto": { -"description": "Supplemental attributes for a location that may affect search results. Next Id: 24", -"id": "LocationUnifiedLocationAttributesProto", -"properties": { -"activityRecord": { -"description": "The user detected activity.", -"items": { -"$ref": "LocationUnifiedActivityRecord" -}, -"type": "array" -}, -"adsConfidence": { -"description": "Confidence for use in ads. Might be different from the confidence in the descriptor. Currently only used for locations with producer TRAVEL_STATE_INTENT.", -"format": "float", -"type": "number" -}, -"altitudeMetersFromGround": { -"description": "Altitude in meters, from ground level.", -"format": "double", -"type": "number" -}, -"bearingAccuracyDegrees": { -"description": "The accuracy of bearing in degrees, based on GMS Core calculations on two latest location points. The actual bearing should be within bearing_degrees \u00b1 bearing_accuracy_degrees.", -"format": "int32", -"type": "integer" -}, -"bearingDegrees": { -"description": "The direction in degrees in which the client device was moving. Must be in the range 0 to 359. 0 represents north and 90 is east.", -"format": "int32", -"type": "integer" -}, -"boardedTransitVehicleToken": { -"description": "An opaque token to represent a transit vehicle that a user is riding. This field is always server generated and encoding scheme is determined by the server. Currently, Tactile's local encoding (web-safe base64 prefixed by \"B\") is used.", -"type": "string" -}, -"carrierIpType": { -"enum": [ -"CARRIER_IP_UNKNOWN", -"CARRIER_IP_NOT_CARRIER", -"CARRIER_IP_MOBILE" -], -"enumDescriptions": [ -"", -"", -"" -], -"type": "string" -}, -"deviceLocationRatio": { -"description": "FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Ratio of device location versus other signals that we have for this user. Note that this is a per-user attribute, not a per-location attribute.", -"format": "float", -"type": "number" -}, -"fieldOfView": { -"$ref": "LocationUnifiedFieldOfView", -"description": "The field of view of a camera." -}, -"headingDegrees": { -"description": "The direction in degrees in which the client device was pointed. Must be in the range 0 to 359. 0 represents north and 90 is east.", -"format": "int32", -"type": "integer" -}, -"inference": { -"enum": [ -"INFERENCE_NONE", -"INFERENCE_HULK_HEURISTIC", -"INFERENCE_HULK_CLASSIFIED", -"INFERENCE_HULK_UNKNOWN", -"INFERENCE_PLM" -], -"enumDescriptions": [ -"this is not an inferred place", -"", -"HULK Classifier is used instead of heuristic.", -"", -"" -], -"type": "string" -}, -"ipRangeConfidence": { -"format": "float", -"type": "number" -}, -"manualEntry": { -"enum": [ -"MANUAL_ENTRY_NONE", -"MANUAL_ENTRY_UNKNOWN", -"MANUAL_ENTRY", -"MANUAL_ENTRY_DROPPED_PIN", -"MANUAL_ENTRY_HIGH_LEVEL", -"MANUAL_ENTRY_STALE", -"MANUAL_ENTRY_INSUFFICIENT_LOCATIONS" -], -"enumDescriptions": [ -"this place was not manually entered", -"", -"Not stale manual entry of an address", -"", -"", -"", -"" -], -"type": "string" -}, -"personalizedLocationAttributes": { -"$ref": "LocationUnifiedPersonalizedLocationAttributes", -"description": "FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Additional Oolong-specific attributes of the location." -}, -"plmSourceLocationCount": { -"description": "FOR OOLONG INTERNAL USE ONLY! TODO(b/142046202) Migrate this field outside of Location Descriptor. Total number of locations (across all events) used in PLM inference.", -"format": "int32", -"type": "integer" -}, -"plmType": { -"deprecated": true, -"enum": [ -"PLMTYPE_UNKNOWN", -"PLMTYPE_FIRST", -"PLMTYPE_SECOND", -"PLMTYPE_THIRD", -"PLMTYPE_FOURTH", -"PLMTYPE_FIFTH", -"PLMTYPE_SIXTH", -"PLMTYPE_SEVENTH", -"PLMTYPE_EIGHTH", -"PLMTYPE_NINTH" -], -"enumDescriptions": [ -"", -"Order by confidence.", -"", -"", -"", -"", -"", -"", -"", -"" -], -"type": "string" -}, -"rollDegrees": { -"description": "Clockwise rotation around the line of sight (i.e. vector (0, 0, -1) in Eye Coords). Zero means that y points up in Screen Coords; 180 gives an upside down view, where y points down in Screen Coords. Allowed range is [0, 360). For out-of-range values, the behavior is undefined.", -"format": "int32", -"type": "integer" -}, -"speedAccuracyKph": { -"description": "The accuracy of the speed in kilometers per hour, meaning that the actual speed should be within speed_kph \u00b1 speed_accuracy_kph.", -"format": "int32", -"type": "integer" -}, -"speedKph": { -"description": "The speed in kilometers per hour at which the client device was moving.", -"format": "int32", -"type": "integer" -}, -"tiltDegrees": { -"description": "Rotation where zero points down, 180 points up and 90 points to horizon. Allowed range is [0, 180]. For out-of-range values, the behavior is undefined.", -"format": "int32", -"type": "integer" -}, -"viewportSearchOptions": { -"enum": [ -"VIEWPORT_SEARCH_OPTIONS_UNSPECIFIED", -"VIEWPORT_SEARCH_OPTIONS_AROUND", -"VIEWPORT_SEARCH_OPTIONS_RESTRICT", -"VIEWPORT_SEARCH_OPTIONS_FILTER_ONLY", -"VIEWPORT_SEARCH_OPTIONS_FORCE_AROUND" -], -"enumDescriptions": [ -"", -"", -"", -"", -"" -], -"type": "string" -}, -"weekSecondConfidence": { -"format": "float", -"type": "number" -} -}, -"type": "object" -}, -"LocationUnifiedLocationContext": { -"description": "A container for passing and processing the set of locations associated with a particular request. Next available tag: 11", -"id": "LocationUnifiedLocationContext", -"properties": { -"clientId": { -"description": "The client ID that was used for annotating this location context (if any). This field is set accordingly by the policy annotation.", -"enum": [ -"CLIENT_UNKNOWN", -"CLIENT_CURIO", -"CLIENT_ONE_GOOGLE_SERVICE", -"CLIENT_EVALS", -"CLIENT_EVALS_ONESHOT", -"CLIENT_EVALS_UQS", -"CLIENT_BOOKS", -"CLIENT_BOND", -"CLIENT_CHROME_UMA", -"CLIENT_DOUBLECLICK_SEARCH", -"CLIENT_YOUTUBE_ISP_RATING", -"CLIENT_YOUTUBE_REAL_TIME_QOE", -"CLIENT_YOUTUBE_QOE_LIVYATAN", -"CLIENT_YOUTUBE", -"CLIENT_YOUTUBE_SHORTS_DESKTOP_GAIA", -"CLIENT_YOUTUBE_SHORTS_DESKTOP_ZWIEBACK", -"CLIENT_YOUTUBE_SHORTS_MOBILE_GAIA", -"CLIENT_YOUTUBE_SHORTS_MOBILE_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA", -"CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_LES", -"CLIENT_YOUTUBE_VIRAL_EXP_DESKTOP_GAIA", -"CLIENT_YOUTUBE_VIRAL_EXP_DESKTOP_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_EXP_MOBILE_GAIA", -"CLIENT_YOUTUBE_VIRAL_EXP_MOBILE_ZWIEBACK", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_AXOLOTL", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_AXOLOTL", -"CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_AXOLOTL", -"CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_AXOLOTL", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_BADGER", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_BADGER", -"CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_BADGER", -"CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_BADGER", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_GAIA_CHIPMUNK", -"CLIENT_YOUTUBE_VIRAL_DESKTOP_ZWIEBACK_CHIPMUNK", -"CLIENT_YOUTUBE_VIRAL_MOBILE_GAIA_CHIPMUNK", -"CLIENT_YOUTUBE_VIRAL_MOBILE_ZWIEBACK_CHIPMUNK", -"CLIENT_YOUTUBE_ADMIN_YURT", -"CLIENT_YOUTUBE_BAD_HARVEST", -"CLIENT_SPEECH", -"CLIENT_GMAIL", -"CLIENT_GMAIL_SPAM", -"CLIENT_CHROMECAST_WEB", -"CLIENT_PANCETTA", -"CLIENT_GOOGLE_LOCATION_SERVER", -"CLIENT_GOOGLE_FEEDBACK", -"CLIENT_ANDROID_METRICS_WAREHOUSE", -"CLIENT_USERMGMT", -"CLIENT_APPREMOTING", -"CLIENT_GAIA_PERMISSION_SERVER", -"CLIENT_ACTIONABLE_IPS", -"CLIENT_DISPLAY_ADS", -"CLIENT_DISPLAY_ADS_DEFAULT", -"CLIENT_DISPLAY_ADS_DESKTOP_GAIA", -"CLIENT_DISPLAY_ADS_DESKTOP_ZWIEBACK", -"CLIENT_DISPLAY_ADS_MOBILE_GAIA", -"CLIENT_DISPLAY_ADS_MOBILE_ZWIEBACK", -"CLIENT_DISPLAY_ADS_PREVIEW", -"CLIENT_HOBBES", -"CLIENT_NEWSSTAND", -"CLIENT_NEWSSTAND_EXPERIMENTAL", -"CLIENT_POLYNEWS", -"CLIENT_DOCS", -"CLIENT_ADWORDS_EXPRESS", -"CLIENT_TRACE_DEPOT", -"CLIENT_MAPSPRO", -"CLIENT_GEO_ONDEMAND", -"CLIENT_ACCESS_FILTER", -"CLIENT_DOMAIN_REGISTRAR", -"CLIENT_ASSISTANT", -"CLIENT_ASSISTANT_FRONTEND", -"CLIENT_ACCOUNT_LINKING", -"CLIENT_LEGAL_REMOVALS", -"CLIENT_CLOUD_CONSOLE", -"CLIENT_CLOUD_FREE_TRIAL", -"CLIENT_CLOUD_SOLUTIONS_CATALOG", -"CLIENT_CLOUD_MEDIA_ACCESS", -"CLIENT_DOTORG_G4NP", -"CLIENT_CRASH_INTERNAL", -"CLIENT_GOOGLE_WIFI_MONLOG", -"CLIENT_GOOGLE_VOICE", -"CLIENT_BLOGGER", -"CLIENT_THOR_BACKEND", -"CLIENT_NEWS", -"CLIENT_GOOGLE_PHOTOS", -"CLIENT_GOOGLE_PHOTOS_INFERRED_LOCATION", -"CLIENT_RANKBRAIN_DEBUG", -"CLIENT_HETERODYNE", -"CLIENT_FRAUDREVIEW", -"CLIENT_JAMBOARD", -"CLIENT_MARCONI", -"CLIENT_AART", -"CLIENT_CULTURAL", -"CLIENT_YOUTUBE_ECOMMERCE", -"CLIENT_ARES", -"CLIENT_LIS", -"CLIENT_STORE", -"CLIENT_DASHER_AUDITING", -"CLIENT_SHOPPING_LIST", -"CLIENT_ITEM_SUGGEST", -"CLIENT_SMART_BOOKS", -"CLIENT_GRADS", -"CLIENT_ADS_ROOT", -"CLIENT_SE_ROOT", -"CLIENT_YT_ORBIT", -"CLIENT_NOVA_APERTURE", -"CLIENT_LENA_SIGNUP_DEFAULTS", -"CLIENT_PLAY_APPS_PUBLISHER", -"CLIENT_FINSKY_ENTERPRISE", -"CLIENT_GOOGLE_ADMIN", -"CLIENT_CRYPTAUTH", -"CLIENT_GSA_UNIVERSAL_SERVER", -"CLIENT_TRAVEL_FRONTEND_TRANSIT", -"CLIENT_HOME_CLOUD", -"CLIENT_GSX_MALL", -"CLIENT_GOOGLE_DUO", -"CLIENT_GAIA_FRONTEND", -"CLIENT_ANDROID_MESSAGES", -"CLIENT_GOOGLE_LENS", -"CLIENT_CHROME_WEB_STORE", -"CLIENT_ACTIONS_ON_GOOGLE_CONSOLE", -"CLIENT_ANDROID_TV_CHANNELS", -"CLIENT_ASSISTANT_WEB_SETTINGS", -"CLIENT_PLAY_USER_DATA", -"CLIENT_ADS_INTEGRITY", -"CLIENT_ADS_INTEGRITY_MALVERTISING", -"CLIENT_FIREBASE_CONSOLE", -"CLIENT_AOG_FEED_VALIDATOR", -"CLIENT_PLUMERIA", -"CLIENT_PAISA", -"CLIENT_GOOGLE_PAY", -"CLIENT_GOOGLE_PAY_WEB", -"CLIENT_GOOGLE_WALLET", -"CLIENT_SCROOGLED", -"CLIENT_WAYMO", -"CLIENT_CROW", -"CLIENT_GSUITE_SECURITY_CENTER_SIT", -"CLIENT_EVENT_THREAT_DETECTION", -"CLIENT_PLAY_LOCATION", -"CLIENT_FOOTPLACER", -"CLIENT_DASHER_COMMERCE", -"CLIENT_SOCIAL_PEOPLE_ANALYTICS", -"CLIENT_CONTACTS_UI", -"CLIENT_GAFE4", -"CLIENT_PLACES_API", -"CLIENT_PLACES_SEARCH_API", -"CLIENT_DRIVE_WEB", -"CLIENT_ANDROID_OTA", -"CLIENT_PAISA_NEARBY_STORES", -"CLIENT_ISP_FIBER_FAS", -"CLIENT_SUPPORT_CONTENT", -"CLIENT_GWS_OFFROAD_LOGGING", -"CLIENT_CHANGEHISTORY", -"CLIENT_SESSION_RISK", -"CLIENT_ALPS", -"CLIENT_DISCOVER_NEWS_LOCATION", -"CLIENT_ASSISTANT_SNAPSHOT", -"CLIENT_HONEYCOMB", -"CLIENT_PLAY_MONETARY_ABUSE", -"CLIENT_SMALL_BUSINESS_ADVISORS", -"CLIENT_GPA_FEEDS", -"CLIENT_EDU_ORIGINALITY", -"CLIENT_PAIDTASKS", -"CLIENT_TRANSLATE", -"CLIENT_FUNDING_CHOICES", -"CLIENT_SEARCH_NOTIFICATIONS", -"CLIENT_VISUAL_SEMANTIC_SERVICE", -"CLIENT_CHROME_PREFETCH_PROXY", -"CLIENT_WEAR_FRONTEND", -"CLIENT_PAYMENTS_RISKENGINE", -"CLIENT_PAYMENTS_ORCHESTRATION", -"CLIENT_ANDROID_TV_IRDB", -"CLIENT_TRENDS_FRONTEND", -"CLIENT_COLABORATORY", -"CLIENT_SOCRATIC", -"CLIENT_PS1_LOCATION", -"CLIENT_DDM_REPORTING", -"CLIENT_HOMEROOM_BACKEND", -"CLIENT_CARS_CATEGORICAL", -"CLIENT_GPAY_MERCHANT_VERTICALS", -"CLIENT_RECAPTCHA_ACCOUNT_DEFENDER", -"CLIENT_RECAPTCHA_LITE", -"CLIENT_RECAPTCHA_FRAUD", -"CLIENT_AUTONT_ACCESS_LOCATION", -"CLIENT_TFAA_REPORT", -"CLIENT_IDAAS_IP_LOCATION", -"CLIENT_ONESTACK_METRIC_COLLECTION", -"CLIENT_GPAY_TRANSIT", -"CLIENT_CHRONICLE_SECURITY", -"CLIENT_CHRONICLE_SECURITY_UI", -"CLIENT_GPAY_MERCHANT_SPOT_ONBOARDING_TOOL", -"CLIENT_ADS_SCRAPING", -"CLIENT_CLOUD_SUPPORT_PORTAL", -"CLIENT_LAMDA", -"CLIENT_PINPOINT", -"CLIENT_SHOPPING_ORDER_HISTORY", -"CLIENT_NEST_CAMERA_CLOUD", -"CLIENT_PANOPTIC_EVAL", -"CLIENT_ABOUT_THIS_PAGE", -"CLIENT_PHOTOS_ANALYTICS_MARKETING", -"CLIENT_GMSCORE_GMSCOMPLIANCE", -"CLIENT_ANALYTICS_COLLECTION", -"CLIENT_PLAY_CONSOLE_ANDROID_VITALS", -"CLIENT_CRASHLYTICS_PLAY_CONSOLE_CRASHES", -"CLIENT_PAYMENTS_MERCHANT_STORIES", -"CLIENT_CLOUDTOP_CONNECTIVITY", -"CLIENT_CLOUD_WEB", -"CLIENT_RECORDING_CONSENT", -"CLIENT_DV3_FRONTEND", -"CLIENT_LENDING_DATA_MANAGER", -"CLIENT_CHROMEOS_DATA_FRESNEL", -"CLIENT_PPN", -"CLIENT_GEO_SEARCH_API", -"CLIENT_GOOGLE_ONE_SECURITY", -"CLIENT_GOOGLE_TV_LAVA", -"CLIENT_DYNAMITE_SERVER", -"CLIENT_BCE_CLIENT_CONNECTOR", -"CLIENT_DSE_REGULATORY_ANALYSIS", -"CLIENT_SEARCH_PINPOINT", -"CLIENT_CORPLOGIN", -"CLIENT_MONOSPACE", -"CLIENT_LIGHTER", -"CLIENT_P11", -"CLIENT_FIND_MY_DEVICE_WEB", -"CLIENT_YOUTUBE_TV", -"CLIENT_FITBIT_WEB", -"CLIENT_CHORD", -"CLIENT_FITBIT_FI", -"CLIENT_GOOGLE_ANALYTICS_SERVING", -"CLIENT_FONTS", -"CLIENT_ASSISTANT_BARD", -"CLIENT_NEST_GREENENERGY", -"CLIENT_DEEPMIND_LABS", -"CLIENT_ONE_PRESENCE", -"CLIENT_TRANSPARENCY_REPORT", -"CLIENT_GOOGLE_ONE_ML", -"CLIENT_GMP_PARTNER_GALLERY", -"CLIENT_MAKERSUITE", -"CLIENT_ADS_ADMANAGER_TOS", -"CLIENT_CHROME_REMOTE_DESKTOP", -"CLIENT_SOJI", -"CLIENT_WORKSPACE_LABS_SIGNUP", -"CLIENT_AIDA", -"CLIENT_TSP", -"CLIENT_AI_SANDBOX", -"CLIENT_LABS_TAILWIND", -"CLIENT_GMAIL_TASK_ASSIST", -"CLIENT_PIXEL_WEATHER", -"CLIENT_GPAY_CATEGORY_BILLERS", -"CLIENT_SUPPORT_CHANNELS_ZENDESK_WHATSAPP", -"CLIENT_PAYMENTS_TRANSACTION_MONITORING", -"CLIENT_DISCOVER_QUERY_RECOMMENDATIONS", -"CLIENT_COMMUNICATION_PREFERENCE_CENTER", -"CLIENT_PLAY_CONSOLE_DEVELOPER_IDENTITY_AND_ACCOUNTS", -"CLIENT_GNP_ONLINE_EVALUATION", -"CLIENT_LOCAL_SUGGESTED_SETS_DEMO_SERVER", -"CLIENT_SEARCH_LABS", -"CLIENT_CROWDSOURCE", -"CLIENT_TARSIER", -"CLIENT_WORKSPACE_SIDEKICK", -"CLIENT_GOOGLE_PHOTOS_REMINISCING", -"CLIENT_GEOX_CONTAMINATION", -"CLIENT_CLOUD_MESSAGE_STORE", -"CLIENT_IP_PROTECTION", -"CLIENT_SEARCH_HAMSA", -"CLIENT_ACCOUNT_LOCATION", -"CLIENT_ANDROID_BACKUP_AND_RESTORE", -"CLIENT_ADS_AWSM", -"CLIENT_STARGATE", -"CLIENT_ACCOUNT_MANAGEMENT", -"CLIENT_USER_ACCOUNT_CREATION", -"CLIENT_NETSENSE", -"CLIENT_FITBIT_LABS", -"CLIENT_LOCAL_SERVICES", -"CLIENT_USER_FEEDBACK_SERVICE", -"CLIENT_BARD_EVAL", -"CLIENT_SCENARIO_BASED_SEEDING_HOME_WORK", -"CLIENT_ACCOUNT_INTEGRITY_FEATURE_API", -"CLIENT_LABS_BETTANY", -"CLIENT_NECO_GENESIS", -"CLIENT_FITBIT_CAPABILITIES", -"CLIENT_ADS_MARKETING_AUTOMATION", -"CLIENT_ANDROID_TELEMETRY_WESTWORLD", -"CLIENT_DSPM_DETECTIVE_CONTROLS", -"CLIENT_CAA_INSIGHTS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK", -"CLIENT_GWS_TLD_MOBILE_GAIA", -"CLIENT_GWS_TLD_DESKTOP_GAIA", -"CLIENT_GWS_TLD_NON_PERSONALIZED", -"CLIENT_GWS_HOMEPAGE", -"CLIENT_ADS_DESKTOP_ZWIEBACK", -"CLIENT_ADS_DESKTOP_GAIA", -"CLIENT_ADS_MOBILE_ZWIEBACK", -"CLIENT_ADS_MOBILE_GAIA", -"CLIENT_ADS_NON_PERSONALIZED", -"CLIENT_ADS_TLD_NON_PERSONALIZED", -"CLIENT_ADS_EOM", -"CLIENT_ADS_TLD_EOM", -"CLIENT_ADS_ADMANAGER_SIGNUP", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK", -"CLIENT_GWS_NONTLD_MOBILE_GAIA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_EXP", -"CLIENT_GWS_TLD_DESKTOP_GAIA_EXP", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_EXP", -"CLIENT_GWS_TLD_MOBILE_GAIA_EXP", -"CLIENT_ADS_DESKTOP_ZWIEBACK_EXP", -"CLIENT_ADS_DESKTOP_GAIA_EXP", -"CLIENT_ADS_MOBILE_ZWIEBACK_EXP", -"CLIENT_ADS_MOBILE_GAIA_EXP", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_EXP", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_EXP", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_EXP", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_EXP", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_EXP", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_EXP", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_EXP", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_EXP", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ANDROMEDA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ANDROMEDA", -"CLIENT_GWS_TLD_MOBILE_GAIA_ANDROMEDA", -"CLIENT_GWS_TLD_DESKTOP_GAIA_ANDROMEDA", -"CLIENT_ADS_DESKTOP_ZWIEBACK_ANDROMEDA", -"CLIENT_ADS_MOBILE_ZWIEBACK_ANDROMEDA", -"CLIENT_ADS_DESKTOP_GAIA_ANDROMEDA", -"CLIENT_ADS_MOBILE_GAIA_ANDROMEDA", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ANDROMEDA", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_ANDROMEDA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ANDROMEDA", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_ANDROMEDA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ANDROMEDA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ANDROMEDA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ANDROMEDA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ANDROMEDA", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_BOOTES", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_BOOTES", -"CLIENT_GWS_TLD_MOBILE_GAIA_BOOTES", -"CLIENT_GWS_TLD_DESKTOP_GAIA_BOOTES", -"CLIENT_ADS_DESKTOP_ZWIEBACK_BOOTES", -"CLIENT_ADS_MOBILE_ZWIEBACK_BOOTES", -"CLIENT_ADS_DESKTOP_GAIA_BOOTES", -"CLIENT_ADS_MOBILE_GAIA_BOOTES", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_BOOTES", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_BOOTES", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_BOOTES", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_BOOTES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_BOOTES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_BOOTES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_BOOTES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_BOOTES", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_CASSIOPEIA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_CASSIOPEIA", -"CLIENT_GWS_TLD_MOBILE_GAIA_CASSIOPEIA", -"CLIENT_GWS_TLD_DESKTOP_GAIA_CASSIOPEIA", -"CLIENT_ADS_DESKTOP_ZWIEBACK_CASSIOPEIA", -"CLIENT_ADS_MOBILE_ZWIEBACK_CASSIOPEIA", -"CLIENT_ADS_DESKTOP_GAIA_CASSIOPEIA", -"CLIENT_ADS_MOBILE_GAIA_CASSIOPEIA", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_CASSIOPEIA", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_CASSIOPEIA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_CASSIOPEIA", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_CASSIOPEIA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_CASSIOPEIA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_CASSIOPEIA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_CASSIOPEIA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_CASSIOPEIA", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_DELPHINUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_DELPHINUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_DELPHINUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_DELPHINUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_DELPHINUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_DELPHINUS", -"CLIENT_ADS_DESKTOP_GAIA_DELPHINUS", -"CLIENT_ADS_MOBILE_GAIA_DELPHINUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_DELPHINUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_DELPHINUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_DELPHINUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_DELPHINUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_DELPHINUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_DELPHINUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_DELPHINUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_DELPHINUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ERIDANUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ERIDANUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_ERIDANUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_ERIDANUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_ERIDANUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_ERIDANUS", -"CLIENT_ADS_DESKTOP_GAIA_ERIDANUS", -"CLIENT_ADS_MOBILE_GAIA_ERIDANUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ERIDANUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_ERIDANUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ERIDANUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_ERIDANUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ERIDANUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ERIDANUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ERIDANUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ERIDANUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_FOMAX", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_FOMAX", -"CLIENT_GWS_TLD_MOBILE_GAIA_FOMAX", -"CLIENT_GWS_TLD_DESKTOP_GAIA_FOMAX", -"CLIENT_ADS_DESKTOP_ZWIEBACK_FOMAX", -"CLIENT_ADS_MOBILE_ZWIEBACK_FOMAX", -"CLIENT_ADS_DESKTOP_GAIA_FOMAX", -"CLIENT_ADS_MOBILE_GAIA_FOMAX", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_FOMAX", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_FOMAX", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_FOMAX", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_FOMAX", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_FOMAX", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_FOMAX", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_FOMAX", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_FOMAX", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_GEMINI", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_GEMINI", -"CLIENT_GWS_TLD_MOBILE_GAIA_GEMINI", -"CLIENT_GWS_TLD_DESKTOP_GAIA_GEMINI", -"CLIENT_ADS_DESKTOP_ZWIEBACK_GEMINI", -"CLIENT_ADS_MOBILE_ZWIEBACK_GEMINI", -"CLIENT_ADS_DESKTOP_GAIA_GEMINI", -"CLIENT_ADS_MOBILE_GAIA_GEMINI", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_GEMINI", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_GEMINI", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_GEMINI", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_GEMINI", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_GEMINI", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_GEMINI", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_GEMINI", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_GEMINI", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_HERCULES", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_HERCULES", -"CLIENT_GWS_TLD_MOBILE_GAIA_HERCULES", -"CLIENT_GWS_TLD_DESKTOP_GAIA_HERCULES", -"CLIENT_ADS_DESKTOP_ZWIEBACK_HERCULES", -"CLIENT_ADS_MOBILE_ZWIEBACK_HERCULES", -"CLIENT_ADS_DESKTOP_GAIA_HERCULES", -"CLIENT_ADS_MOBILE_GAIA_HERCULES", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_HERCULES", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_HERCULES", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_HERCULES", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_HERCULES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_HERCULES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_HERCULES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_HERCULES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_HERCULES", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_INDUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_INDUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_INDUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_INDUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_INDUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_INDUS", -"CLIENT_ADS_DESKTOP_GAIA_INDUS", -"CLIENT_ADS_MOBILE_GAIA_INDUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_INDUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_INDUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_INDUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_INDUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_INDUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_INDUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_INDUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_INDUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_LEO", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_LEO", -"CLIENT_GWS_TLD_MOBILE_GAIA_LEO", -"CLIENT_GWS_TLD_DESKTOP_GAIA_LEO", -"CLIENT_ADS_DESKTOP_ZWIEBACK_LEO", -"CLIENT_ADS_MOBILE_ZWIEBACK_LEO", -"CLIENT_ADS_DESKTOP_GAIA_LEO", -"CLIENT_ADS_MOBILE_GAIA_LEO", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_LEO", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_LEO", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_LEO", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_LEO", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_LEO", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_LEO", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_LEO", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_LEO", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_MENSA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_MENSA", -"CLIENT_GWS_TLD_MOBILE_GAIA_MENSA", -"CLIENT_GWS_TLD_DESKTOP_GAIA_MENSA", -"CLIENT_ADS_DESKTOP_ZWIEBACK_MENSA", -"CLIENT_ADS_MOBILE_ZWIEBACK_MENSA", -"CLIENT_ADS_DESKTOP_GAIA_MENSA", -"CLIENT_ADS_MOBILE_GAIA_MENSA", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_MENSA", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_MENSA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_MENSA", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_MENSA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_MENSA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_MENSA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_MENSA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_MENSA", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_NORMA", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_NORMA", -"CLIENT_GWS_TLD_MOBILE_GAIA_NORMA", -"CLIENT_GWS_TLD_DESKTOP_GAIA_NORMA", -"CLIENT_ADS_DESKTOP_ZWIEBACK_NORMA", -"CLIENT_ADS_MOBILE_ZWIEBACK_NORMA", -"CLIENT_ADS_DESKTOP_GAIA_NORMA", -"CLIENT_ADS_MOBILE_GAIA_NORMA", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_NORMA", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_NORMA", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_NORMA", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_NORMA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_NORMA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_NORMA", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_NORMA", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_NORMA", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_ORION", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_ORION", -"CLIENT_GWS_TLD_MOBILE_GAIA_ORION", -"CLIENT_GWS_TLD_DESKTOP_GAIA_ORION", -"CLIENT_ADS_DESKTOP_ZWIEBACK_ORION", -"CLIENT_ADS_MOBILE_ZWIEBACK_ORION", -"CLIENT_ADS_DESKTOP_GAIA_ORION", -"CLIENT_ADS_MOBILE_GAIA_ORION", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_ORION", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_ORION", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_ORION", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_ORION", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_ORION", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_ORION", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_ORION", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_ORION", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_PISCES", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_PISCES", -"CLIENT_GWS_TLD_MOBILE_GAIA_PISCES", -"CLIENT_GWS_TLD_DESKTOP_GAIA_PISCES", -"CLIENT_ADS_DESKTOP_ZWIEBACK_PISCES", -"CLIENT_ADS_MOBILE_ZWIEBACK_PISCES", -"CLIENT_ADS_DESKTOP_GAIA_PISCES", -"CLIENT_ADS_MOBILE_GAIA_PISCES", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_PISCES", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_PISCES", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_PISCES", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_PISCES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_PISCES", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_PISCES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_PISCES", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_PISCES", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_RETICULUM", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_RETICULUM", -"CLIENT_GWS_TLD_MOBILE_GAIA_RETICULUM", -"CLIENT_GWS_TLD_DESKTOP_GAIA_RETICULUM", -"CLIENT_ADS_DESKTOP_ZWIEBACK_RETICULUM", -"CLIENT_ADS_MOBILE_ZWIEBACK_RETICULUM", -"CLIENT_ADS_DESKTOP_GAIA_RETICULUM", -"CLIENT_ADS_MOBILE_GAIA_RETICULUM", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_RETICULUM", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_RETICULUM", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_RETICULUM", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_RETICULUM", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_RETICULUM", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_RETICULUM", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_RETICULUM", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_RETICULUM", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_SAGITTARIUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_SAGITTARIUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_SAGITTARIUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_SAGITTARIUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_SAGITTARIUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_SAGITTARIUS", -"CLIENT_ADS_DESKTOP_GAIA_SAGITTARIUS", -"CLIENT_ADS_MOBILE_GAIA_SAGITTARIUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_SAGITTARIUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_SAGITTARIUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_SAGITTARIUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_SAGITTARIUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_SAGITTARIUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_SAGITTARIUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_SAGITTARIUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_SAGITTARIUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_TAURUS", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_TAURUS", -"CLIENT_GWS_TLD_MOBILE_GAIA_TAURUS", -"CLIENT_GWS_TLD_DESKTOP_GAIA_TAURUS", -"CLIENT_ADS_DESKTOP_ZWIEBACK_TAURUS", -"CLIENT_ADS_MOBILE_ZWIEBACK_TAURUS", -"CLIENT_ADS_DESKTOP_GAIA_TAURUS", -"CLIENT_ADS_MOBILE_GAIA_TAURUS", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_TAURUS", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_TAURUS", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_TAURUS", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_TAURUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_TAURUS", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_TAURUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_TAURUS", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_TAURUS", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_URSA_MAJOR", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_URSA_MAJOR", -"CLIENT_GWS_TLD_MOBILE_GAIA_URSA_MAJOR", -"CLIENT_GWS_TLD_DESKTOP_GAIA_URSA_MAJOR", -"CLIENT_ADS_DESKTOP_ZWIEBACK_URSA_MAJOR", -"CLIENT_ADS_MOBILE_ZWIEBACK_URSA_MAJOR", -"CLIENT_ADS_DESKTOP_GAIA_URSA_MAJOR", -"CLIENT_ADS_MOBILE_GAIA_URSA_MAJOR", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_URSA_MAJOR", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_URSA_MAJOR", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_URSA_MAJOR", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_URSA_MAJOR", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_URSA_MAJOR", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_URSA_MAJOR", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_URSA_MAJOR", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_URSA_MAJOR", -"CLIENT_GWS_TLD_MOBILE_ZWIEBACK_VIRGO", -"CLIENT_GWS_TLD_DESKTOP_ZWIEBACK_VIRGO", -"CLIENT_GWS_TLD_MOBILE_GAIA_VIRGO", -"CLIENT_GWS_TLD_DESKTOP_GAIA_VIRGO", -"CLIENT_ADS_DESKTOP_ZWIEBACK_VIRGO", -"CLIENT_ADS_MOBILE_ZWIEBACK_VIRGO", -"CLIENT_ADS_DESKTOP_GAIA_VIRGO", -"CLIENT_ADS_MOBILE_GAIA_VIRGO", -"CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK_VIRGO", -"CLIENT_GWS_NONTLD_DESKTOP_GAIA_VIRGO", -"CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK_VIRGO", -"CLIENT_GWS_NONTLD_MOBILE_GAIA_VIRGO", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_ZWIEBACK_VIRGO", -"CLIENT_ASSISTANT_NONTLD_DESKTOP_GAIA_VIRGO", -"CLIENT_ASSISTANT_NONTLD_MOBILE_ZWIEBACK_VIRGO", -"CLIENT_ASSISTANT_NONTLD_MOBILE_GAIA_VIRGO", -"CLIENT_LOGGED_CONTEXT", -"CLIENT_IPGEO_REGION", -"CLIENT_IPGEO_EVAL", -"CLIENT_GWS_TACTILE_INITIAL_VIEWPORT", -"CLIENT_GWS_MAPS_DESKTOP", -"CLIENT_GWS_MAPS_MOBILE", -"CLIENT_GWS_GMM_LOCATION_SHIFT", -"CLIENT_GWS_NONTLD_MAPS_DESKTOP_GAIA", -"CLIENT_GWS_NONTLD_MAPS_DESKTOP_ZWIEBACK", -"CLIENT_GWS_TLD_MAPS_DESKTOP_GAIA", -"CLIENT_GWS_TLD_MAPS_DESKTOP_ZWIEBACK", -"CLIENT_GWS_TLD_MAPS_MOBILE_GAIA", -"CLIENT_GWS_TLD_MAPS_MOBILE_ZWIEBACK", -"CLIENT_GWS_NONTLD_MAPS_DESKTOP_EXPERIMENTAL", -"CLIENT_GWS_NONTLD_MAPS_MOBILE_EXPERIMENTAL", -"CLIENT_SESSIONS", -"CLIENT_MANUAL", -"CLIENT_NONTLD_DEFAULT", -"CLIENT_NO_LOCATION", -"CLIENT_ONLY_LEGAL", -"CLIENT_TESTING", -"CLIENT_COARSEN_ALL_TESTING", -"CLIENT_GWS_TLD_DESKTOP_ORACLE", -"CLIENT_GWS_TLD_MOBILE_ORACLE", -"CLIENT_GWS_NONTLD_DESKTOP_ORACLE", -"CLIENT_GWS_NONTLD_MOBILE_ORACLE", -"CLIENT_COMPARE_DL", -"CLIENT_COMPARE_IP", -"CLIENT_COMPARE_IPDL", -"CLIENT_MAGICEYE_DIMENSIONS", -"CLIENT_MAPS_GUIDE_DIRECTIONS", -"CLIENT_SAFE_BROWSING", -"CLIENT_GWS_NONTLD_DESKTOP", -"CLIENT_GWS_NONTLD_MOBILE" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true -], -"enumDescriptions": [ -"Unset client ID. Never use it in production code.", -"Curio team (go/curio). Contact: curio-team@.", -"OneGoogle Service (OGS): OGS will fetch the LocationContext for the frontends that have not talked to LES yet.", -"Client id used by evaluation tools. Contact: davidreis@", -"Same as CLIENT_EVALS, but less strict, so can be used to avoid a hack when some use cases needed to send the request twice with different client ID. Contact: bohdant@", -"Client id used by go/unified-query-sourcing. Contact: query-sampling-team@", -"Client id used by Play Books. Contact: ocean-team@", -"Client id used by Bond team. Contact: sterman@ and/or id-devices-eng@", -"Client id used by Chrome User Metrics Analysis (UMA, go/chrome-data)", -"Client id used by DoubleClick Search. Contact: wdtseng@, ds3data@, go/ds", -"Client id used by youtube QoE frontend. Contact: pfish@, kathyqian@, qoe-team@", -"Client id used by youtube Real-Time QoE. Contact: jeffcohen@, tnavien@, qoe-team@", -"Client id used by youtube QoE Livyatan. Contact: kathyqian@, gaozhiquan@, qoe-team@", -"Client id used by YouTube serving frontend and shared by all downstreams of the frontend server. Contact: tubbs@, yt-serving-platform@", -"Client ids used by YouTube Shorts. See go/oolong-changes-for-yt-le for details.", -"", -"", -"", -"Client ids used by Youtube Viral.", -"", -"", -"", -"", -"Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", -"", -"", -"", -"Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", -"", -"", -"", -"Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", -"", -"", -"", -"Client ids used by Youtube Viral Experiments. See go/ul-experimental-slots for description.", -"", -"", -"", -"Client id used by YouTube admin review tools. Contact: yurt-eng@", -"Client id used by YouTube Bad Harvest (go/badharvest). Contact: bad-harvest-eng@", -"Client id used by the speech team. Contact: xuedong@", -"Client id used by Gmail team. Contact: shine@, lianglin@", -"Client id used by Gmail/Spam. Contact: gmail-spam-eng@", -"Client id used by chromecast web interface. Contact: pierred@, bquinlan@, eureka-team@", -"Defaults to NONTLD_DEFAULT Contact: jamesjw@, pancetta-eng@", -"Client id used by GLS (Google Location Server) Contact: lmohanan@, tsuwei@, lbs-team@", -"Contact: feedback-eng@", -"Client id used by Android Metrics team. Contact: androidmetrics-eng@", -"Client id used by AdWords Usermgmt (go/usermgmt). Contact: timthom@, ads-usermgmt-eng@", -"Client id used by appremoting VM management stack which is further used by Looking Glass and Developer Shell products. Contact: looking-glass-team@, hekate-eng@.", -"Client id used by the login protections server. (go/hijacking) Contact: hijacking-eng@, danmogo@.", -"Client id used by Actionable IPs. (go/actionable-ips). Contact: amirha@, ncmec-actionableips-eng@.", -"Client id used by Display Ads. Contact: local-display@.", -"CLIENT_DISPLAY_ADS_DEFAULT is the same as CLIENT_DISPLAY_ADS, but excludes postal code trimming. This client is used to make the ProcessLocationContext call.", -"", -"", -"", -"", -"Client id used by Display Ads Preview Service. Contact: fletch-eng@.", -"Client id used by Hobbes(go/hobbes). Contact: hobbes-team@google.com", -"Client id used by Newsstand(go/dots). Contact: gnews-infra@.", -"", -"Client id used by Panoptic (News Ranking + Backend) Contact: polynews-eng@.", -"Client id used by Google Docs. Contact: doplar-eng@, jameshong@", -"Client id used by AdWords Express. Contact: boost-eng@, stephenleung@", -"Client id used by TraceDepot server. Contact: tibrewal@, kjs@", -"Client id used by MapsPro Contact: obrien@, jiazheng@", -"Client id used by Madden (go/madden) Contact: madden-eng@", -"Client id used by AccessFilter Contact: ishwarya@", -"Client id used by Google Domains (go/domain-registrar) Contact: domain-registrar-eng@", -"Client id used by Google Assistant (go/opa) Contact: assistant-infra-core@", -"", -"Client id user by Google Account Linking (go/account-linking) Contact: account-linking-team@", -"Client id used by Legal Removals. Contact: legal-removals-eng@", -"Client id used by Cloud Console (Pantheon) Contact: paninfra-sfo@.", -"Client id used by Cloud New User for Free Trial Contact: coe-nu-eng@", -"Client id used by Solutions Catalog Contact: coe-solutions@", -"Client id used by cloud media access team, go/cloud-media-access Contact: cloud-media-access-team@", -"Client id used by Dotorg G4NP Contact: g4np-eng@", -"Client id used by Crash Internal Contact: crash-team@", -"Client id used by Monlog in access/infrastructure Contact: monlog-eng@", -"Client id used by GoogleVoice Contact: voice-eng@", -"Client id used by Blogger Contact: blogger-tech@, eitzenb@", -"Thor/Google Meet backend. Contact: comms-work-backend-team@.", -"Client id used by News Contact: news-frontend-eng-team@.", -"Client id used by Google Photos", -"Client id used by Google Photos for inferred location tagging.", -"Client id used by RankBrain Debug (go/rankbrain-debug).", -"Client id used by Heterodyne (go/heterodyne) Contact: ph-eng@", -"Client id used by fraudreview (go/fraudreview) Contact: pf-review-tools@", -"Client id used by Jamboard (go/jamboard) for go/jamboard-scheduled-otas Contact: jamboard-eng@", -"Client id used by Marconi (go/marconi) Contact: marconi-eng@", -"Client id used by Aart (go/aart-docs) Contact: aart-team@", -"Client id used by the Google Arts And Culture (go/artsandculture) Contact: ci-eng@", -"Client id used by Youtube Ecommerce (go/ypc) Contact: ytr-eng@", -"Client id used by Ares managed feature providers (go/project-ares) Contact: ares-eng@", -"Client id used by LIS and the UUDE framework (go/uude) Contact: lis-eng@", -"Client id used by Google Store smashberry (go/smashberry) Contact: smashberry-eng@", -"Client id used by Dasher Auditing (go/dasher-auditing) Contact: dasher-auditing-eng@", -"Client id used by the Shopping List Server (go/shopping-list-server) Contact: shoppinglist-eng@", -"Client ID used by the Drive Item Suggest service (go/itemsuggest)", -"Client ID used by Smart Books (go/smart-books) Contact: smart-books-team@", -"Client ID used by GRADS (go/grads)", -"Client ID used by AdsRoot (go/adsroot)", -"Client ID used by Service Engine (go/seroot)", -"Client ID used by Orbit (go/ytorbit)", -"Client ID used by Project Fi (nova). This client was initially created for Nova aperture (go/aperture) but all Nova clients are recommended to use this one.", -"Client ID used by Lena Signup Defaults (go/lena-prd)", -"Client ID used by the Play Console (go/fc) Contact: play-dev-console-platform@", -"Client ID used by Finsky Enterprise (go/pfw)", -"Client ID used by Google Admin (go/google-admin)", -"Client ID used by CryptAuth (go/cryptauth, go/authzen-pdd, go/gnubby-pdd)", -"Client ID used by the GsaUniversalServer (go/gus)", -"Client ID used by the TravelFrontendTransitServer web app.", -"Client ID used by Home Cloud services (go/home-cloud)", -"Client ID used by Google Shopping Express (go/gsx)", -"Client ID used by Google Duo (go/duo)", -"Client ID used by Gaia Frontend (go/gaiafe)", -"Client ID used by Android Messages (go/bugle)", -"Client ID used by Google Lens (go/lens) Contact: lens-frontend-server-eng@", -"Client ID used by Chrome Web Store (go/cws)", -"Client ID used by Actions on Google console (go/aog-console) Contact: actions-on-google-console-eng@", -"Client ID used by Android TV Channels (go/android-tv-channels)", -"Client ID used by Assistant Web Settings (go/assistant-settings-web-ui-design)", -"Client ID used by Play User Data Server (go/play-user-data-server)", -"Client ID used by Ads Integrity (go/ads-integrity) Contact: ads-integrity-risk@", -"Client ID used by Ragnarok (go/ragnarok) Contact: ads-integrity-wat@", -"Client ID used by Firebase Console (go/fireconsole) Contact: fireconsole-contrib@", -"Client ID used by AoG Feed Validator (http://go/aog-feed-validator)", -"Client ID used by Plumeria (go/plumeria-legal-eng-intro) Contact: plumeria-eng@", -"Client ID used by Paisa (http://go/paisa) Contact: paisa-eng@", -"Client ID used by Google Pay (go/googlepay)", -"Client ID used by the Google Pay web serving stack.", -"Client ID used by Google Wallet (go/wallet)", -"Client ID used by Scroogled (go/scroogled). Contact: hijacking-team@.", -"Client ID used by Waymo ride-hailing services. Client referenced in a silo: waymo/taas/frontend3/handlers/test_base.cc Contact: taas-offboard@, chauffeur-hailing@", -"Client ID used by CROW team. Contact: crow-team@", -"Client ID used by the Security Investigation Tool of GSuite Security Center(go/security-investigation-tool). Contact: gsc-sit-eng@", -"Client ID used by the Event Threat Detection team (go/etd). Contact: etd-team@", -"Client ID used by Play Location Server (go/play-location-server). Contact: play-experiment-team@", -"Client ID used by Footplacer (go/footplacer). Contact: footplacer-eng@", -"used by dasher commerce team (go/acom) Contact: dasher-commerce-eng@", -"Client ID used by Social People Analytics (go/spa-docs). Contact: social-people-analytics@", -"Client ID used by Contacts UI surfaces (go/web-contacts). Contact: contactsplus-eng@, custard-eng@", -"Client ID used by Google Analytics (go/gafe4). Contact: gafe4-eng+code@", -"Client ID used by Places API (go/places-api). Contact: geo-enterprise-metrics@", -"", -"Client ID used by Drive Web Frontend. Contact: drive-frontend-eng@", -"Client ID used by Android OTA (go/android-ota). Contact: android-auto-ota-dev@", -"Clients of nearby stores. Contact: payments-microapps-pek-team@", -"Clients used by Fiber Address Service (gfiber-weaver-infra-team@).", -"Client ID used by Support Content (go/supportcontent) Contact: support-content-eng@", -"Logging anonymization for Offroad (GMM offline) search/suggest.", -"Client id used by Google Ads Change History (go/ch). Contact: leonxie@, kluo@, ch-dev@", -"Client ID used by Session Risk (go/session-risk). Contact: session-protection-eng@", -"Client ID used by Alps (go/alps). Contact: address-understanding-team@", -"Client ID used by discover for resolving locations according to the user's news preferences. Contact: newsx@", -"Client Id for Assistant Snapshot.", -"Client ID used by Area 120 Honeycomb (go/honeycomb) Contact: honeycomb-eng@", -"Client ID used by Play Monetary Abuse service to detect location abuse. Contact: play-monetary-abuse@", -"Client ID used by Small Business Advisors (GMB Assisted Activation). Contact: gmb-assisted-activation@", -"Client ID used by GPA Feeds Ingestion. Contact: gpa-feeds-eng@", -"Client ID used by EDU originality reports (go/plagiarism). Contact: plagiarism-eng@", -"Client ID used by Paidtasks to grab user ipgeo information. Contact: 402-eng@", -"Client ID used by Translate for country level IPGeo. Contact: website-translation-team@", -"Client ID used by Funding Choices to determine the legal jurisdiction that a user belongs to, for example, GDPR (EEA) or CCPA (California), etc. More information: go/funding-choices Contact: oncall/xads, funding-choices-eng-core@", -"Client ID used by Search Notifications (go/sno). Contact: now-push-eng-team@", -"Client ID used by Visual Semantic Service (go/vss). Contact: vss-team@", -"Client ID used by the Chrome Prefetch Proxy (go/chrome-p4)", -"Wear OS clients Contact: wear-lon-backend@", -"Client ID used by Payments Risk (go/risk-eng) Contact: payments-risk-team@", -"Client ID used by Payments Orchestration/Orchestration2 server (go/o2) Contact: payments-orchestration-eng@", -"Client ID used by Android TV IRDB (go/sabrina-irdb-service) Contact: project-axel-eng@", -"Client ID used by Trends (go/trends-eng) Contact: trends@", -"Client ID used by Colab (go/colab) Contact: colab-team@", -"Client ID for Socratic (go/bloom) Contact: bloom-edu-eng@", -"Client ID for go/ps1-location Contact: location-infra@", -"Client ID for DDM Reporting Processing go/proc Contact: ddm-reporting-stateless@", -"Client ID for go/hr-be Contact: homeroom-backend@", -"Client ID for cars categorical Contact: cars-eng@", -"Client ID used by Gpay MerchantVerticals VerticalsDiscoveryService go/vertical-discovery Contact: merchant-verticals-discovery-eng@", -"Client ID used by reCAPTCHA's Account Protections team. Shared ID used by both Account Defender and SMS Fraud Detection services. go/recaptcha-account-defender-u-bad Contact: recaptcha-account-protections@", -"Client ID used by reCAPTCHA Lite. go/recaptcha-asn-reputation-design-doc Contact: recaptcha-waf-eng@", -"Client ID used by reCAPTCHA Fraud Prevention. go/recaptcha-fraud-geocoding Contact: recatpcha-fraud@", -"Client ID used by AutoNT DNS mapchecker module. go/autont Contact: autont-team@", -"Client ID used by Transparency for All Ads Report. go/tfaar Contact: tfaa-report-eng@", -"Client ID used by GCIP Location Service. go/cicp-team Contact: cicp-eng@", -"Client ID used by OneStack Metric Collection service.", -"Client ID used by GPay Transit TapAndPay Frontend Service go/transit-recommended-agencies Contact: tp2-transit-eng@", -"Client ID used by Chronicle Security (go/malachite). go/chronicle:theres-waldo Contact: malachite-dip-engg@ Contact: malachite-eng@", -"Client ID used by the UI for Chronicle Security (go/malachite). go/chronicle-i18n-design Contact: chronicle-ui@ Contact: malachite-eng@", -"Client ID used by GPay Merchant Spot Onboarding Tool (b/186640782). Contact: gtech-google-pay-food-fte@ Contact: edisonc@", -"Client ID used by Ads scraping tool owned by Ads ExpandedMatch. go/ads-scraping-tool Contact: ads-expmatch-eng@", -"Client ID for cloud support portal frontend go/xpp-lite Contact: xpp-eng@", -"Client ID used by the LaMDA team. Contact: srrvnn@, lamda-team@ // NOTYPO NOTYPO", -"Client ID used by Pinpoint (go/jsuite-pinpoint) Contact: backlight-eng@", -"Client ID used by Google Shopping Order History (go/shopping-order-history)", -"Client ID used by Nest camera cloud team contact: nest-camera-cloud@google.com", -"Client ID used by Panoptic SxS contact: yukang@, deepakverma@, local-fcr@google.com", -"Client ID used for About This Page external API. contact: beaton, diner-team@, go/project-diner", -"Client ID used for the Photos Analytics marketing pipeline. contact: guillo, photos-analytics@", -"Client ID for the gmscompliance server (UDEVS) contact: gmscore-trust-team@google.com", -"Client ID for Analytics Collection contact: tag-serving-eng@, go/tag-serving", -"Client ID for play console android vitals contact: play-dev-quality-all@google.com", -"Client ID for crashlytics play console crashes contact: play-dev-quality-all@google.com", -"Client ID for Payments Merchant Stories contact: merry-eng@, go/merry", -"Client ID for Cloudtop Connectivity contact: cloudtop-eng@, go/cloudtop", -"Client ID for Cloud Web (cloud.google.com) contact: cloudx-platform-eng@", -"Client for go/speakeasy-meet-consent-frontend Contact: ccp-pegasus@", -"Client for Display & Video 360 (DV3, Xbid) frontend. Contact: qypeng@, xbid-fe-eng@", -"Client for lending data manager. Contact: nest-data-infra-eng@", -"Client for ChromeOS Data Fresnel service. Contact: chromeos-data-eng@", -"Client for PPN team to provide VPN service.", -"Client ID used by Geo API Platform (go/geo:api). Contact: geo-apis-platform@", -"Client for Google One security to access Oolong data. Contact: g1-security-eng@", -"Client ID used by the Google TV Web player (go/lava) Contact: lava-eng@", -"Client ID used by the dynamite server. Contact: dynamite-eng@", -"Client ID used by the bce-client-connector. Contact: bce-client-connector-eng@", -"Client ID used by go/rde team pipeline. Contact: rde-team@.", -"Client ID used by Pinpoint UI tools (go/pinpoint). Contact: pinpoint-team@", -"Client ID for Corplogin Contact: sso-team@", -"Client ID for Monospace (go/monospace) Contact: monospace-team@", -"Client ID used by the Lighter (go/lighter). Contact: lighter-backend-eng@", -"Client ID used by P11 (go/p11-eng) Contact: eleven-sw-eng@", -"Client ID used by the new Find My Device website. Contact: fmd-eng@", -"Client ID used by Youtube TV. Contact: ott-platform-serving", -"Client ID used by Fitbit WebAccounts Contact fitbit-uam@", -"Client ID used for Chord (go/chord-g3doc) Contact: chord-eng@", -"Client ID used by Fitbit-Fi Contact fdp-gallery@", -"Client ID used by Google-Analytics-Serving Contact ga-gold-query-engine@", -"Client ID used by Google Fonts Contact fonts-eng@", -"Client ID used by project Bard Contact bard-team@", -"Client ID used by Nest Renew (go/apollo-eng) Contact apollo-energy-eng@", -"Client ID used by DeepMind Labs Contact deepmind-goodall@", -"Client ID used by One Presence Profiles Contact mcf-profiles-eng-team@", -"Client ID used by Transparency Report (go/transparency-eng) Contact: transparency-report-leads@", -"Client for Google One ML team to access Oolong data. Contact: g1-ml-eng@", -"Client for GMP Partner Gallery team to access Oolong data. Contact: gmppartnergallery-team@", -"Client for MakerSuite. Contact: makersuite-team@", -"Client for Ad Manager ToS Contact: drx-fe-infra@", -"Client ID for Chrome Remote Desktop. contact: chromotin-eng-team@, go/chromoting", -"Client for OSLO Soji (go/soji). Contact: soji-team@", -"Client ID for Workspace labs signup page. Contact: workspace-labs-signup-eng@", -"Client AIDA Contact: aida-api-team@", -"Client ID for Trust Signals Platform Contact: trust-signals-eng@", -"Client Id for AI Test Kitchen Contact: ai-sandbox-eng@", -"Client Id for Labs Tailwind Contact: labs-tailwind-eng-team@", -"Client Id for Gmail Task Assist. Contact: task-assist-eng@", -"Client Id for Pixel Weather service. Contact: pixel-apps-weather-boq-team@", -"Client Id for GPay Geo-based category billers. (go/gpay-category-biller-suggestions-design-doc) Contact: nityam-eng@, gpay-server-infra@", -"Client Id for Support Channels WhatsApp Zendesk integration. (go/cecsi-whatsapp-dd) Contact: voice-channels-eng@", -"Client ID used by Payments Anti-Financial Crimes Transaction Monitoring pipeline to fetch country-level IPGeo information.", -"Client ID for the offline batch pipeline creating the Discover query recommendation corpus.", -"Client id used by Preference Center (go/preference-center). Contact: preference-center-eng@", -"Client ID used by Developer Identity and Accounts Contact: play-dev-dia-epu@google.com.", -"Client ID used by GNP Online Evaluation Contact: gnp-ginger-eng@google.com", -"Client ID used by local suggested sets demo server (go/local-sets-demo-server-dd) Contact: local-sets-quality@", -"Client ID used by Search Labs Contact: search-labs-frontend@google.com", -"Client ID for Crowdsource Contact: crowdsource-eng@google.com", -"Client ID for Tarsier Contact: tarsier-team@google.com", -"Client Id for WorkSpace SideKick. Contact: kopi-eng@", -"Client id used by Google Photos for reminising features.", -"Client Id for Geox contamination. Contact: amt-geox-core@", -"Client Id for CloudMessageStore. Contact:tachyon-backend-eng@", -"Client Id for IP Protection Contact: ip-protection-team@", -"Client Id for Search MCF Hamsa. Contact: search-mcf-hamsa@", -"Client Id for Account Location (go/accountlocation). Contact emmett-eng@google.com, compliance-signals-eng@google.com", -"Client Id for Android Backup & Restore (http://go/br-home). Contact android-backup-server-eng@google.com", -"Client Id for Google Ads AWSM. Contact awsm-eng@google.com", -"Client Id for Stargate satellite messaging. Contact dune-server-eng-team@google.com", -"Client Id for Account Management (go/ams). Contact account-management-eng@google.com, compliance-signals-eng@google.com.", -"Client Id for User Account Creation (go/id-eco-infra:account-creation). Contact account-ecosystem-infra-team@google.com, compliance-signals-eng@google.com.", -"Client Id for Netsense (go/netsense). Contact trapdoor-team@google.com,", -"Client ID used by Fitbit Labs (go/fitbit-labs). Contact fitbit-labs-eng@", -"Client ID used by Local Services Ads. Contact sab-eng@", -"Client ID used by the User Feedback Service (go/user-feedback-service). Contact ads-integrity-transparency-team@", -"Client ID used by Bard/Gemini evals to spoof location data. Contact bard-eval-infra@ This should only be used with spoofed location data. For real user data, follow the onboarding steps at go/use-current-location", -"Client ID used by the Scenario-based Seeding Home & Work seeder. Contact loki-prod@google.com", -"Client ID used by the ADI Feature API (go/adi-feature-api)", -"Client Id for Labs Bettany Contact: bettany-eng@", -"Client Id for neco-genesis Contact: neco-eng@", -"Client ID used by Fitbit Capabilities Service (go/fitbit-capabilities). Contact fitbit-app-platform@", -"Client ID for Ads Marketing Automation (go/ce-ama) Contact: ads-marketing-automation-eng@", -"Client ID for Android Telemetry Westworld Contact: android-telemetry-infra-server@", -"Client ID for Data Security Posture Management (DSPM) Detective Controls Contact: dspm-controls-eng@", -"Client ID for CAA Insights Contact: policy-decision-service-eng@", -"Gws. Contact: oolong-team@.", -"", -"", -"", -"", -"", -"Search Ads clients providing similar user location to Search.", -"", -"", -"", -"", -"", -"", -"", -"Ad manager user sign up location by IP address", -"Use these within GWS iff the project is not using TLD (e.g. www.google.ch).", -"", -"", -"", -"Client Ids for Assistant via Oolong Service.", -"", -"", -"", -"Gws tld experimental clients", -"", -"", -"", -"Ads experimental clients", -"", -"", -"", -"Gws nontld experimental clients", -"", -"", -"", -"Assistant experimental clients", -"", -"", -"", -"Clients for Andromeda experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Bootes experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Cassiopeia experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Delphinus experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Eridanus experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Fomax experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Gemini experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Hercules experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Indus experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Leo experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Mensa experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Norma experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Orion experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Pisces experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Reticulum experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Sagittarius experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Taurus experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Ursa Major experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Clients for Virgo experimental slot. See go/ul-experimental-slots for description.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Use for LoggedContext re-geocoding. Do not use for LocationContext processing.", -"Client useful for country level IPGeo. It accepts any country regardless of the confidence. Do not use this client for any location other than country. It can be used while migrating from legacy googledata/ipgeo index. Contact: oolong-team@.", -"Client similar to CLIENT_IPGEO_REGION, but adapted to IPGeo Eval purpose. Contact: ipgeo-team@.", -"Tactile initial viewport policy. Contact: oolong-team@ Note that maps clients don't adhere to TLD restrictions.", -"", -"", -"", -"Maps clients that use glassbox.", -"", -"", -"", -"", -"", -"Experimental maps clients.", -"", -"Session IP geocoding. Contact: oolong-team@.", -"Use this client ID if you are not using oolong legal/quality annotations. A sample usecase is reverse geocoding a set of lat/lngs or mids/featureids. NOTE: do not use oolong annotations if this client is set.", -"Default client to use when TLD restrictions are not applied. This policy can change without notice. If you care about particular quality assumptions, then create a custom client id. Contact: oolong-team@", -"Does NOT annotate anything with UNIQUE_SELECTED_FOR_USER_LOCATION", -"Client id that only applies legal annotations.", -"Use for testing only. Never use this in production.", -"", -"Used for oracle eval.", -"", -"", -"", -"Clients used to compare different location source combinations.", -"", -"", -"Client used for country field in Magic Eye dimensions (go/core-dimensions).", -"Used for the go/mapsguide directions prototype.", -"Deprecated clients SafeBrowsing Team. Contact: anov@.", -"Use CLIENT_GWS_NONTLD_DESKTOP_ZWIEBACK or _GAIA Contact oolong-team@", -"Use CLIENT_GWS_NONTLD_MOBILE_ZWIEBACK or _GAIA Contact oolong-team@" -], -"type": "string" -}, -"extractorFlags": { -"$ref": "LocationUnifiedExtractorFlags", -"description": "Flags to customize the extractors used to build this location context." -}, -"featurePool": { -"description": "The feature pool used in the location results. This is a map from feature ID to feature data, but since the feature ID is part of the Featurelet data, just a repeated field enumerating them is enough.", -"items": { -"$ref": "LocationUnifiedOolongFeature" -}, -"type": "array" -}, -"fromHulkRealtime": { -"description": "True if the location context originates from the Hulk Realtime plugin in GWS: go/hulk-realtime-in-search-ads.", -"type": "boolean" -}, -"lockStrategy": { -"description": "Defines which roles/producers can be added/edit for the context. This field is used only when locked_for_debug flag is set.", -"enum": [ -"NO_LOCKING", -"LOCK_ALL", -"LOCK_ALL_EXCEPT_EXPLICIT_IMMEDIATE_AND_DOMAIN" -], -"enumDescriptions": [ -"Strategy which allows changing all the results.", -"Strategy which does not allow changing any result.", -"Does not allow adding any results that are not role=QUERY, USER_SPECIFIED_FOR_REQUEST or VIEWPORT, OR role/producer = CURRENT_LOCATION/GOOGLE_HOST_DOMAIN." -], -"type": "string" -}, -"lockedForDebug": { -"description": "If true, only a selected list of descriptors will be added to this context by the standard library functions. This is so that debug parameters can be used to override the context reliably. The descriptors that can be added is determined by the lock_strategy enum. Note that policies may override and ignore this flag altogether.", -"type": "boolean" -}, -"lockedForPolicy": { -"description": "If true, the location context should be kept as is, no policy should modify it, except for: setting the client id and adding qref location.", -"type": "boolean" -}, -"nonstandardData": { -"$ref": "MessageSet" -}, -"origin": { -"$ref": "LocationUnifiedLocationContextOrigin", -"description": "Information about the origin of the location context. This is used to validate that the location context was created through a valid means, which is Oolong. DO NOT SET THIS FIELD YOURSELF. In fact, do not construct location contexts yourself." -}, -"results": { -"items": { -"$ref": "LocationUnifiedLocationResult" -}, -"type": "array" -} -}, -"type": "object" -}, -"LocationUnifiedLocationContextOrigin": { -"description": "This message stores information about how a location context was created. It is restricted in visibility to Oolong code only, so that it provides a way to easily identify location contexts that have been created from external code. (Which should NOT be done ever.) Next ID: 3", -"id": "LocationUnifiedLocationContextOrigin", -"properties": { -"dejitterModifications": { -"description": "Sequence of Dejitter modifications applied to the associated LocationContext. For monitoring and debugging use only; it should be safe to remove or change the contents of this field at any time.", -"items": { -"enum": [ -"DEJITTER_MODIFICATION_UNSPECIFIED", -"DEJITTER_REMOVED_IMPLICIT_LOCATION_RESULTS", -"DEJITTER_REMOVED_IMPLICIT_LOCATION_ANNOTATIONS", -"DEJITTER_REMOVED_IMPLICIT_SUBCOUNTRY_FEATURES" -], -"enumDescriptions": [ -"", -"", -"", -"" -], -"type": "string" -}, -"type": "array" -}, -"type": { -"description": "The origin of the LocationContext. May be updated by restricted Oolong libraries that modify the LocationContext after it was returned. Some Apps Framework services use this in their location propagation logic to decide whether a LocationContext is suitable for propagating to backends.", -"enum": [ -"INVALID_ORIGIN", -"TEST_UTILS", -"LES_PLC_CALL", -"OOLONG_WITH_CUSTOM_GEOCODER", -"LOCAL_SEARCH_LITE_OVERRIDE", -"OOLONG_SERVICE", -"QUALITY_BRAIN_OVERRIDE" -], -"enumDescriptions": [ -"Default value, which means no valid origin.", -"Constructed through LocationContextBuilder, for testing.", -"Created through a call to LES to one of the ProcessLocationContext* functions (Oolong interface).", -"Created through an ipgeo-only LES or other custom-geocoder-based Oolong interface.", -"Created from local_search_lite_context_util.h, by CreateOverriddenLocationContext.", -"Created by OolongService.", -"BRAIN override" -], -"type": "string" -} -}, -"type": "object" -}, -"LocationUnifiedLocationDescriptor": { -"description": "A LocationDescriptor is the minimal specification of a location together with its role and producer. The location \"payload\" can be specified by a variety of means (e.g., an address, an ip address, GPS coordinates, etc.) but only a single means should be used. DO NOT COMBINE MULTIPLE SPECIFICATIONS INTO A SINGLE DESCRIPTOR (e.g., a freeform street address and lat/long together). Next Id: 27", -"id": "LocationUnifiedLocationDescriptor", -"properties": { -"additionalFeatureId": { -"$ref": "LocationUnifiedFeatureIdProto", -"description": "A 128-bit feature consisting of an S2Cell and a unique feature identifier. Should be unused outside of the internal applications by the Oolong team." -}, -"attributes": { -"$ref": "LocationUnifiedLocationAttributesProto", -"description": "Supplemental attributes for a location that are not related to geocoding, but still may affect search results." -}, -"confidence": { -"description": "A confidence measure. Percentage: must be 0 to 100.", -"format": "int32", -"type": "integer" -}, -"diagnosticInfo": { -"description": "WARNING: Do not use this field without talking to the oolong-team@ first. It should never contain any Personal Identification Information (PII). You can use this field to provide diagnostic information about the location extraction code. Some examples could include the latency of getting the location, the fact that it was retrieved from the cache or not, the reason for not providing the location, software version (if that cannot be used to identify the user). Make sure to prepare a PDD that describes what is stored in this field for your project before using the field.", -"type": "string" -}, -"featureId": { -"$ref": "LocationUnifiedFeatureIdProto", -"description": "A 128-bit feature consisting of an S2Cell and a unique feature identifier." -}, -"historicalProducer": { -"description": "This field is intended for recording the producer of a historical location. It will be populated for a descriptor with role HISTORICAL_LOCATION, using the producer of the original descriptor. To enable location history to be sent via an untrusted source to a frontend, you should make sure that the historical_role-historical_producer pair of the descriptor also appears on the untrusted allowlist used by the frontend.", -"enum": [ -"UNKNOWN_PRODUCER", -"LOGGED_IN_USER_SPECIFIED", -"PREF_L_FIELD_ADDRESS", -"IP_ADDRESS", -"IP_ADDRESS_REALTIME", -"GOOGLE_HOST_DOMAIN", -"RQUERY", -"SQUERY", -"QUERY_LOCATION_OVERRIDE_PRODUCER", -"QREF", -"DEVICE_LOCATION", -"LEGACY_NEAR_PARAM", -"CARRIER_COUNTRY", -"JURISDICTION_COUNTRY", -"CLIENT_SPECIFIED_JURISDICTION_COUNTRY", -"DECODED_FROM_UNKNOWN_ROLE_PRODUCER", -"SHOWTIME_ONEBOX", -"LOCAL_UNIVERSAL", -"SEARCH_TOOLBELT", -"MOBILE_FE_HISTORY", -"GWS_MOBILE_HISTORY_ZWIEBACK", -"MOBILE_SELECTED", -"PARTNER", -"WEB_SEARCH_RESULTS_PAGE_SHARED", -"WEB_SEARCH_PREFERENCES_PAGE", -"MAPS_FRONTEND", -"PRODUCT_SEARCH_FRONTEND", -"ADS_CRITERIA_ID", -"MOBILE_APP", -"QUERY_HISTORY_INFERRED", -"QUERY_HISTORY_INFERRED_ALTERNATE", -"GMAIL_THEME", -"IGOOGLE", -"CALENDAR", -"SMS_SEARCH", -"LEGACY_GL_PARAM", -"LEGACY_PARTNER_GL_PARAM", -"LEGACY_GL_COOKIE", -"GWS_JURISDICTION_COUNTRY", -"CIRCULARS_FRONTEND", -"SHOPPING_SEARCH_API", -"OZ_FRONTEND", -"ADS_GEO_PARAM", -"ADS_PARTNER_GEO_PARAM", -"DEFAULT_LOCATION_OVERRIDE_PRODUCER", -"VIEWPORT_PARAMS", -"GAIA_LOCATION_HISTORY", -"STICKINESS_PARAMS", -"TURN_BY_TURN_NAVIGATION_REROUTE", -"SNAP_TO_PLACE_IMPLICIT", -"SNAP_TO_PLACE_EXPLICIT", -"HULK_USER_PLACES_CONFIRMED", -"HULK_USER_PLACES_INFERRED", -"TACTILE_NEARBY_PARAM", -"MAPS_ACTIVITY", -"IP_ADDRESS_ALTERNATE", -"DIRECTIONS_START_POINT", -"SEARCH_ALONG_ROUTE", -"SNAP_TO_ROUTE", -"GOOGLE_MY_BUSINESS", -"BAD_DEVICE_LOCATION", -"GMM_QUANTIZED_DEVICE_LOCATION", -"GWS_HISTORY_GAIA", -"CONTEXT_MANAGER_FORECAST", -"GMM_HEATMAP_AREA", -"NEWS", -"SHIPPING_ADDRESS", -"DEVICE_CONTEXT", -"TRAVEL_STATE_INTENT", -"HULK_ROUTINES", -"WILDCARD_PRODUCER", -"LEGACY_TOOLBAR_HEADER", -"LEGACY_MOBILE_FRONTEND_GLL", -"LEGACY_MOBILE_FRONTEND_NEAR", -"ABLATED_PRODUCER", -"OOLONG_REALTIME_CACHE", -"OOLONG_REALTIME_CACHE_ALTERNATE", -"DIRECTIONS_WAYPOINT", -"ADS_FINAL_VIEWPORT", -"SEARCH_REGION_SETTINGS_COUNTRY", -"ASSISTANT_DERIVED", -"OOLONG_DEFAULT_LOCATION", -"ADS_GLS_FINAL_VIEWPORT" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -true, -false, -false, -false, -false, -false, -false, -true, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors.", -"A location specified by a logged-in user (e.g., default location from Kansas). It is a freeform address string stored in loc.", -"The user-specified default location contained in the L-field of a browser's PREF cookie. It is a freeform address string stored in loc.", -"A location based on IP address. The IP address is stored in loc in dot-decimal (IPv4) or colon-hexadecimal (IPv6) format.", -"This is the location that is derived from the realtime ipgeo index. This is a fresh version of ipgeo index which is available for a small subset of IPs.", -"A location based on the domain of the Google server (e.g., google.co.uk) servicing the request. The domain name is stored in loc.", -"The descriptor is based on a raw query (free-form). The query text is stored in loc.", -"The descriptor is based on an squery and is stored as an squery in loc.", -"The descriptor contains a location as a raw query in loc. It is geocoded and used to override the geocoding of the QUERY/RQUERY or QUERY/SQUERY descriptor. Only to be used for debugging purposes.", -"This contains the location produced by qref module in qrewrite. Currently, the location is derived from the query and this will be only used with QUERY role.", -"A location that came from determining the physical location of a device (mobile, laptop, desktop, etc.) via means such as GPS, cell network, or Wifi. Always corresponds to CURRENT_LOCATION. The accuracy of the location may be stored in the radius and/or confidence fields. NOTE: By definition, these data do not include locations collected without the user's awareness and/or consent. Users on some Google services may be notified of and consent to Google's collection and use of geographical information.", -"The descriptor was generated by a legacy \"near\" param. It always corresponds to a USER_SPECIFIED_FOR_REQUEST. Occurrences should be replaced by Oolong-style parameters (e.g., muul/luul). Note that \"near\" params synthesized by Mobile Frontend from a lat/long are handled with LEGACY_MOBILE_FRONTEND_GLL.", -"The 2-letter ISO-3166-alpha2 code for the country of the mobile carrier of the request. Always corresponds to CURRENT_LOCATION, and is stored in the loc parameter. DEPRECATED(b/109727016). Use LocationAttributesProto.carrier_ip_type.", -"The descriptor was generated when mapping disputed areas to legally approved countries. It always corresponds to a DEFAULT_LOCATION role. It is used to geocode 2-letter ISO-3166-alpha2 country codes stored in the \"loc\" parameter.", -"The 2-letter ISO-3166-alpha2 code for the jurisdiction country specified by the Google application (e.g. GMM getting the country code directly from the simcard). Use the producer with role=DEFAULT_LOCATION.", -"The location was decoded from a uuld=l debug parameter based on anonymised Gaia logs that did not contain a role/producer pair.", -"The descriptor was generated by the Showtime (movies) Onebox.", -"A location used by any Local Search client (not just LU) to force a specific location interpretation. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"This descriptor by generated by the Google Search Toolbelt.", -"A location found in the history of a user of the Mobile Frontend. Always corresponds to HISTORICAL_LOCATION, and has a correctly set historical_role and historical_producer.", -"A location found in the history of a user of Mobile Search in GWS (Tornado). Always corresponds to HISTORICAL_LOCATION, and has a correctly set historical_role and historical_producer. DEPRECATED: replaced with the OOLONG_REALTIME_CACHE producer.", -"A location selected by the user from a list presented by a mobile UI. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"A location passed to us by a partner UI. It typically corresponds to CURRENT_LOCATION (e.g., in an ad request to specify location targeting parameters) or USER_SPECIFIED_FOR_REQUEST.", -"The location was generated by the shared UI on the web search results page, typically for setting a default location. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The location was generated by the UI on the web search preferences page. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"From Maps Frontend (MFE).", -"From one of the Product Search frontends. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The descriptor was generated by a legacy \"gc\" param, and corresponds to the numerical ids assigned by the Ads team to various cities and regions. It always corresponds to a USER_SPECIFIED_FOR_REQUEST. The actual id will be stored in the loc field. At the present time, this producer is only used for internal tools and debugging.", -"The descriptor was generated by a mobile application. Used by some Google Android apps and corresponds to a HISTORICAL_LOCATION.", -"The descriptor was generated from the location inferred from web history. Always corresponds to HISTORICAL_LOCATION (for now---could have an INFERRED_LOCATION role in the future).", -"Same as QUERY_HISTORY_INFERRED but only used for experiments controlled by Oolong team.", -"The descriptor was generated by Gmail for location for weather. This is to support the Gmail themes with weather. It always corresponds to a DEFAULT_LOCATION.", -"The descriptor was generated by iGoogle for getting weather data. It corresponds to USER_SPECIFIED_FOR_REQUEST in this case.", -"The descriptor was generated by Calendar for getting weather data. It always corresponds to a DEFAULT_LOCATION.", -"The descriptor was generated from the location inferred from phone number or the personalization settings of the device in SMS search. It always correspond to a DEFAULT_LOCATION.", -"The descriptor was generated from the legacy 'gl' cgi param on a normal search request. It always corresponds to a CURRENT_LOCATION. ADS_GEO_PARAM will also be present if \"gr\" and/or \"gcs\" are present.", -"The descriptor was generated from the legacy 'gl' cgi param sent as an override from a partner. It always corresponds to the CURRENT_LOCATION role. ADS_GEO_PARAM will also be present if \"gr\" and/or \"gcs\" are present.", -"The descriptor was generated from a cookie that stores a previously set legacy 'gl' cgi param. It always corresponds to the CURRENT_LOCATION role.", -"The jurisdiction country derived from the GWS FrontendRequest. Always corresponds to the CURRENT_LOCATION role.", -"Override from one of the Circulars frontends. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The descriptor was generated by the Search API for Shopping based on a user supplied parameter. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The descriptor was generated by OZ frontend. It always corresponds to USER_SPECIFIED_FOR_REQUEST", -"The descriptor generated for Ads. This is generated from gl, gr, gcs and gm parameters. If the gl=US, gr=US-CA and gcs=San+Francisco, then the location is set to \"San Francisco,CA,US\". If any parameter is missing, it is skipped from the final location string. For example, if gcs is missing above, the location would be \"CA,US\". This and LEGACY_GL_PARAM will be generated when gr/gcs are present. Always corresponds to the CURRENT_LOCATION role.", -"The descriptor generated by GWS for Ads for partner requests. This is generated from gl, gr, gcs and gm parameters passed from partners. If the gl=US, gr=US-CA and gcs=San+Francisco, then the location is set to \"San Francisco,CA,US\". If any parameter is missing, it is skipped from the final location string. For example, if gcs is missing above, the location would be \"CA,US\". This and LEGACY_PARTNER_GL_PARAM will be generated when gr/gcs are present. Always corresponds to the CURRENT_LOCATION role.", -"Overrides all other default locations. It is a freeform address string. It always corresponds to the DEFAULT_LOCATION role. It is intended for testing only. NOTE: Please talk to oolong-team before using this producer. It should be used for one-off overrides only.", -"Location specified by viewport CGI parameters sll, sspn.", -"Location extracted from Happy Hour (signed-in user). Will be used with HISTORICAL_LOCATION role.", -"Descriptor generated from stickiness params feature id.", -"Location determined by a turn-by-turn-navigation client triggered by a reroute event. A location of this producer should additionally specify a semantic with LocationSemantic members to differentiate them among each other.", -"Location containing a feature ID determined by HULK realtime snap-to-place. The latlng and timestamp will correspond to the device location at the point the snap-to-place request was made. The confidence value is the confidence of that feature according to the snap-to-place response. This will usually be used with the CURRENT_LOCATION role, although might also be a HISTORICAL_LOCATION in cases where we are expressing a series of recent snap-to-place results.", -"Location containing a feature ID determined by HULK realtime snap-to-place as in SNAP_TO_PLACE_IMPLICIT, but which was subsequently confirmed by the user. As in SNAP_TO_PLACE_IMPLICIT the confidence value will reflect the value returned by the snap-to-place response, but backends may choose to ignore that value and assume the confidence is 100% since the user has explicitly chosen to interact with the place (the ambiguity is worth capturing though since the UI flow will not necessarily constitute an actual confirmation of a user's presence in a place). This will usually be used with the CURRENT_LOCATION role, although might also be a HISTORICAL_LOCATION in cases where we are expressing a series of recent snap-to-place results.", -"Location extracted from HappyHour which correspond to user's home and work locations. These locations are fetched from HulkUserPlaces HappyHour object (go/hulk-in-happyhour). This will be used with role=DEFAULT_LOCATION and LocationSemantic will indicate whether this location is home or work. AdWords will be the first client of this data. These locations are confirmed by the user.", -"Similar to the above producer, except that these locations are inferred by happyhour and are not confirmed by the user. Two different producers are being used for confirmed and inferred locations as their use might have different privacy implications. Design doc: go/homeworktargeting", -"The location extracted from a search nearby request in Tactile.", -"Location determined by Maps Activity in GMM client, corresponding to a previous location of the user for which nearby places are requested. This will be used with role=USER_SPECIFIED_FOR_REQUEST.", -"This descriptor is to only be used for experiments controlled by ipgeo team. During experimentation or ramping up launches, when this is provided in addition to IP_ADDRESS, this one is guaranteed to contain the result of the baseline ip index until the launch is at 100 % for both search and ads. Note that the definition of baseline may change depending on the product that uses it. For example, in search it may contain the old index whereas in Ads it may contain the experimental index. Contact the ipgeo-team for more details.", -"This descriptor is intended for a client to pass an offset used to anonymize all pii coordinates in a SearchAlongRouteContext or EnrouteContext. Anonymized coordinates are set as relative to DIRECTIONS_START_POINT rather than as absolute locations. This should be used with role = USER_SPECIFIED_FOR_REQUEST.", -"This producer indicates the location is from the search-along-route system. This producer is not intended to be used in a raw LocationResult; rather it is a descriptor for use with downstream processed locations (such as LocationRankingTargetLocation).", -"This producer returns the best guess for the user location as projected onto a specific route that the user is following. Users using driving navigation most often follow the route they are being told. On occasion they deviate, and sometimes it is not clear whether they have deviated or not. To represent both possibilities, Google Maps for Mobile sends both (a) the user location snapped to the road network and (b) the user location snapped to the specific route the user is being told to follow. The former has DEVICE_LOCATION producer and the latter has SNAP_TO_ROUTE producer.", -"This descriptor was generated from Google My Business location as a lat/lng. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"This is a device location that has been rejected for some reason. It is only kept in the location context so we can analyze them in logs.", -"This is a device location that has been quantized on device for privacy purposes, for use by NBN in GMM backends. Consult with pwg-geo@ and oolong-team@ before using this producer.", -"A location found in the history of a gaia user in GWS. Similar to GWS_MOBILE_HISTORY_ZWIEBACK, but works only for gaia users. Differs from GAIA_LOCATION_HISTORY - it is extracted from user search requests (not from user location reports on Android) and stored in Kansas (not in HappyHour). DEPRECATED: replaced with the OOLONG_REALTIME_CACHE producer.", -"A FUTURE_LOCATION signal originating from the user location forecast producer in Context Manager: go/context-manager.", -"A HISTORICAL_LOCATION region collected on device over time: go/gmm-terroir. DEPRECATED(2018-02-20): b/124457814.", -"The descriptor was generated by the Google News UI. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The descriptor was generated by the user's preferred delivery address configured in Google Shopping Express. go/shipping-address", -"Information about the device, without actual location data, e.g. ActivityRecord.", -"A FUTURE_LOCATION signal produced by travel state intent: go/travel-triggering.", -"A frequently visited place of a user, see go/hulk-routines-implementation. For Location History users only. Experimental, consult with oolong-team@ before using this producer.", -"A special enum value for representing a wildcard producer (matches any producer). This must never be used as the producer for a descriptor.", -"The descriptor was generated by Toolbar and passed via the legacy X_TOOLBAR_LOCATION header. It always corresponds to a CURRENT_LOCATION.", -"The descriptor was generated by Mobile Frontend and passed via the legacy \"gll\" and \"near\" params. It always corresponds to a CURRENT_LOCATION. The \"gll\" parameter appears in latlng (and, if applicable latlng_span) and if there's a \"near\" parameter, it appears in the loc field. Note that other uses of \"gll\" are not covered by this producer. DEPRECATED(finnegan): As of 2010/03/26. This will be renamed eventually.", -"The descriptor was generated by Mobile Frontend and passed via the legacy \"near\" param (without \"gll\"). This has different semantics from those of LEGACY_NEAR_PARAM. It always corresponds to a CURRENT_LOCATION. DEPRECATED(finnegan): As of 2010/03/26. This will be renamed eventually.", -"A result that was ablated for an experiment.", -"Location coming from Oolong location cache (go/ort-cache-dd).", -"Same as OOLONG_REALTIME_CACHE but only used for experiments controlled by Oolong team.", -"Location coming from an internal superroot call trying to resolve one directions waypoint in the context of a known one. This will be used inside DirectionsSearch flow in superroot before sending a request to the WebPlusLocal node in superroot.", -"Viewport derived in Superroot after organic results are available.", -"Location from the Search Region Settings in Search Settings (stored in the Zwieback cookie). Always combined with the DEFAULT_LOCATION role. Search uses this setting to determine the jurisdiction region (for signed-in and signed-out traffic), but does so on the GWS side and sends only the output of its logic as a GWS_JURISDICTION_COUNTRY result to Oolong Service. Thus, it does not need to use this producer. Conversely, for Assistant traffic, the jurisdiction region is determined in LES from the various input signals (including this one). Prioritization between the various signals for Assistant is described in go/assistant-region and implemented in google3/googledata/location/unified/location_service/client_configuration.textproto.", -"A location that originates in assistant. The location is contained in a LocationDescriptor across assistant. The source of the location is unknown but it is not a DEVICE_LOCATION. go/as-oolong-launch", -"A location indicated by the user as their default to be used for the current location.", -"Viewport override for GLS ad retrieval." -], -"type": "string" -}, -"historicalProminence": { -"deprecated": true, -"description": "This field is intended for recording frequency of historical location usage. Do not use it unless you know the historical producer intention for this field. DEPRECATED: This is no longer used or populated.", -"format": "int32", -"type": "integer" -}, -"historicalRole": { -"description": "This field is intended for recording the role of a historical location. It will be populated for a descriptor with role HISTORICAL_LOCATION, using the role of the original descriptor. To enable location history to be sent via an untrusted source to a frontend, you should make sure that the historical_role-historical_producer pair of the descriptor also appears on the untrusted allowlist used by the frontend.", -"enum": [ -"UNKNOWN_ROLE", -"CURRENT_LOCATION", -"DEFAULT_LOCATION", -"QUERY", -"USER_SPECIFIED_FOR_REQUEST", -"HISTORICAL_QUERY", -"HISTORICAL_LOCATION", -"VIEWPORT", -"FUTURE_LOCATION", -"INVALID_LOCATION", -"EXPERIMENTAL_LOCATION", -"CURRENT_CONTEXT", -"FINAL_VIEWPORT", -"GLS_FINAL_VIEWPORT", -"WILDCARD_ROLE" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors. A descriptor with this role is invalid and should be ignored.", -"The location is the device's current, physical location. Semantics: * unique * implicit * immediate", -"A user-specified default location. The suggested interpretation is as a literal default; in the absence of better information or a reasonable understanding of the user's intent, use the default location. Semantics: * unique * explicit * persistent", -"A descriptor corresponding to the query in a request (if any). A query may or may not contain location information but a descriptor is created and geocoding attempted in case there is one. The query is specified in the loc field and can take two forms, the raw query or an squery. The form is indicated by the corresponding producer (RQUERY or SQUERY). Semantics: * unique * explicit * immediate", -"A user-specified location specific to this request but not part of a query. These typically come from the user entering an overriding location in some separate UI field and submitting a request (e.g, overriding the location of weather results or setting a new default location). The source of the override is indicated by the producer. While it is technically possible to have multiple overrides for a request, that suggests a confusing user experience. Semantics: * unique * explicit * immediate", -"DEPRECATED: This was never used in production and is replaced by HISTORICAL_LOCATION.", -"A descriptor corresponding to some past location associated with the current request. This location may have come from a variety of sources (e.g., a history of queries) and the source of the location is indicated by the producer. There can be more than one historical location in a context. Historical locations should always have an associated timestamp. The original metadata for the location should be added via the historical_role and historical_producer fields. Semantics: * repeated * implicit * persistent", -"A descriptor corresponding to a user-visible viewport (e.g., Maps viewport, Streetview viewport, mobile camera viewport). This viewport may have come from a variety of sources, indicated by the producer. We expect there to be only one viewport active (hence \"unique\" semantics). We assume that the user has explicitly accepted and is aware of the viewport (hence \"explicit\" semantics). The viewport is associated only with the current query (hence \"immediate\" semantics). Viewports are expressed via rect. Semantics: * unique * explicit * immediate", -"A descriptor corresponding to a prediction of the future location of the user issuing the request. This location may have come from a variety of sources (e.g. calendar, user profile, etc) and the source of the location is indicated by the producer. There can be more than one future location in a context. Future locations should always have associated presence_interval:s. Semantics: * repeated * implicit * persistent", -"A descriptor corresponding to an invalid location, e.g. rect is invalid in it. Producer is kept as the original producer, original role is lost. A location with this role should not be used in production. Semantics: * repeated", -"Experimental device location produced by GmsCore, not to be used in any oolong policy. Only for quality check before switch to GmsCore as X-Geo header producer in AGSA. go/agsa-xgeo-integration-dd - AGSA XGeo Context Manager integration. * repeated", -"Current location related data, without actual location information, e.g. ActivityRecord. Semantics: * unique * implicit * immediate", -"A descriptor corresponding to the viewport that will be shown to the user after the request completes, such as a query 'tour eiffel', or a direction MTV to SFO. This viewport only appears together with the ADS_FINAL_VIEWPORT producer. We expect there to be only one at a time (hence \"unique\" semantics). We assume that the user has explicitly requested it and is aware of the viewport (hence \"explicit\" semantics). The viewport is associated only with the current query (hence \"immediate\" semantics). Viewports are expressed via rect. Semantics: * unique * explicit * immediate", -"A descriptor corresponding to a viewport that will be used for GLS ad retrieval. On some surfaces (e.g. xGMM apps), the final viewport is expanded to improve ad retrieval for other ads. This larger viewport works poorly for GLS ad retrieval, so we will extract the original, unexpanded, final viewport as well. This viewport only appears together with the ADS_GLS_FINAL_VIEWPORT producer. We expect there to be only one at a time (\"unique\"). This viewport is the final displayed viewport (\"explicit\"). The viewport is associated only with the current query (\"immediate\"). Semantics: * unique * explicit * immediate", -"A special enum value for representing a wildcard role (matches any role). This must never be used as the role for a descriptor." -], -"type": "string" -}, -"language": { -"deprecated": true, -"description": "The language used previously for query geocoding, set to the frontend language of the user during extraction. DO NOT USE THIS TO GET A USER'S LANGUAGE. INSTEAD, GET THE LANGUAGE FROM THE FrontendRequest OR THROUGH ANOTHER API! THIS FIELD WILL GO AWAY.", -"type": "string" -}, -"latlng": { -"$ref": "LocationUnifiedLatLng", -"description": "A latitude and longitude used to describe this location as a point." -}, -"latlngSpan": { -"$ref": "LocationUnifiedLatLng", -"deprecated": true, -"description": "The span of a bounding box whose center is latlng. Specifies the lengths of the sides of the box and is valid only if latlng is present. DEPRECATED(6/6/2012): b/5979511. Use 'rect' instead." -}, -"levelFeatureId": { -"$ref": "LocationUnifiedFeatureIdProto", -"description": "A 128-bit feature ID for the (indoor) level/floor of this location. If present, the floor supplements other location attributes in this descriptor. For example, in shopping malls it is quite common that one store occupies rooms on multiple levels, connected with escalators. The user can be at the exact same lat/lng and at the same GAP store, but on different levels." -}, -"levelNumber": { -"description": "The number of this location's level relative to the ground floor. 0 means ground floor; -2 is two levels below ground; +0.5 is a mezzanine.", -"format": "float", -"type": "number" -}, -"loc": { -"description": "A string containing the location payload. The format of this string may depend on the producer but it should be otherwise be treated like a freeform, human-readable string (a query, a street address, city name, postal code, district name, country, etc.). Other, producer-specific formats include IP address, host domain, and squery. time zone. Note that for some producers there is no guarantee that the string contains a valid location (e.g., a query for [pizza]).", -"type": "string" -}, -"mid": { -"description": "A 64-bit machine identifier of a geo feature in Freebase.", -"format": "uint64", -"type": "string" -}, -"permissionGranularity": { -"description": "The granularity of the location permissions that was present to get the device location that this location descriptor represents. Only relevant for device locations.", -"enum": [ -"PERMISSION_GRANULARITY_UNKNOWN", -"PERMISSION_GRANULARITY_COARSE", -"PERMISSION_GRANULARITY_FINE" -], -"enumDescriptions": [ -"", -"The device location was retrieved with `coarse` permissions, meaning it will have a radius > 1.2 km. Note that this is *not* the common 3+1 anonymization, hence these are usually referred to as \"approximate\" in oolong.", -"The device location was retrieved with `fine` permission, meaning the radius will be as precise as reported by the device." -], -"type": "string" -}, -"presenceInterval": { -"description": "The presence intervals associated with the location. Required for FUTURE_LOCATION signals. This field should not be logged anywhere.", -"items": { -"$ref": "LocationUnifiedPresenceInterval" -}, -"type": "array" -}, -"producer": { -"description": "The producer of this location.", -"enum": [ -"UNKNOWN_PRODUCER", -"LOGGED_IN_USER_SPECIFIED", -"PREF_L_FIELD_ADDRESS", -"IP_ADDRESS", -"IP_ADDRESS_REALTIME", -"GOOGLE_HOST_DOMAIN", -"RQUERY", -"SQUERY", -"QUERY_LOCATION_OVERRIDE_PRODUCER", -"QREF", -"DEVICE_LOCATION", -"LEGACY_NEAR_PARAM", -"CARRIER_COUNTRY", -"JURISDICTION_COUNTRY", -"CLIENT_SPECIFIED_JURISDICTION_COUNTRY", -"DECODED_FROM_UNKNOWN_ROLE_PRODUCER", -"SHOWTIME_ONEBOX", -"LOCAL_UNIVERSAL", -"SEARCH_TOOLBELT", -"MOBILE_FE_HISTORY", -"GWS_MOBILE_HISTORY_ZWIEBACK", -"MOBILE_SELECTED", -"PARTNER", -"WEB_SEARCH_RESULTS_PAGE_SHARED", -"WEB_SEARCH_PREFERENCES_PAGE", -"MAPS_FRONTEND", -"PRODUCT_SEARCH_FRONTEND", -"ADS_CRITERIA_ID", -"MOBILE_APP", -"QUERY_HISTORY_INFERRED", -"QUERY_HISTORY_INFERRED_ALTERNATE", -"GMAIL_THEME", -"IGOOGLE", -"CALENDAR", -"SMS_SEARCH", -"LEGACY_GL_PARAM", -"LEGACY_PARTNER_GL_PARAM", -"LEGACY_GL_COOKIE", -"GWS_JURISDICTION_COUNTRY", -"CIRCULARS_FRONTEND", -"SHOPPING_SEARCH_API", -"OZ_FRONTEND", -"ADS_GEO_PARAM", -"ADS_PARTNER_GEO_PARAM", -"DEFAULT_LOCATION_OVERRIDE_PRODUCER", -"VIEWPORT_PARAMS", -"GAIA_LOCATION_HISTORY", -"STICKINESS_PARAMS", -"TURN_BY_TURN_NAVIGATION_REROUTE", -"SNAP_TO_PLACE_IMPLICIT", -"SNAP_TO_PLACE_EXPLICIT", -"HULK_USER_PLACES_CONFIRMED", -"HULK_USER_PLACES_INFERRED", -"TACTILE_NEARBY_PARAM", -"MAPS_ACTIVITY", -"IP_ADDRESS_ALTERNATE", -"DIRECTIONS_START_POINT", -"SEARCH_ALONG_ROUTE", -"SNAP_TO_ROUTE", -"GOOGLE_MY_BUSINESS", -"BAD_DEVICE_LOCATION", -"GMM_QUANTIZED_DEVICE_LOCATION", -"GWS_HISTORY_GAIA", -"CONTEXT_MANAGER_FORECAST", -"GMM_HEATMAP_AREA", -"NEWS", -"SHIPPING_ADDRESS", -"DEVICE_CONTEXT", -"TRAVEL_STATE_INTENT", -"HULK_ROUTINES", -"WILDCARD_PRODUCER", -"LEGACY_TOOLBAR_HEADER", -"LEGACY_MOBILE_FRONTEND_GLL", -"LEGACY_MOBILE_FRONTEND_NEAR", -"ABLATED_PRODUCER", -"OOLONG_REALTIME_CACHE", -"OOLONG_REALTIME_CACHE_ALTERNATE", -"DIRECTIONS_WAYPOINT", -"ADS_FINAL_VIEWPORT", -"SEARCH_REGION_SETTINGS_COUNTRY", -"ASSISTANT_DERIVED", -"OOLONG_DEFAULT_LOCATION", -"ADS_GLS_FINAL_VIEWPORT" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -true, -false, -false, -false, -false, -false, -false, -true, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors.", -"A location specified by a logged-in user (e.g., default location from Kansas). It is a freeform address string stored in loc.", -"The user-specified default location contained in the L-field of a browser's PREF cookie. It is a freeform address string stored in loc.", -"A location based on IP address. The IP address is stored in loc in dot-decimal (IPv4) or colon-hexadecimal (IPv6) format.", -"This is the location that is derived from the realtime ipgeo index. This is a fresh version of ipgeo index which is available for a small subset of IPs.", -"A location based on the domain of the Google server (e.g., google.co.uk) servicing the request. The domain name is stored in loc.", -"The descriptor is based on a raw query (free-form). The query text is stored in loc.", -"The descriptor is based on an squery and is stored as an squery in loc.", -"The descriptor contains a location as a raw query in loc. It is geocoded and used to override the geocoding of the QUERY/RQUERY or QUERY/SQUERY descriptor. Only to be used for debugging purposes.", -"This contains the location produced by qref module in qrewrite. Currently, the location is derived from the query and this will be only used with QUERY role.", -"A location that came from determining the physical location of a device (mobile, laptop, desktop, etc.) via means such as GPS, cell network, or Wifi. Always corresponds to CURRENT_LOCATION. The accuracy of the location may be stored in the radius and/or confidence fields. NOTE: By definition, these data do not include locations collected without the user's awareness and/or consent. Users on some Google services may be notified of and consent to Google's collection and use of geographical information.", -"The descriptor was generated by a legacy \"near\" param. It always corresponds to a USER_SPECIFIED_FOR_REQUEST. Occurrences should be replaced by Oolong-style parameters (e.g., muul/luul). Note that \"near\" params synthesized by Mobile Frontend from a lat/long are handled with LEGACY_MOBILE_FRONTEND_GLL.", -"The 2-letter ISO-3166-alpha2 code for the country of the mobile carrier of the request. Always corresponds to CURRENT_LOCATION, and is stored in the loc parameter. DEPRECATED(b/109727016). Use LocationAttributesProto.carrier_ip_type.", -"The descriptor was generated when mapping disputed areas to legally approved countries. It always corresponds to a DEFAULT_LOCATION role. It is used to geocode 2-letter ISO-3166-alpha2 country codes stored in the \"loc\" parameter.", -"The 2-letter ISO-3166-alpha2 code for the jurisdiction country specified by the Google application (e.g. GMM getting the country code directly from the simcard). Use the producer with role=DEFAULT_LOCATION.", -"The location was decoded from a uuld=l debug parameter based on anonymised Gaia logs that did not contain a role/producer pair.", -"The descriptor was generated by the Showtime (movies) Onebox.", -"A location used by any Local Search client (not just LU) to force a specific location interpretation. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"This descriptor by generated by the Google Search Toolbelt.", -"A location found in the history of a user of the Mobile Frontend. Always corresponds to HISTORICAL_LOCATION, and has a correctly set historical_role and historical_producer.", -"A location found in the history of a user of Mobile Search in GWS (Tornado). Always corresponds to HISTORICAL_LOCATION, and has a correctly set historical_role and historical_producer. DEPRECATED: replaced with the OOLONG_REALTIME_CACHE producer.", -"A location selected by the user from a list presented by a mobile UI. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"A location passed to us by a partner UI. It typically corresponds to CURRENT_LOCATION (e.g., in an ad request to specify location targeting parameters) or USER_SPECIFIED_FOR_REQUEST.", -"The location was generated by the shared UI on the web search results page, typically for setting a default location. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The location was generated by the UI on the web search preferences page. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"From Maps Frontend (MFE).", -"From one of the Product Search frontends. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The descriptor was generated by a legacy \"gc\" param, and corresponds to the numerical ids assigned by the Ads team to various cities and regions. It always corresponds to a USER_SPECIFIED_FOR_REQUEST. The actual id will be stored in the loc field. At the present time, this producer is only used for internal tools and debugging.", -"The descriptor was generated by a mobile application. Used by some Google Android apps and corresponds to a HISTORICAL_LOCATION.", -"The descriptor was generated from the location inferred from web history. Always corresponds to HISTORICAL_LOCATION (for now---could have an INFERRED_LOCATION role in the future).", -"Same as QUERY_HISTORY_INFERRED but only used for experiments controlled by Oolong team.", -"The descriptor was generated by Gmail for location for weather. This is to support the Gmail themes with weather. It always corresponds to a DEFAULT_LOCATION.", -"The descriptor was generated by iGoogle for getting weather data. It corresponds to USER_SPECIFIED_FOR_REQUEST in this case.", -"The descriptor was generated by Calendar for getting weather data. It always corresponds to a DEFAULT_LOCATION.", -"The descriptor was generated from the location inferred from phone number or the personalization settings of the device in SMS search. It always correspond to a DEFAULT_LOCATION.", -"The descriptor was generated from the legacy 'gl' cgi param on a normal search request. It always corresponds to a CURRENT_LOCATION. ADS_GEO_PARAM will also be present if \"gr\" and/or \"gcs\" are present.", -"The descriptor was generated from the legacy 'gl' cgi param sent as an override from a partner. It always corresponds to the CURRENT_LOCATION role. ADS_GEO_PARAM will also be present if \"gr\" and/or \"gcs\" are present.", -"The descriptor was generated from a cookie that stores a previously set legacy 'gl' cgi param. It always corresponds to the CURRENT_LOCATION role.", -"The jurisdiction country derived from the GWS FrontendRequest. Always corresponds to the CURRENT_LOCATION role.", -"Override from one of the Circulars frontends. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The descriptor was generated by the Search API for Shopping based on a user supplied parameter. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The descriptor was generated by OZ frontend. It always corresponds to USER_SPECIFIED_FOR_REQUEST", -"The descriptor generated for Ads. This is generated from gl, gr, gcs and gm parameters. If the gl=US, gr=US-CA and gcs=San+Francisco, then the location is set to \"San Francisco,CA,US\". If any parameter is missing, it is skipped from the final location string. For example, if gcs is missing above, the location would be \"CA,US\". This and LEGACY_GL_PARAM will be generated when gr/gcs are present. Always corresponds to the CURRENT_LOCATION role.", -"The descriptor generated by GWS for Ads for partner requests. This is generated from gl, gr, gcs and gm parameters passed from partners. If the gl=US, gr=US-CA and gcs=San+Francisco, then the location is set to \"San Francisco,CA,US\". If any parameter is missing, it is skipped from the final location string. For example, if gcs is missing above, the location would be \"CA,US\". This and LEGACY_PARTNER_GL_PARAM will be generated when gr/gcs are present. Always corresponds to the CURRENT_LOCATION role.", -"Overrides all other default locations. It is a freeform address string. It always corresponds to the DEFAULT_LOCATION role. It is intended for testing only. NOTE: Please talk to oolong-team before using this producer. It should be used for one-off overrides only.", -"Location specified by viewport CGI parameters sll, sspn.", -"Location extracted from Happy Hour (signed-in user). Will be used with HISTORICAL_LOCATION role.", -"Descriptor generated from stickiness params feature id.", -"Location determined by a turn-by-turn-navigation client triggered by a reroute event. A location of this producer should additionally specify a semantic with LocationSemantic members to differentiate them among each other.", -"Location containing a feature ID determined by HULK realtime snap-to-place. The latlng and timestamp will correspond to the device location at the point the snap-to-place request was made. The confidence value is the confidence of that feature according to the snap-to-place response. This will usually be used with the CURRENT_LOCATION role, although might also be a HISTORICAL_LOCATION in cases where we are expressing a series of recent snap-to-place results.", -"Location containing a feature ID determined by HULK realtime snap-to-place as in SNAP_TO_PLACE_IMPLICIT, but which was subsequently confirmed by the user. As in SNAP_TO_PLACE_IMPLICIT the confidence value will reflect the value returned by the snap-to-place response, but backends may choose to ignore that value and assume the confidence is 100% since the user has explicitly chosen to interact with the place (the ambiguity is worth capturing though since the UI flow will not necessarily constitute an actual confirmation of a user's presence in a place). This will usually be used with the CURRENT_LOCATION role, although might also be a HISTORICAL_LOCATION in cases where we are expressing a series of recent snap-to-place results.", -"Location extracted from HappyHour which correspond to user's home and work locations. These locations are fetched from HulkUserPlaces HappyHour object (go/hulk-in-happyhour). This will be used with role=DEFAULT_LOCATION and LocationSemantic will indicate whether this location is home or work. AdWords will be the first client of this data. These locations are confirmed by the user.", -"Similar to the above producer, except that these locations are inferred by happyhour and are not confirmed by the user. Two different producers are being used for confirmed and inferred locations as their use might have different privacy implications. Design doc: go/homeworktargeting", -"The location extracted from a search nearby request in Tactile.", -"Location determined by Maps Activity in GMM client, corresponding to a previous location of the user for which nearby places are requested. This will be used with role=USER_SPECIFIED_FOR_REQUEST.", -"This descriptor is to only be used for experiments controlled by ipgeo team. During experimentation or ramping up launches, when this is provided in addition to IP_ADDRESS, this one is guaranteed to contain the result of the baseline ip index until the launch is at 100 % for both search and ads. Note that the definition of baseline may change depending on the product that uses it. For example, in search it may contain the old index whereas in Ads it may contain the experimental index. Contact the ipgeo-team for more details.", -"This descriptor is intended for a client to pass an offset used to anonymize all pii coordinates in a SearchAlongRouteContext or EnrouteContext. Anonymized coordinates are set as relative to DIRECTIONS_START_POINT rather than as absolute locations. This should be used with role = USER_SPECIFIED_FOR_REQUEST.", -"This producer indicates the location is from the search-along-route system. This producer is not intended to be used in a raw LocationResult; rather it is a descriptor for use with downstream processed locations (such as LocationRankingTargetLocation).", -"This producer returns the best guess for the user location as projected onto a specific route that the user is following. Users using driving navigation most often follow the route they are being told. On occasion they deviate, and sometimes it is not clear whether they have deviated or not. To represent both possibilities, Google Maps for Mobile sends both (a) the user location snapped to the road network and (b) the user location snapped to the specific route the user is being told to follow. The former has DEVICE_LOCATION producer and the latter has SNAP_TO_ROUTE producer.", -"This descriptor was generated from Google My Business location as a lat/lng. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"This is a device location that has been rejected for some reason. It is only kept in the location context so we can analyze them in logs.", -"This is a device location that has been quantized on device for privacy purposes, for use by NBN in GMM backends. Consult with pwg-geo@ and oolong-team@ before using this producer.", -"A location found in the history of a gaia user in GWS. Similar to GWS_MOBILE_HISTORY_ZWIEBACK, but works only for gaia users. Differs from GAIA_LOCATION_HISTORY - it is extracted from user search requests (not from user location reports on Android) and stored in Kansas (not in HappyHour). DEPRECATED: replaced with the OOLONG_REALTIME_CACHE producer.", -"A FUTURE_LOCATION signal originating from the user location forecast producer in Context Manager: go/context-manager.", -"A HISTORICAL_LOCATION region collected on device over time: go/gmm-terroir. DEPRECATED(2018-02-20): b/124457814.", -"The descriptor was generated by the Google News UI. Always corresponds to USER_SPECIFIED_FOR_REQUEST.", -"The descriptor was generated by the user's preferred delivery address configured in Google Shopping Express. go/shipping-address", -"Information about the device, without actual location data, e.g. ActivityRecord.", -"A FUTURE_LOCATION signal produced by travel state intent: go/travel-triggering.", -"A frequently visited place of a user, see go/hulk-routines-implementation. For Location History users only. Experimental, consult with oolong-team@ before using this producer.", -"A special enum value for representing a wildcard producer (matches any producer). This must never be used as the producer for a descriptor.", -"The descriptor was generated by Toolbar and passed via the legacy X_TOOLBAR_LOCATION header. It always corresponds to a CURRENT_LOCATION.", -"The descriptor was generated by Mobile Frontend and passed via the legacy \"gll\" and \"near\" params. It always corresponds to a CURRENT_LOCATION. The \"gll\" parameter appears in latlng (and, if applicable latlng_span) and if there's a \"near\" parameter, it appears in the loc field. Note that other uses of \"gll\" are not covered by this producer. DEPRECATED(finnegan): As of 2010/03/26. This will be renamed eventually.", -"The descriptor was generated by Mobile Frontend and passed via the legacy \"near\" param (without \"gll\"). This has different semantics from those of LEGACY_NEAR_PARAM. It always corresponds to a CURRENT_LOCATION. DEPRECATED(finnegan): As of 2010/03/26. This will be renamed eventually.", -"A result that was ablated for an experiment.", -"Location coming from Oolong location cache (go/ort-cache-dd).", -"Same as OOLONG_REALTIME_CACHE but only used for experiments controlled by Oolong team.", -"Location coming from an internal superroot call trying to resolve one directions waypoint in the context of a known one. This will be used inside DirectionsSearch flow in superroot before sending a request to the WebPlusLocal node in superroot.", -"Viewport derived in Superroot after organic results are available.", -"Location from the Search Region Settings in Search Settings (stored in the Zwieback cookie). Always combined with the DEFAULT_LOCATION role. Search uses this setting to determine the jurisdiction region (for signed-in and signed-out traffic), but does so on the GWS side and sends only the output of its logic as a GWS_JURISDICTION_COUNTRY result to Oolong Service. Thus, it does not need to use this producer. Conversely, for Assistant traffic, the jurisdiction region is determined in LES from the various input signals (including this one). Prioritization between the various signals for Assistant is described in go/assistant-region and implemented in google3/googledata/location/unified/location_service/client_configuration.textproto.", -"A location that originates in assistant. The location is contained in a LocationDescriptor across assistant. The source of the location is unknown but it is not a DEVICE_LOCATION. go/as-oolong-launch", -"A location indicated by the user as their default to be used for the current location.", -"Viewport override for GLS ad retrieval." -], -"type": "string" -}, -"provenance": { -"description": "Extra information about how this descriptor was obtained. Provenance is intended for logging non-semantic details about a descriptor (e.g., whether it was passed using a particular parameter or stored in a particular backend). It should *never* be used as a criterion for selection by a policy or backend (use role/producer instead). This is for bookkeeping only. You don't want this field. Really.", -"enum": [ -"UNREMARKABLE", -"TOOLBAR", -"MOBILE_FE", -"LEGACY_MOBILE_FRONTEND_GLL_PARAM", -"MAPS_FRONTEND_IL_DEBUG_IP", -"LEGACY_MOBILE_FRONTEND_NEAR_PARAM", -"GWS_MOBILE_CLIENT", -"GWS_MOBILE_CLIENT_ESSENTIAL_ONLY", -"XFF_HEADER", -"XGEO_HEADER", -"LEGACY_GEO_POSITION_HEADER", -"ASSISTANT_SETTINGS_FOR_CURRENT_DEVICE", -"ASSISTANT_DEVICE_PROPERTIES", -"EVAL_UNIQUE_SELECTED_USER_LOCATION", -"EVAL_BASE_UNIQUE_SELECTED_USER_LOCATION", -"EVAL_EXP_UNIQUE_SELECTED_USER_LOCATION", -"PERSONAL_LOCATION_MODEL_QUERY_ONLY" -], -"enumDescriptions": [ -"THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value. Nothing interesting about the descriptor's provenance.", -"Descriptor came from the Google Toolbar.", -"Descriptor came from the Mobile Frontend", -"Descriptor came via from Mobile Frontend via the legacy \"gll\" param.", -"Descriptor came from the Maps Frontend il parameter, with a type of ip.", -"Descriptor came via from Mobile Frontend via the legacy \"near\" param.", -"Descriptor came from GWS via the client library.", -"Essential-only mode version of GWS_MOBILE_CLIENT.", -"Descriptor came from X-Forwarded-For HTTP Header.", -"Descriptor came from X-Geo HTTP header or an app-internal flow that retrieves location in an X-Geo equivalent way.", -"Descriptor came from legacy Geo-Position HTTP header.", -"Descriptor came from the Assistant settings for the current device (see also go/opa-settings).", -"Descriptor came from the Assistatn DeviceProperties.location_descriptor field. This is used by some client surfaces (e.g. KaiOS).", -"DO NOT use the following three without consulting with oolong-team. They are used by Evals to force a given location to be the chosen one.", -"", -"", -"INTERNAL ONLY DO NOT use the following values without first consulting oolong-team@. These should be considered internal details of Oolong's business logic and generally should not be used by clients. Indicates a PLM that was built using query (or query-like) inputs only." -], -"type": "string" -}, -"radius": { -"description": "The radius within which one standard deviation (or 68%) of possible locations lie, assuming a normal distribution around latlng. This radius is normally seen in the UI of mobile maps as the blue 'accuracy circle', although the interpretation (e.g. 1sd or 2sd) may vary by platform. Units must be in mm.", -"format": "float", -"type": "number" -}, -"rect": { -"$ref": "LocationUnifiedLatLngRect", -"description": "A viewport or bounds depending on role/producer. For example, when role is VIEWPORT this field represents a viewport. 'latlng' and 'rect' are mutually exclusive." -}, -"role": { -"description": "The role of this location.", -"enum": [ -"UNKNOWN_ROLE", -"CURRENT_LOCATION", -"DEFAULT_LOCATION", -"QUERY", -"USER_SPECIFIED_FOR_REQUEST", -"HISTORICAL_QUERY", -"HISTORICAL_LOCATION", -"VIEWPORT", -"FUTURE_LOCATION", -"INVALID_LOCATION", -"EXPERIMENTAL_LOCATION", -"CURRENT_CONTEXT", -"FINAL_VIEWPORT", -"GLS_FINAL_VIEWPORT", -"WILDCARD_ROLE" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors. A descriptor with this role is invalid and should be ignored.", -"The location is the device's current, physical location. Semantics: * unique * implicit * immediate", -"A user-specified default location. The suggested interpretation is as a literal default; in the absence of better information or a reasonable understanding of the user's intent, use the default location. Semantics: * unique * explicit * persistent", -"A descriptor corresponding to the query in a request (if any). A query may or may not contain location information but a descriptor is created and geocoding attempted in case there is one. The query is specified in the loc field and can take two forms, the raw query or an squery. The form is indicated by the corresponding producer (RQUERY or SQUERY). Semantics: * unique * explicit * immediate", -"A user-specified location specific to this request but not part of a query. These typically come from the user entering an overriding location in some separate UI field and submitting a request (e.g, overriding the location of weather results or setting a new default location). The source of the override is indicated by the producer. While it is technically possible to have multiple overrides for a request, that suggests a confusing user experience. Semantics: * unique * explicit * immediate", -"DEPRECATED: This was never used in production and is replaced by HISTORICAL_LOCATION.", -"A descriptor corresponding to some past location associated with the current request. This location may have come from a variety of sources (e.g., a history of queries) and the source of the location is indicated by the producer. There can be more than one historical location in a context. Historical locations should always have an associated timestamp. The original metadata for the location should be added via the historical_role and historical_producer fields. Semantics: * repeated * implicit * persistent", -"A descriptor corresponding to a user-visible viewport (e.g., Maps viewport, Streetview viewport, mobile camera viewport). This viewport may have come from a variety of sources, indicated by the producer. We expect there to be only one viewport active (hence \"unique\" semantics). We assume that the user has explicitly accepted and is aware of the viewport (hence \"explicit\" semantics). The viewport is associated only with the current query (hence \"immediate\" semantics). Viewports are expressed via rect. Semantics: * unique * explicit * immediate", -"A descriptor corresponding to a prediction of the future location of the user issuing the request. This location may have come from a variety of sources (e.g. calendar, user profile, etc) and the source of the location is indicated by the producer. There can be more than one future location in a context. Future locations should always have associated presence_interval:s. Semantics: * repeated * implicit * persistent", -"A descriptor corresponding to an invalid location, e.g. rect is invalid in it. Producer is kept as the original producer, original role is lost. A location with this role should not be used in production. Semantics: * repeated", -"Experimental device location produced by GmsCore, not to be used in any oolong policy. Only for quality check before switch to GmsCore as X-Geo header producer in AGSA. go/agsa-xgeo-integration-dd - AGSA XGeo Context Manager integration. * repeated", -"Current location related data, without actual location information, e.g. ActivityRecord. Semantics: * unique * implicit * immediate", -"A descriptor corresponding to the viewport that will be shown to the user after the request completes, such as a query 'tour eiffel', or a direction MTV to SFO. This viewport only appears together with the ADS_FINAL_VIEWPORT producer. We expect there to be only one at a time (hence \"unique\" semantics). We assume that the user has explicitly requested it and is aware of the viewport (hence \"explicit\" semantics). The viewport is associated only with the current query (hence \"immediate\" semantics). Viewports are expressed via rect. Semantics: * unique * explicit * immediate", -"A descriptor corresponding to a viewport that will be used for GLS ad retrieval. On some surfaces (e.g. xGMM apps), the final viewport is expanded to improve ad retrieval for other ads. This larger viewport works poorly for GLS ad retrieval, so we will extract the original, unexpanded, final viewport as well. This viewport only appears together with the ADS_GLS_FINAL_VIEWPORT producer. We expect there to be only one at a time (\"unique\"). This viewport is the final displayed viewport (\"explicit\"). The viewport is associated only with the current query (\"immediate\"). Semantics: * unique * explicit * immediate", -"A special enum value for representing a wildcard role (matches any role). This must never be used as the role for a descriptor." -], -"type": "string" -}, -"semantic": { -"description": "Some producers may additionally specify semantics explaining the meaning of a location, in particular to differentiate several locations with the same producer.", -"items": { -"enum": [ -"SEMANTIC_UNKNOWN", -"SEMANTIC_REROUTE_SOURCE", -"SEMANTIC_REROUTE_PROPOSED", -"SEMANTIC_REROUTE_TAKEN", -"SEMANTIC_HOME", -"SEMANTIC_WORK", -"SEMANTIC_ONBOARD_TRANSIT", -"SEMANTIC_MAPS_SEARCH", -"SEMANTIC_FREQUENT_PLACE", -"SEMANTIC_OTHER" -], -"enumDescriptions": [ -"THIS VALUE MUST BE THE FIRST IN THIS ENUM. Default value used to identify unset fields including those resulting from enum values unknown to an out-dated binary. This should be used only to check for errors.", -"A descriptor corresponding to an already traveled location on a user's route as part of reroute information. The location producer of these should be TURN_BY_TURN_NAVIGATION_REROUTE.", -"A descriptor corresponding to a not traveled location on a user's route (before a reroute event) as part of reroute information. The location producer of these should be TURN_BY_TURN_NAVIGATION_REROUTE.", -"A descriptor corresponding to an actually traveled location (in contrast to a supposed-to travel location) as part of reroute information. The location producer of these should be TURN_BY_TURN_NAVIGATION_REROUTE.", -"A descriptor corresponding to the maps aliased location.", -"", -"A descriptor corresponding to a location of a user who is riding on a transit vehicle.", -"user searched for this place", -"user frequently visits this place", -"other maps alias icon" -], -"type": "string" -}, -"type": "array" -}, -"semanticPlace": { -"description": "If there are multiple semantic places, then the first place is the finest, then come the parent hierarchy. This field should not be logged anywhere.", -"items": { -"$ref": "LocationUnifiedSemanticPlace" -}, -"type": "array" -}, -"timestamp": { -"description": "A timestamp associated with this location expressed as the number of microseconds since 00:00:00 Jan-1-1970 UTC. If not set, assumed to be \"now\" or irrelevant. Use this field to indicate when this location has been acquired (e.g. by requesting location from the device).", -"format": "int64", -"type": "string" -}, -"visibleNetwork": { -"deprecated": true, -"description": "A list of visible networks that describe the location and can geocoded by GLS. This field should not be logged anywhere.", -"items": { -"$ref": "LocationUnifiedVisibleNetwork" -}, -"type": "array" -} -}, -"type": "object" -}, -"LocationUnifiedLocationResult": { -"description": "All information about a single location within a context. This includes the descriptor, which can be thought of as a kind of \"query\" that minimally specifies the location, and rest (i.e., geocoding data, policy annotations, etc.). A LocationResult typically starts with just a descriptor and the rest is added later via lookups. If necessary, persistent locations can be stored as a pre-geocoded LocationResult to avoid the extra work. Next Available Tag: 14", -"id": "LocationUnifiedLocationResult", -"properties": { -"alternateAnnotations": { -"description": "Additional sets of annotations from other oolong policies.", -"items": { -"$ref": "LocationUnifiedAnnotationSet" -}, -"type": "array" -}, -"annotations": { -"description": "The annotations that have been applied to this result for use in production.", -"items": { -"$ref": "LocationUnifiedLocationAnnotation" -}, -"type": "array" -}, -"defaultBlockingData": { -"$ref": "DefaultBlockingDataProto", -"description": "Information about whether the feature hierarchy contains default-blocked features." -}, -"desc": { -"$ref": "LocationUnifiedLocationDescriptor", -"description": "The descriptor for this result. Once added, descriptors should be considered immutable. Any additional information should be included elsewhere in the result." -}, -"displayable": { -"description": "Flag to indicate this result has human-readable names for display.", -"type": "boolean" -}, -"extraData": { -"$ref": "LocationUnifiedLocationResultExtraData" -}, -"featureRefs": { -"description": "The feature hierarchy for this location result, if using the new feature-pool format instead of les_response.", -"items": { -"$ref": "LocationUnifiedFeatureReference" -}, -"type": "array" -}, -"geocoded": { -"description": "True indicates that this result has geographical information like a lat/long, bounding box, etc.). The minimum is a lat/long. False only indicates that no such data is present and does NOT explain the reason (e.g., geocoding hasn't been attempted, geocoding timed out, the descriptor does not refer to a location, etc.).", -"type": "boolean" -}, -"geocodingReason": { -"description": "Explains the specific reason for the value of the geocoded field, if any. This can be used to determine whether a descriptor needs to be geocoded. Used for making runtime decisions about whether to attempt geocoding.", -"enum": [ -"DEFAULT_REASON", -"NO_GEOCODING_RESULTS", -"RPC_FAILED" -], -"enumDescriptions": [ -"No reason is required to explain the value of the geocoded field. For geocoded = true, geocoding data is available. For geocoded = false, geocoding has not been attempted.", -"Geocoding was attempted but returned no results for the descriptor. This usually means that the descriptor does not refer to a recognized location (e.g., the query [pizza]). Only valid for geocoded = false.", -"One or more geocoding RPCs failed." -], -"type": "string" -}, -"lesResponse": { -"$ref": "LocationExtractorLocationExtractionResponse", -"description": "WARNING: Do not reference this field directly check go/oolong-usage on how to access the values present in this proto or contact oolong-team@google.com if you don't see what you need." -}, -"nonstandardData": { -"$ref": "MessageSet", -"description": "Allow pipelines to associate arbitrary data (e.g., specialized geo identifiers) with a result. Chiefly intended to pass custom data around backends after standard geocoding and policy execution. Oolong libraries will generally ignore such data but may strip it to guard against cache fragmentation. Using this to pass data from frontends to backends before geocoding is not recommended and at your own risk. This field will carry AnonymizedBounds data which will be used for logging purposes." -}, -"policyResult": { -"$ref": "LocationUnifiedPolicyResult", -"description": "Result data computed by the policy annotation." -}, -"sourceDescription": { -"description": "Enum describing what this result was based on (e.g. location reported by the end user's phone). Present only if the LocationContext was produced by OolongService and this result has the USFUL annotation.", -"enum": [ -"SOURCE_DESCRIPTION_UNSPECIFIED", -"FROM_YOUR_INTERNET_ADDRESS", -"FROM_YOUR_LOCATION_HISTORY", -"BASED_ON_YOUR_LOCATION_HISTORY", -"FROM_YOUR_DEVICE", -"BASED_ON_YOUR_PAST_ACTIVITY", -"FROM_YOUR_PLACES_HOME", -"FROM_YOUR_PLACES_WORK" -], -"enumDescriptions": [ -"", -"", -"", -"", -"", -"", -"", -"" -], -"type": "string" -} -}, -"type": "object" -}, -"LocationUnifiedLocationResultExtraData": { -"description": "Includes data that is included only for small subset of results. Next Available Tag: 4", -"id": "LocationUnifiedLocationResultExtraData", -"properties": { -"featureDiff": { -"description": "Result caused a feature diff", -"type": "boolean" -}, -"interpretationData": { -"$ref": "LocationUnifiedInterpretationData", -"description": "For query results." -}, -"ipblockinfo": { -"$ref": "IPBlockInfoProto", -"description": "Information about an ip block, like range, speed etc. This could be the only thing present in an empty result." -} -}, -"type": "object" -}, -"LocationUnifiedOolongFeature": { -"description": "A featurelet corresponds to a single Mapfacts feature. These messages contain only the base data, without anything added by the Oolong policy (like trimming annotations or confidences). Next available tag: 11 LINT.IfChange", -"id": "LocationUnifiedOolongFeature", -"properties": { -"additionalData": { -"$ref": "MessageSet", -"description": "A field to attach additional data about the feature. For example, the location extraction server uses this field to include the ads criteria id of the featurelet if available. As specified by MessageSet, all types within the set must be unique. Using the changelist number where the message was created is a good method of ensuring uniqueness." -}, -"areaRank": { -"description": "Copy of FeatureProto->RankDetailsProto->area_rank", -"format": "float", -"type": "number" -}, -"center": { -"$ref": "GeostorePointProto", -"description": "Latitude and longitude of the feature center." -}, -"establishmentType": { -"description": "This field contains original feature's establishment type if it had one.", -"enum": [ -"TYPE_ANY", -"TYPE_UNDEFINED", -"TYPE_DEPRECATED_AVIATION", -"TYPE_BUSINESS", -"TYPE_TRAVEL_SERVICE", -"TYPE_LODGING", -"TYPE_HOTEL", -"TYPE_RESORT", -"TYPE_MOTEL", -"TYPE_HOSTEL", -"TYPE_GUESTHOUSE", -"TYPE_VACATION_RENTAL", -"TYPE_GAS_STATION", -"TYPE_REST_AREA", -"TYPE_CASH_MACHINE", -"TYPE_CAR_RENTAL", -"TYPE_CAR_REPAIR", -"TYPE_TAXI_STAND", -"TYPE_TRAVEL_AGENT", -"TYPE_BICYCLE_RENTAL_POINT", -"TYPE_ELECTRIC_VEHICLE_CHARGING_STATION", -"TYPE_SHOPPING", -"TYPE_GROCERY", -"TYPE_ANTIQUES", -"TYPE_APPAREL", -"TYPE_GIFTS", -"TYPE_JEWELRY", -"TYPE_SPORTING_GOODS", -"TYPE_VEHICLE", -"TYPE_SHOPPING_CENTER", -"TYPE_SUPERMARKET", -"TYPE_FAIRGROUNDS", -"TYPE_MARKET", -"TYPE_PRODUCE_MARKET", -"TYPE_FARMERS_MARKET", -"TYPE_LIQUOR_STORE", -"TYPE_SOUVENIR_SHOP", -"TYPE_INDUSTRIAL", -"TYPE_CONSTRUCTION", -"TYPE_BUILDING_MATERIAL", -"TYPE_SECURITY_PRODUCTS", -"TYPE_MECHANICAL", -"TYPE_TEXTILE", -"TYPE_CHEMICAL", -"TYPE_METAL", -"TYPE_TRANSPORTATION", -"TYPE_FREIGHT", -"TYPE_AVIATION", -"TYPE_COURIER", -"TYPE_MOVING", -"TYPE_PACKAGING", -"TYPE_RAIL", -"TYPE_PUBLIC_TRANSIT", -"TYPE_WAREHOUSE", -"TYPE_DEFENSE", -"TYPE_AGRICULTURE", -"TYPE_PLANTATION", -"TYPE_PLANT_NURSERY", -"TYPE_DESIGN", -"TYPE_UTILITIES", -"TYPE_POWER_PLANT", -"TYPE_SEWAGE_TREATMENT_PLANT", -"TYPE_WATER_TREATMENT_PLANT", -"TYPE_SUBSTATION", -"TYPE_MANUFACTURING", -"TYPE_BIOTECH", -"TYPE_MATERIALS", -"TYPE_MINING", -"TYPE_QUARRY", -"TYPE_TANNERY", -"TYPE_OIL_REFINERY", -"TYPE_ADVERTISING_MARKETING", -"TYPE_LEGAL", -"TYPE_FAMILY_LAW", -"TYPE_IP_LAW", -"TYPE_LABOR_LAW", -"TYPE_PERSONAL_INJURY_LAW", -"TYPE_CRIMINAL_LAW", -"TYPE_PERSONAL_FINANCE", -"TYPE_LIFE_INSURANCE", -"TYPE_LENDING", -"TYPE_ACCOUNTING", -"TYPE_INVESTING", -"TYPE_BANKING", -"TYPE_HEALTH", -"TYPE_HEALTH_EQUIPMENT", -"TYPE_NURSING", -"TYPE_HEALTH_INSURANCE", -"TYPE_HEALTH_FACILITY", -"TYPE_DIAGNOSTIC_CENTER", -"TYPE_HEALTH_RESOURCES", -"TYPE_NUTRITION", -"TYPE_VISION", -"TYPE_COUNSELING", -"TYPE_MASSAGE", -"TYPE_BLOOD_BANK", -"TYPE_HEARING", -"TYPE_HOME_GARDEN", -"TYPE_INTERIOR_DECOR", -"TYPE_DOMESTIC_SERVICES", -"TYPE_APPLIANCES", -"TYPE_PEST_CONTROL", -"TYPE_GARDENING", -"TYPE_ELECTRONICS", -"TYPE_COMPUTER", -"TYPE_COMPUTER_HARDWARE", -"TYPE_COMPUTER_SECURITY", -"TYPE_COMPUTER_SOFTWARE", -"TYPE_COMPUTER_SUPPORT", -"TYPE_AUDIO_DEVICES", -"TYPE_VIDEO_DEVICES", -"TYPE_REAL_ESTATE", -"TYPE_OFFICE_SERVICES", -"TYPE_ENTERTAINMENT", -"TYPE_GAMES", -"TYPE_CASINO", -"TYPE_LOTTO", -"TYPE_VIDEO", -"TYPE_CLUBS", -"TYPE_DISCOTHEQUE", -"TYPE_ANIMATION", -"TYPE_MODELING", -"TYPE_HUMOR", -"TYPE_MOVIES", -"TYPE_MOVIE_RENTAL", -"TYPE_MOVIE_THEATER", -"TYPE_MUSIC", -"TYPE_RADIO", -"TYPE_TV", -"TYPE_BAR", -"TYPE_PRINT_MEDIA", -"TYPE_ADULT", -"TYPE_SEXUAL_SERVICES", -"TYPE_ANIMALS", -"TYPE_PETS", -"TYPE_FISHERY", -"TYPE_ARTS", -"TYPE_BOOKS", -"TYPE_PERFORMING_ARTS", -"TYPE_GALLERY", -"TYPE_AUTOMOTIVE", -"TYPE_PARTS", -"TYPE_AUTO_FINANCE", -"TYPE_AUTO_INSURANCE", -"TYPE_RV", -"TYPE_MOTORCYCLES", -"TYPE_CARS", -"TYPE_TRUCKS_SUVS", -"TYPE_LICENSING", -"TYPE_MAINTENANCE", -"TYPE_PERSONAL_CARE", -"TYPE_BODY_ART", -"TYPE_COSMETICS", -"TYPE_FITNESS", -"TYPE_YOGA_CENTER", -"TYPE_GYM", -"TYPE_HAIR_CARE", -"TYPE_SPA", -"TYPE_BEAUTY_SALON", -"TYPE_CORPORATE_EVENTS", -"TYPE_HUMAN_RESOURCES", -"TYPE_FOOD_AND_DRINK", -"TYPE_BEVERAGE", -"TYPE_RECIPES", -"TYPE_COOKWARE", -"TYPE_CULINARY", -"TYPE_RETAIL", -"TYPE_RESTAURANT", -"TYPE_COFFEE", -"TYPE_BAKERY", -"TYPE_FOOD_CENTER", -"TYPE_TEA", -"TYPE_CAFE", -"TYPE_WINERY", -"TYPE_BREWERY", -"TYPE_FAST_FOOD", -"TYPE_FOOD_DELIVERY", -"TYPE_INTERNET", -"TYPE_WEB_DESIGN", -"TYPE_WEB_HOSTING", -"TYPE_WEB_SERVICES", -"TYPE_LIFESTYLE", -"TYPE_PHOTO_VIDEO", -"TYPE_ACTIVITIES", -"TYPE_BOATING", -"TYPE_CYCLING", -"TYPE_EQUESTRIAN", -"TYPE_FISHING", -"TYPE_HIKING", -"TYPE_HUNTING", -"TYPE_SWIMMING", -"TYPE_GOLF", -"TYPE_GOLF_COURSE", -"TYPE_BASEBALL", -"TYPE_BASKETBALL", -"TYPE_HOCKEY", -"TYPE_MOTOR_SPORTS", -"TYPE_WINTER_SPORTS", -"TYPE_FOOTBALL", -"TYPE_SOCCER", -"TYPE_ICE_SKATING", -"TYPE_BOXING", -"TYPE_CRICKET", -"TYPE_ROWING", -"TYPE_RUGBY", -"TYPE_RACQUET_SPORTS", -"TYPE_ROCK_CLIMBING", -"TYPE_REFERENCES", -"TYPE_MAPS", -"TYPE_TIME", -"TYPE_SCIENTIFIC_EQUIPMENT", -"TYPE_TELECOMMUNICATIONS", -"TYPE_EVENT_VENUE", -"TYPE_BANQUET_HALL", -"TYPE_CONFERENCE_HALL", -"TYPE_WEDDING_HALL", -"TYPE_EXHIBITION_HALL", -"TYPE_COMMUNITY_CENTER", -"TYPE_AUDITORIUM", -"TYPE_FUNCTION_HALL", -"TYPE_CONCERT_HALL", -"TYPE_AMPHITHEATER", -"TYPE_LAUNDRY", -"TYPE_LAUNDROMAT", -"TYPE_DRY_CLEANER", -"TYPE_MORTUARY", -"TYPE_REPAIR_AND_MAINTENANCE", -"TYPE_GOVERNMENT", -"TYPE_BORDER_CROSSING", -"TYPE_CITY_HALL", -"TYPE_COURTHOUSE", -"TYPE_EMBASSY", -"TYPE_LIBRARY", -"TYPE_PRISON", -"TYPE_TAX_OFFICE", -"TYPE_PROSECUTORS_OFFICE", -"TYPE_CONGRESS", -"TYPE_TOWN_COUNCIL", -"TYPE_CAPITOL_BUILDING", -"TYPE_VOTING_FACILITY", -"TYPE_CHECKPOINT", -"TYPE_SCHOOL", -"TYPE_UNIVERSITY", -"TYPE_ORPHANAGE", -"TYPE_KINDERGARTEN", -"TYPE_DAYCARE", -"TYPE_ACADEMY", -"TYPE_TRADE_SCHOOL", -"TYPE_SKILL_INSTRUCTION", -"TYPE_EMERGENCY", -"TYPE_HOSPITAL", -"TYPE_PHARMACY", -"TYPE_POLICE", -"TYPE_FIRE", -"TYPE_DOCTOR", -"TYPE_DENTIST", -"TYPE_VETERINARIAN", -"TYPE_FIRST_AID", -"TYPE_CIVIL_DEFENSE", -"TYPE_TOURIST_DESTINATION", -"TYPE_ECO_TOURIST_DESTINATION", -"TYPE_BIRD_WATCHING", -"TYPE_NATURE_RESERVE", -"TYPE_MUSEUM", -"TYPE_VISITOR_CENTER", -"TYPE_OBSERVATION_DECK", -"TYPE_OBSERVATORY", -"TYPE_SCENIC_POINT", -"TYPE_ZOO", -"TYPE_AQUARIUM", -"TYPE_AMUSEMENT_PARK", -"TYPE_MONUMENT", -"TYPE_PALACE", -"TYPE_FORT", -"TYPE_TOWER", -"TYPE_LIGHTHOUSE", -"TYPE_TEMPLE", -"TYPE_CHURCH", -"TYPE_GURUDWARA", -"TYPE_HINDU_TEMPLE", -"TYPE_MOSQUE", -"TYPE_SYNAGOGUE", -"TYPE_BUDDHIST_TEMPLE", -"TYPE_JAIN_TEMPLE", -"TYPE_BAHAI_TEMPLE", -"TYPE_SHINTO_TEMPLE", -"TYPE_MORMON_TEMPLE", -"TYPE_SPORTS_COMPLEX", -"TYPE_STADIUM", -"TYPE_BOWLING", -"TYPE_BADMINTON", -"TYPE_TENNIS", -"TYPE_TABLE_TENNIS", -"TYPE_PARK", -"TYPE_LOCAL_PARK", -"TYPE_NATIONAL_PARK", -"TYPE_US_NATIONAL_PARK", -"TYPE_US_NATIONAL_MONUMENT", -"TYPE_NATIONAL_FOREST", -"TYPE_NATIONAL_GRASSLAND", -"TYPE_NATIONAL_PRESERVE", -"TYPE_NATIONAL_RECREATION_AREA", -"TYPE_NATIONAL_MONUMENT", -"TYPE_NATIONAL_HISTORIC_AREA", -"TYPE_NATIONAL_SCENIC_AREA", -"TYPE_NATIONAL_SCENIC_ROADWAY_AREA", -"TYPE_NATIONAL_SCENIC_RIVER_AREA", -"TYPE_PROVINCIAL_PARK", -"TYPE_PROVINCIAL_FOREST", -"TYPE_CAMPGROUNDS", -"TYPE_WILDERNESS_AREA", -"TYPE_WILDLIFE_AREA", -"TYPE_BOTANICAL_GARDEN", -"TYPE_GARDEN", -"TYPE_ARBORETUM", -"TYPE_MARINE_PROTECTED_AREA", -"TYPE_AIRPORT", -"TYPE_TARMAC", -"TYPE_HELIPORT", -"TYPE_SEAPLANE_BASE", -"TYPE_MILITARY_AIRBASE", -"TYPE_CEMETERY", -"TYPE_MILITARY", -"TYPE_ENCLOSED_TRAFFIC_AREA", -"TYPE_PARKING", -"TYPE_OFF_ROAD_AREA", -"TYPE_POST_OFFICE", -"TYPE_HOUSING_DEVELOPMENT", -"TYPE_BRIDGE", -"TYPE_ARCHAEOLOGICAL", -"TYPE_HISTORICAL", -"TYPE_RUINS", -"TYPE_TUNNEL", -"TYPE_RESIDENTIAL_DWELLING", -"TYPE_DETACHED_DWELLING", -"TYPE_ATTACHED_DWELLING", -"TYPE_APARTMENT", -"TYPE_GATED_COMMUNITY", -"TYPE_RETIREMENT_HOME", -"TYPE_TOLL_BOOTH", -"TYPE_CULTURAL", -"TYPE_CULTURAL_CENTER", -"TYPE_OVERPASS", -"TYPE_REST_ROOM", -"TYPE_PUBLIC_PHONE", -"TYPE_PHONE_BOOTH", -"TYPE_MANNED_PCO", -"TYPE_RESEARCH_INSTITUTE", -"TYPE_NON_GOVERNMENTAL_ORGANIZATION", -"TYPE_OFFICE_PARK", -"TYPE_MEDITATION_CENTER", -"TYPE_RELIGIOUS", -"TYPE_MONASTERY", -"TYPE_ASHRAM", -"TYPE_PAGODA", -"TYPE_MISSION", -"TYPE_PILGRIM_DESTINATION", -"TYPE_SOCIAL_SERVICE", -"TYPE_RANGER_STATION", -"TYPE_TRANSIT_STATION", -"TYPE_BUS_STATION", -"TYPE_TRAMWAY_STATION", -"TYPE_TRAIN_STATION", -"TYPE_SUBWAY_STATION", -"TYPE_FERRY_TERMINAL", -"TYPE_CABLE_CAR_STATION", -"TYPE_GONDOLA_LIFT_STATION", -"TYPE_FUNICULAR_STATION", -"TYPE_HORSE_CARRIAGE_STATION", -"TYPE_MONORAIL_STATION", -"TYPE_SEAPORT", -"TYPE_NATURAL_FEATURE", -"TYPE_ELEVATED", -"TYPE_PEAK" -], -"enumDescriptions": [ -"ABSTRACT", -"Can be used for features where no establishment information is available. For example, if an importer generates a TYPE_ESTABLISHMENT_BUILDING feature, but source data does not have any information on the actual purpose of the building, the importer should use TYPE_UNDEFINED for establishment type.", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Note: 0xF213F is reserved to extend TYPE_INDUSTRIAL", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"0xF6F is reserved and any new types should start with 0xF6F1", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"State parks, county parks, city parks, wilderness areas. This also includes underwater preserves, wild and scenic rivers, etc. Should we have things like baseball diamonds?", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Wildlife management area. This includes preservation areas for fish, game, and birds.", -"", -"", -"", -"", -"", -"An airport is a location where aircraft such as fixed-wing aircraft, helicopters, and blimps takeoff and land. NOTE: TYPE_TARMAC establishment type has been deprecated in favor of TYPE_TARMAC feature type. Once all data is modeled using the new feature type, the entry below should be removed.", -"DEPRECATED", -"A heliport is a small airport suitable only for use by helicopters.", -"A seaplane base is a special airport suitable for seaplanes.", -"An airbase (sometimes referred to correctly as an airfield, military airport, or Royal Air Force Station or Air Force Station) is a military airfield that provides basing and support of military aircraft.", -"", -"", -"The term \"enclosed traffic area\" is used extensively in Europe. It generally refers to a parking lot or other similar area through which traffic passes but are not generally considered to be a road. Another example is a piazza in an Italian town.", -"Establishment TYPE_PARKING is used for parking lots or garages. The actual feature type can be TYPE_ESTABLISHMENT_GROUNDS or TYPE_ESTABLISHMENT_BUILDING to distinguish between those.", -"", -"", -"In some country (like China), there will have a small area of housing development. Normally covers one or more city blocks.", -"In the Australian data we get bridges as POIs effectively. We'd like to include them so we can mapsearch for \"Sydney Harbour Bridge\" and others. Many other data sets have bridges modeled directly as segments, and so don't require this.", -"", -"In some countries historical objects are well known and important.", -"", -"Feature must be TYPE_ESTABLISHMENT_GROUNDS.", -"These types, when used with appropriate feature type (TYPE_ESTABLISHMENT_BUILDING, TYPE_ESTABLISHMENT_GROUNDS) can refer to a single building or a residential area (respectively).", -"", -"", -"All multi-unit housing such as duplex, condominium, apartment belongs to this.", -"", -"", -"In Korea most toll booths have their own names, and are often used as reference points. If an importer generates TYPE_TOLL_BOOTH establishment features with exact positions and names, then mapsearch will index them. Also this can be used to render them.", -"", -"", -"An overpass, or flyover is a structure that passes over another road or railway.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"Hierarchy of transit station types. See go/transit-schema for more details.", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"" -], -"type": "string" -}, -"featureId": { -"$ref": "GeostoreFeatureIdProto", -"description": "The GeoStore Feature ID for this feature. This value is also used as key into the feature pool from FeatureReference's." -}, -"kgReference": { -"$ref": "GeostoreKnowledgeGraphReferenceProto", -"description": "The reference to an entity in the KnowledgeGraph." -}, -"name": { -"description": "Each Featurelet includes the list of names that are associated with the corresponding GeoStore Feature.", -"items": { -"$ref": "GeostoreNameProto" -}, -"type": "array" -}, -"populationRank": { -"description": "Copy of FeatureProto->RankDetailsProto->population_rank", -"format": "float", -"type": "number" -}, -"rect": { -"$ref": "GeostoreRectProto", -"description": "The bounding box of this feature." -}, -"type": { -"description": "The GeoStore Feature type.", -"enum": [ -"TYPE_ANY", -"TYPE_TRANSPORTATION", -"TYPE_ROUTE", -"TYPE_DEPRECATED_HIGHWAY_DO_NOT_USE", -"TYPE_HIGHWAY", -"TYPE_HIGHWAY_1", -"TYPE_HIGHWAY_2", -"TYPE_HIGHWAY_3", -"TYPE_HIGHWAY_4", -"TYPE_HIGHWAY_5", -"TYPE_HIGHWAY_6", -"TYPE_HIGHWAY_7", -"TYPE_HIGHWAY_8", -"TYPE_HIGHWAY_9", -"TYPE_BICYCLE_ROUTE", -"TYPE_TRAIL", -"TYPE_SEGMENT", -"TYPE_ROAD", -"TYPE_RAILWAY", -"TYPE_STANDARD_TRACK", -"TYPE_JR_TRACK", -"TYPE_NARROW_TRACK", -"TYPE_MONORAIL_TRACK", -"TYPE_SUBWAY_TRACK", -"TYPE_LIGHT_RAIL_TRACK", -"TYPE_BROAD_TRACK", -"TYPE_HIGH_SPEED_RAIL", -"TYPE_TROLLEY_TRACK", -"TYPE_FERRY", -"TYPE_FERRY_BOAT", -"TYPE_FERRY_TRAIN", -"TYPE_VIRTUAL_SEGMENT", -"TYPE_INTERSECTION", -"TYPE_TRANSIT", -"TYPE_TRANSIT_STATION", -"TYPE_BUS_STATION", -"TYPE_TRAMWAY_STATION", -"TYPE_TRAIN_STATION", -"TYPE_SUBWAY_STATION", -"TYPE_FERRY_TERMINAL", -"TYPE_AIRPORT", -"TYPE_AIRPORT_CIVIL", -"TYPE_AIRPORT_MILITARY", -"TYPE_AIRPORT_MIXED", -"TYPE_HELIPORT", -"TYPE_SEAPLANE_BASE", -"TYPE_AIRSTRIP", -"TYPE_CABLE_CAR_STATION", -"TYPE_GONDOLA_LIFT_STATION", -"TYPE_FUNICULAR_STATION", -"TYPE_SPECIAL_STATION", -"TYPE_HORSE_CARRIAGE_STATION", -"TYPE_MONORAIL_STATION", -"TYPE_SEAPORT", -"TYPE_TRANSIT_STOP", -"TYPE_TRANSIT_TRIP", -"TYPE_TRANSIT_DEPARTURE", -"TYPE_TRANSIT_LEG", -"TYPE_TRANSIT_LINE", -"TYPE_TRANSIT_AGENCY_DEPRECATED_VALUE", -"TYPE_TRANSIT_TRANSFER", -"TYPE_SEGMENT_PATH", -"TYPE_ROAD_SIGN", -"TYPE_INTERSECTION_GROUP", -"TYPE_PATHWAY", -"TYPE_RESTRICTION_GROUP", -"TYPE_TOLL_CLUSTER", -"TYPE_POLITICAL", -"TYPE_COUNTRY", -"TYPE_ADMINISTRATIVE_AREA", -"TYPE_ADMINISTRATIVE_AREA1", -"TYPE_US_STATE", -"TYPE_GB_COUNTRY", -"TYPE_JP_TODOUFUKEN", -"TYPE_ADMINISTRATIVE_AREA2", -"TYPE_GB_FORMER_POSTAL_COUNTY", -"TYPE_GB_TRADITIONAL_COUNTY", -"TYPE_ADMINISTRATIVE_AREA3", -"TYPE_ADMINISTRATIVE_AREA4", -"TYPE_ADMINISTRATIVE_AREA5", -"TYPE_ADMINISTRATIVE_AREA6", -"TYPE_ADMINISTRATIVE_AREA7", -"TYPE_ADMINISTRATIVE_AREA8", -"TYPE_ADMINISTRATIVE_AREA9", -"TYPE_COLLOQUIAL_AREA", -"TYPE_RESERVATION", -"TYPE_LOCALITY", -"TYPE_GB_POST_TOWN", -"TYPE_JP_GUN", -"TYPE_JP_SHIKUCHOUSON", -"TYPE_JP_SUB_SHIKUCHOUSON", -"TYPE_COLLOQUIAL_CITY", -"TYPE_SUBLOCALITY", -"TYPE_US_BOROUGH", -"TYPE_GB_DEPENDENT_LOCALITY", -"TYPE_JP_OOAZA", -"TYPE_JP_KOAZA", -"TYPE_JP_GAIKU", -"TYPE_GB_DOUBLE_DEPENDENT_LOCALITY", -"TYPE_JP_CHIBAN", -"TYPE_JP_EDABAN", -"TYPE_SUBLOCALITY1", -"TYPE_SUBLOCALITY2", -"TYPE_SUBLOCALITY3", -"TYPE_SUBLOCALITY4", -"TYPE_SUBLOCALITY5", -"TYPE_NEIGHBORHOOD", -"TYPE_CONSTITUENCY", -"TYPE_DESIGNATED_MARKET_AREA", -"TYPE_SCHOOL_DISTRICT", -"TYPE_LAND_PARCEL", -"TYPE_DISPUTED_AREA", -"TYPE_POLICE_JURISDICTION", -"TYPE_STATISTICAL_AREA", -"TYPE_CONSTITUENCY_FUTURE", -"TYPE_PARK", -"TYPE_GOLF_COURSE", -"TYPE_LOCAL_PARK", -"TYPE_NATIONAL_PARK", -"TYPE_US_NATIONAL_PARK", -"TYPE_US_NATIONAL_MONUMENT", -"TYPE_NATIONAL_FOREST", -"TYPE_PROVINCIAL_PARK", -"TYPE_PROVINCIAL_FOREST", -"TYPE_CAMPGROUNDS", -"TYPE_HIKING_AREA", -"TYPE_BUSINESS", -"TYPE_GOVERNMENT", -"TYPE_BORDER_CROSSING", -"TYPE_CITY_HALL", -"TYPE_COURTHOUSE", -"TYPE_EMBASSY", -"TYPE_LIBRARY", -"TYPE_SCHOOL", -"TYPE_UNIVERSITY", -"TYPE_EMERGENCY", -"TYPE_HOSPITAL", -"TYPE_PHARMACY", -"TYPE_POLICE", -"TYPE_FIRE", -"TYPE_DOCTOR", -"TYPE_DENTIST", -"TYPE_VETERINARIAN", -"TYPE_TRAVEL_SERVICE", -"TYPE_LODGING", -"TYPE_RESTAURANT", -"TYPE_GAS_STATION", -"TYPE_PARKING", -"TYPE_POST_OFFICE", -"TYPE_REST_AREA", -"TYPE_CASH_MACHINE", -"TYPE_CAR_RENTAL", -"TYPE_CAR_REPAIR", -"TYPE_SHOPPING", -"TYPE_GROCERY", -"TYPE_TOURIST_DESTINATION", -"TYPE_ECO_TOURIST_DESTINATION", -"TYPE_BIRD_WATCHING", -"TYPE_FISHING", -"TYPE_HUNTING", -"TYPE_NATURE_RESERVE", -"TYPE_TEMPLE", -"TYPE_CHURCH", -"TYPE_GURUDWARA", -"TYPE_HINDU_TEMPLE", -"TYPE_MOSQUE", -"TYPE_SYNAGOGUE", -"TYPE_STADIUM", -"TYPE_BAR", -"TYPE_MOVIE_RENTAL", -"TYPE_COFFEE", -"TYPE_GOLF", -"TYPE_BANK", -"TYPE_DOODLE", -"TYPE_GROUNDS", -"TYPE_AIRPORT_GROUNDS", -"TYPE_BUILDING_GROUNDS", -"TYPE_CEMETERY", -"TYPE_HOSPITAL_GROUNDS", -"TYPE_INDUSTRIAL", -"TYPE_MILITARY", -"TYPE_SHOPPING_CENTER", -"TYPE_SPORTS_COMPLEX", -"TYPE_UNIVERSITY_GROUNDS", -"TYPE_DEPRECATED_TARMAC", -"TYPE_ENCLOSED_TRAFFIC_AREA", -"TYPE_PARKING_LOT", -"TYPE_PARKING_GARAGE", -"TYPE_OFF_ROAD_AREA", -"TYPE_BORDER", -"TYPE_BUILDING", -"TYPE_GEOCODED_ADDRESS", -"TYPE_NATURAL_FEATURE", -"TYPE_TERRAIN", -"TYPE_SAND", -"TYPE_BEACH", -"TYPE_DUNE", -"TYPE_ROCKY", -"TYPE_ICE", -"TYPE_GLACIER", -"TYPE_BUILT_UP_AREA", -"TYPE_VEGETATION", -"TYPE_SHRUBBERY", -"TYPE_WOODS", -"TYPE_AGRICULTURAL", -"TYPE_GRASSLAND", -"TYPE_TUNDRA", -"TYPE_DESERT", -"TYPE_SALT_FLAT", -"TYPE_WATER", -"TYPE_OCEAN", -"TYPE_BAY", -"TYPE_BIGHT", -"TYPE_LAGOON", -"TYPE_SEA", -"TYPE_STRAIT", -"TYPE_INLET", -"TYPE_FJORD", -"TYPE_LAKE", -"TYPE_SEASONAL_LAKE", -"TYPE_RESERVOIR", -"TYPE_POND", -"TYPE_RIVER", -"TYPE_RAPIDS", -"TYPE_DISTRIBUTARY", -"TYPE_CONFLUENCE", -"TYPE_WATERFALL", -"TYPE_SPRING", -"TYPE_GEYSER", -"TYPE_HOT_SPRING", -"TYPE_SEASONAL_RIVER", -"TYPE_WADI", -"TYPE_ESTUARY", -"TYPE_WETLAND", -"TYPE_WATER_NAVIGATION", -"TYPE_FORD", -"TYPE_CANAL", -"TYPE_HARBOR", -"TYPE_CHANNEL", -"TYPE_REEF", -"TYPE_REEF_FLAT", -"TYPE_REEF_GROWTH", -"TYPE_REEF_EXTENT", -"TYPE_REEF_ROCK_SUBMERGED", -"TYPE_IRRIGATION", -"TYPE_DAM", -"TYPE_DRINKING_WATER", -"TYPE_CURRENT", -"TYPE_WATERING_HOLE", -"TYPE_TECTONIC", -"TYPE_WATERING_HOLE_DEPRECATED", -"TYPE_VOLCANO", -"TYPE_LAVA_FIELD", -"TYPE_FISSURE", -"TYPE_FAULT", -"TYPE_LAND_MASS", -"TYPE_CONTINENT", -"TYPE_ISLAND", -"TYPE_ATOLL", -"TYPE_OCEAN_ROCK_EXPOSED", -"TYPE_CAY", -"TYPE_PENINSULA", -"TYPE_ISTHMUS", -"TYPE_ELEVATED", -"TYPE_PEAK", -"TYPE_NUNATAK", -"TYPE_SPUR", -"TYPE_PASS", -"TYPE_PLATEAU", -"TYPE_RIDGE", -"TYPE_RAVINE", -"TYPE_CRATER", -"TYPE_KARST", -"TYPE_CLIFF", -"TYPE_VISTA", -"TYPE_DIGITAL_ELEVATION_MODEL", -"TYPE_UPLAND", -"TYPE_TERRACE", -"TYPE_SLOPE", -"TYPE_CONTOUR_LINE", -"TYPE_PAN", -"TYPE_UNSTABLE_HILLSIDE", -"TYPE_MOUNTAIN_RANGE", -"TYPE_UNDERSEA", -"TYPE_SUBMARINE_SEAMOUNT", -"TYPE_SUBMARINE_RIDGE", -"TYPE_SUBMARINE_GAP", -"TYPE_SUBMARINE_PLATEAU", -"TYPE_SUBMARINE_DEEP", -"TYPE_SUBMARINE_VALLEY", -"TYPE_SUBMARINE_BASIN", -"TYPE_SUBMARINE_SLOPE", -"TYPE_SUBMARINE_CLIFF", -"TYPE_SUBMARINE_PLAIN", -"TYPE_SUBMARINE_FRACTURE_ZONE", -"TYPE_CAVE", -"TYPE_ROCK", -"TYPE_ARCHIPELAGO", -"TYPE_POSTAL", -"TYPE_POSTAL_CODE", -"TYPE_POSTAL_CODE_PREFIX", -"TYPE_PREMISE", -"TYPE_SUB_PREMISE", -"TYPE_SUITE", -"TYPE_POST_TOWN", -"TYPE_POSTAL_ROUND", -"TYPE_META_FEATURE", -"TYPE_DATA_SOURCE", -"TYPE_LOCALE", -"TYPE_TIMEZONE", -"TYPE_BUSINESS_CHAIN", -"TYPE_PHONE_NUMBER_PREFIX", -"TYPE_PHONE_NUMBER_AREA_CODE", -"TYPE_BUSINESS_CORRIDOR", -"TYPE_ADDRESS_TEMPLATE", -"TYPE_TRANSIT_AGENCY", -"TYPE_FUTURE_GEOMETRY", -"TYPE_EVENT", -"TYPE_EARTHQUAKE", -"TYPE_HURRICANE", -"TYPE_WEATHER_CONDITION", -"TYPE_TRANSIENT", -"TYPE_ENTRANCE", -"TYPE_CARTOGRAPHIC", -"TYPE_HIGH_TENSION", -"TYPE_SKI_TRAIL", -"TYPE_SKI_LIFT", -"TYPE_SKI_BOUNDARY", -"TYPE_WATERSHED_BOUNDARY", -"TYPE_TARMAC", -"TYPE_WALL", -"TYPE_PICNIC_AREA", -"TYPE_PLAY_GROUND", -"TYPE_TRAIL_HEAD", -"TYPE_GOLF_TEEING_GROUND", -"TYPE_GOLF_PUTTING_GREEN", -"TYPE_GOLF_ROUGH", -"TYPE_GOLF_SAND_BUNKER", -"TYPE_GOLF_FAIRWAY", -"TYPE_GOLF_HOLE", -"TYPE_DEPRECATED_GOLF_SHOP", -"TYPE_CAMPING_SITE", -"TYPE_DESIGNATED_BARBECUE_PIT", -"TYPE_DESIGNATED_COOKING_AREA", -"TYPE_CAMPFIRE_PIT", -"TYPE_WATER_FOUNTAIN", -"TYPE_LITTER_RECEPTACLE", -"TYPE_LOCKER_AREA", -"TYPE_ANIMAL_ENCLOSURE", -"TYPE_CARTOGRAPHIC_LINE", -"TYPE_ESTABLISHMENT", -"TYPE_ESTABLISHMENT_GROUNDS", -"TYPE_ESTABLISHMENT_BUILDING", -"TYPE_ESTABLISHMENT_POI", -"TYPE_ESTABLISHMENT_SERVICE", -"TYPE_CELESTIAL", -"TYPE_ROAD_MONITOR", -"TYPE_PUBLIC_SPACES_AND_MONUMENTS", -"TYPE_STATUE", -"TYPE_TOWN_SQUARE", -"TYPE_LEVEL", -"TYPE_COMPOUND", -"TYPE_COMPOUND_GROUNDS", -"TYPE_COMPOUND_BUILDING", -"TYPE_COMPOUND_SECTION", -"TYPE_TERMINAL_POINT", -"TYPE_REGULATED_AREA", -"TYPE_LOGICAL_BORDER", -"TYPE_GCONCEPT_ONLY", -"TYPE_DO_NOT_USE_RESERVED_TO_CATCH_GENERATED_FILES", -"TYPE_UNKNOWN" -], -"enumDeprecated": [ -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -false, -true, -true, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -true, -true, -true, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -true, -false, -false, -true, -true, -true, -true, -true, -true, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -true, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -true, -true, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -true, -false -], -"enumDescriptions": [ -"ABSTRACT", -"ABSTRACT", -"A route is any section of road (or rails, etc.) that has a name. This includes city streets as well as highways. Road segments can belong to multiple routes (e.g. El Camino, CA-82).", -"DEPRECATED", -"ABSTRACT", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"A designated bicycle route, whose segments may consist of any combination of bicycle paths, bicycle lanes, or city streets.", -"A designated trail, which may consist of paved walkways, dirt paths, fire road, streets or highways, etc.", -"ABSTRACT", -"", -"Railroads use several different incompatible track types.", -"", -"", -"", -"", -"", -"", -"", -"", -"Tracks for streetcars, cable-cars, etc. Ferries are services that are part of the road network but are not roads. They typically involve fares and scheduled departure times.", -"ABSTRACT", -"The vast majority of ferries are ferry boats.", -"Also called a \"car transport\", a ferry train is a rail service that carries passengers and their vehicles across undrivable terrain. The Channel Tunnel (\"Chunnel\") is the most famous example, but they are also common in the Alps where they connect neighboring valleys otherwise separated by impassable mountains.", -"Any plausible 1-dimensional path through a 2+ dimensional space, for the purposes of making graph-search-based routing possible. Such segments can be used to model paths through parking lots, squares, floors of buildings and other areas.", -"An intersection consists of a collection of segments that terminate at the same location. This is topological definition: it may not match what a typical user would think of as an \"intersection\". See TYPE_INTERSECTION_GROUP, below, for more information. Each segment terminating at an intersection has an \"endpoint type\" that specifies how that segment is terminated: stop sign, yield sign, three-way light, etc.", -"ABSTRACT", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"A transit line is a collection of transit legs, associated with some invariant properties of the trips that run over the legs. See also transitline.proto", -"TYPE_TRANSIT_AGENCY was moved to 0xC91. This deprecated enum value still exists for debugging purposes only.", -"DEPRECATED", -"ABSTRACT", -"Road sign features have names, point geometry, etc. They also have segment_path data (see below) which lists the segments that refer to the sign. See segment.proto for the reference from the segment to the road sign.", -"Our TYPE_INTERSECTION feature, above, models the point where one or more segments terminate. This is topological definition: it may not match what a typical user would think of as an \"intersection\". Consider the intersections where Hayes, Market, Larkin, and 9th Street meet near (37.77765, -122.41638) in San Francisco. Most people would probably consider this a single feature, even though we model it as four separate TYPE_INTERSECTION features. This TYPE_INTERSECTION_GROUP is used to model the user's concept of a complex intersection.", -"RESERVED", -"A restriction group describes a set of segment restrictions that belong together and have a name or an associated event. See also restriction_group.proto", -"DEPRECATED", -"ABSTRACT", -"", -"ABSTRACT", -"", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"", -"DEPRECATED", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"", -"e.g. Silicon Valley", -"A reservation is a region collectively held or governed by indigenous people and officially recognized by the country\u2019s government at the federal or state level. A reservation may be fully contained within an administrative feature or partially contained within two or more. These regions are referred to by different categorical names depending on country and even by state, including but not limited to: \u201cIndian Reservations\u201d, \u201cIndian Reserves\u201d, \u201cLand Claim Settlement Lands\u201d, \u201cIndian Lands\u201d, \u201cTreaty Lands\u201d, \u201cIndigenous Territories\u201d, etc. A reservation is not a historic indigenous territory boundary or a region which has applied for land rights but has not yet received official recognition.", -"", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"An entity widely considered to be a city, that may itself be made up of smaller political entities, some of which are cities/towns/villages themselves. For example, the colloquial view of Sydney, Australia actually comprises many smaller cities, but is regarded as a city itself. This type is not suitable for modeling official metro-/micropolitan or other statistical areas.", -"ABSTRACT", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"", -"Designated Market Areas (or DMAs) are used by marketing and ratings companies (such as the Nielsen Media Research company) to describe geographical regions (such as the greater New York metropolitan area) that are covered by a set of television stations. (See http://www.schooldata.com/pdfs/DMA.pdf) In the United States, DMAs should have a DMA numeric ID name, tagged with the FLAG_DESIGNATED_MARKET_AREA_ID flag.", -"", -"", -"Eventually we'll have more data for disputed areas (e.g., who makes claims on the area, who has de facto control, etc.). For the moment, we just define a type so we can simply mark areas as disputed.", -"Boundaries representing the jurisdiction of a particular police station.", -"An area used for aggregating statistical data, eg, a census region. Note that TYPE_STATISTICAL_AREA has a third nibble so we can add an abstract parent above it later if need be at 0x2E1 (and rename TYPE_STATISTICAL_AREA as TYPE_STATISTICAL_AREA1).", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"A line representing the boundary between two features. See border.proto for details.", -"DEPRECATED", -"An association of a point with an address, with no other information.", -"ABSTRACT", -"Expanses of land that share common surface attributes. These areas would look more or less uniform from a high altitude.", -"", -"", -"", -"", -"", -"", -"Terrain that looks populated.", -"Terrain that is covered in vegetation.", -"", -"", -"", -"", -"", -"", -"A flat expanse of salt left by the evaporation of a body of salt water.", -"Features can be TYPE_WATER if we don't have enough information to properly type the body of water. TYPE_WATER is also used as the type for child features that compose a TYPE_RIVER feature.", -"One of the large salt-water bodies that covers most of the globe.", -"An ocean subdivision formed by a coastal indentation. Includes coves and gulfs.", -"An open body of water formed by a slight coastal indentation.", -"", -"An ocean subdivision more or less confined by land and islands.", -"A long narrow ocean subdivision. Includes sounds.", -"", -"", -"An inland body of standing water.", -"A lake that dries up part of the year.", -"An artificial body of water, possibly created by a dam, often used for irrigation or house use.", -"", -"An inland body of moving water, or parts associated with it in which there is little or no current (backwater).", -"", -"A branch which flows away from the main river. Includes deltas.", -"A place where two or more rivers join.", -"", -"A place where ground water flows naturally out of the ground.", -"", -"", -"A river that dries up part of the year.", -"A dry riverbed that occasionally receives flashfloods.", -"A place at the end of a river where fresh and salt water mix. Includes tidal creeks and limans.", -"Land that is usually flooded. Includes bogs, marshes, flats, moors, and swamps.", -"", -"A shallow place where water may be waded through.", -"A narrow passage used by boats. Normally artificial.", -"A deep place near a shore where ships commonly drop anchor.", -"A deep part in a body of water that is suitable for navigation. Includes narrows.", -"Rocks, coral, sandbars, or other features beneath the surface of the water that pose a hazard to passing ships. Includes shoals.", -"A relatively shallow zone of the back reef located closest to the shore, that may be exposed at low tide.", -"A small section of rocks, coral, sandbars, or other features beneath the surface of the water that forms part of a reef.", -"The full extent of the reef complex.", -"A submerged rock in the water.", -"Man-made (and sometimes natural) channels used to move water. This type was used for both dam structures and water that is hold back by dams. We should use TYPE_COMPOUND_BUILDING for dam structures and TYPE_RESERVOIR for water.", -"DEPRECATED", -"", -"Includes overfalls.", -"A natural depression filled with water where animals come to drink.", -"This type is incorrectly under TYPE_TECTONIC instead of TYPE_WATER. This was a mistake and is now fixed. See TYPE_WATERING_HOLE for the replacement.", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"", -"", -"An exposed rock in the water.", -"A small, low-elevation, sandy island formed on the surface of coral reefs", -"A stretch of land projecting into water. Includes capes and spits.", -"A strip of land connecting two larger land masses, such as continents.", -"Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", -"Elevations that have a distinctive peak.", -"A peak or ridge of a mountain that extends through a glacier.", -"A subsidiary peak of a mountain.", -"A route over an otherwise difficult to traverse feature. Includes saddle.", -"Elevations that are flat on top. Includes mesas and buttes.", -"A ridge is a geographical feature consisting of a chain of mountains or hills that form a continuous elevated crest with a single ridgeline for some distance.", -"Steep declines usually carved by erosion. Includes valleys, canyons, ditches, and gorges.", -"Depressions causes by impact, explosion, and sometimes sink-holes.", -"Topography formed on limestone and gypsum by dissolution with sinkholes, caves, etc.", -"A vertical or nearly vertical slope. Includes escarpments.", -"An elevated place that is notable for having a good view. Raster digital elevation data. This is not a type to be used by providers or consumed by clients.", -"RESERVED", -"Land along streams higher than the alluvial plain or stream terrace.", -"", -"Land not so steep as a cliff, but changing elevation. Includes slides.", -"All the points on the polygon are at the same elevation.", -"A near-level shallow, natural depression or basin, usually containing an intermittent lake, pond, or pool.", -"", -"A series of mountains or hills ranged in a line and connected by high ground. Mountain ranges usually consist of many smaller ridges. For example, the Himalayas, the Andes. the Alps, etc.", -"Features that are notable for being high (or low), or for having sudden changes in elevation. These features might have an \"elevation\" extension to specify the actual elevation. See ElevationProto for more information.", -"includes peaks, ranges, and spurs", -"", -"includes saddles", -"", -"", -"includes trenches and troughs", -"", -"", -"", -"", -"", -"Don't use 0xA7. Use 8 bits for additional types under TYPE_NATURAL_FEATURE, so we don't run out of space. The following are miscellaneous natural features that don't fit any of the categories above.", -"", -"A feature representing a group or chain of islands. ", -"ABSTRACT", -"This is the type for postal codes which are complete and independent enough that there should be a feature for them (e.g. US 5-digit ZIP codes). For even more detailed suffixes that further subdivide a postal code (such as the +4 component in US ZIP codes), store the information in a TYPE_POSTAL_CODE_SUFFIX address component. When a range or set of postal codes share the same geographical area, e.g. because a precise subdivision does not exist or this subdivision is unknown, this type is used for each individual postal code.", -"A prefix portion of a postal code which does not meet the requirements for TYPE_POSTAL_CODE, but which is useful to search for, for example UK outcodes.", -"DEPRECATED", -"DEPRECATED This is deprecated and we want to use TYPE_COMPOUND_SECTION instead.", -"DEPRECATED", -"The term \"post town\" is used for a locality-like-entity that is only used for postal addresses.", -"DEPRECATED", -"ABSTRACT", -"Every data source used in constructing a data repository has a corresponding feature that provides more information about that data source. The extra information is stored in the optional data_source field below.", -"A locale feature provides region specific conventions such as preferred language and formatting details for time, date, and currency values. Locales aren't necessary defined by physical geographic features, so they are classified as meta-features.", -"A timezone feature is used to specify the region covering an international timezone. When a point is covered by multiple timezone features, the most specific one can be used to compute the local time at this point. Most specific implies a much smaller region or the one that is closer to the center. A feature's timezone can be specified in the repeated related_timezone field.", -"A business chain feature is used to represent a chain, e.g. Starbucks, McDonald's, etc. Other features representing specific stores/franchises of this chain may refer to one such feature via RELATION_MEMBER_OF_CHAIN. This is not strictly reserved to commercial chains but can also be used to model organizations such as the Red Cross or the United Nations.", -"A phone number prefix feature is used to specify the region where phone numbers (typically fixed-line numbers) must begin with a certain prefix. Any phone number prefix down to any level of granularity could be represented by this type.", -"A phone number area code is a prefix which also coincides with the area code, or national destination code, of a particular region.", -"A Business Corridor is a dense cluster of semantically similar establishments. TYPE_BUSINESS_CORRIDOR features are distinguished from TYPE_COLLOQUIAL_AREA features because the corridors are not under the political hierarchy, are allowed to be nameless, and may not correspond to well-known real world locations. For more details, see go/geo-corridors-schema.", -"An address template feature provides region-specific conventions for structuring addresses. These features aren't necessarily defined by physical geographic features, so they are classified as meta-features.", -"A transit agency operates a number of lines, typically all in the same city, region or country. See also transitagency.proto", -"A feature whose geometry is planned to replace the geometry on another feature.", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"DEPRECATED", -"RESERVED", -"A portal of entry or exit to another feature. Examples: - Subway station entrance. - Parking lot entrance.", -"Cartographic features are used to capture real-world objects for which there is no current desire to model any specific attributes. These are only useful to make the map tiles look pretty.", -"DEPRECATED", -"Also see skitrail.proto", -"Also see skilift.proto", -"Also see skiboundary.proto", -"", -"Starting with TYPE_TARMAC, we use longer IDs, so that we can expand the number of feature types under TYPE_CARTOGRAPHIC.", -"Use TYPE_COMPOUND_GROUND and appropriate gcids for the next two.", -"DEPRECATED", -"DEPRECATED", -"", -"Sub-types within a golf course.", -"", -"", -"", -"", -"Use TYPE_ESTABLISHMENT_POI and gcid:golf_shop for golf shops instead.", -"DEPRECATED", -"DEPRECATED", -"", -"", -"", -"", -"", -"", -"Subtype within a zoo - a cage or fenced-off or otherwise delineated area containing animals.", -"A line for a cartographic detail. For example the international date line. Such features should have polyline geometry.", -"ABSTRACT This type is being replaced by TYPE_COMPOUND_GROUNDS. For further details, see go/compounds-v2", -"DEPRECATED This type has been replaced by TYPE_COMPOUND_BUILDING. For further details, see go/oyster-compounds", -"DEPRECATED", -"An establishment that has a physical location. Note that it *may* also have a service area (e.g. a restaurant that offers both dine-in and delivery). This type of business is also known as a \"hybrid\" Service Area Business. Establishment POIs can be referenced by TYPE_COMPOUND features using the RELATION_PRIMARILY_OCCUPIED_BY. This is the reciprocal relation of the RELATION_OCCUPIES.", -"NOTE(tcain): Using value 0xD441, since we could find ourselves with a need to differentiate service areas from online-only at this level in the future, but still benefit from being able to group those under a common parent, disjoint from TYPE_ESTABLISHMENT_POI.", -"The root of types of features that are in the sky, rather than on the earth. There will eventually be a hierarchy of types here.", -"Features responsible for monitoring traffic on roads (usually for speed). Includes cameras at particular points as well as monitors that cover larger spans. Features of this type should have a corresponding gcid that specifies the correct subtype (e.g. gcid:road_camera or gcid:speed_camera_zone). This type was originally named as TYPE_ROAD_CAMERA.", -"ABSTRACT", -"Note that this type does not distinguish the nature of the statue (religious, historical, memorial, tourist, ...).", -"Open space used for events, gathering, or as market-place.", -"A feature used to represent a logical level, e.g. floor.", -"ABSTRACT", -"e.g. campus, compound, parcel.", -"e.g. single family dwelling, office building.", -"e.g. suite, room, hallway, cubicle.", -"A terminal point represents a good location for a user to meet a taxi, ridesharing vehicle, or general driver.", -"An area controlled in some way by an authoritative source, such as a government-designated COVID containment zone or an area under government sanctions. Features of this type should have one or more gcids corresponding to their specific regulation, and client handling of these features may vary based on the type of regulation.", -"A grouping of TYPE_BORDER features (\"border segments\"), which together represent a border between two features of the same type.", -"A generic feature type for any geo-type that cannot be modeled under existing feature types. No new feature type should be created within feature proto after this type.", -"DEPRECATED", -"A feature of completely unknown type. This should only be used when absolutely necessary. One example in which this type is useful is in the Chinese importer, which must heuristically segment addresses into components - it often does not know what types to make those components. Please note that the Oyster address formatter does not currently support address components of TYPE_UNKNOWN well." -], +"startTimeDay": { +"description": "Day start time at user's timezone.", +"type": "string" +}, +"startTimeHourAndMinute": { +"description": "Hour and minute of the start time at the user's timezone.", +"type": "string" +}, +"startTimeInMillis": { +"description": "Start time in milliseconds.", +"format": "int64", "type": "string" } }, "type": "object" }, -"LocationUnifiedPersonalizedLocationAttributes": { -"description": "*************************************************************************** PROTO BELOW IS FOR INTERNAL USE ONLY. IT MAY CHANGE WITHOUT NOTICE, SO EVERYONE OUTSIDE OF oolong-team@ IS STRONGLY DISCOURAGED FROM USING IT. CODE STILL DOING SO WILL BE BROKEN WITHOUT NOTICE. *************************************************************************** Internal Oolong-specific personalized location attributes. Next Id: 11.", -"id": "LocationUnifiedPersonalizedLocationAttributes", +"EnumOperatorOptions": { +"description": "Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* returns items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*.", +"id": "EnumOperatorOptions", "properties": { -"anySupportingDays": { -"description": "Number of days the location was supported by any 'physical presence'-like or 'explicit-interest'-like location.", -"format": "int32", -"type": "integer" +"operatorName": { +"description": "Indicates the operator name required in the query in order to isolate the enum property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", +"type": "string" +} }, -"eiDailyVisits": { -"description": "Binary mask representing \"explicit-interest\" daily visits in the location. EVAL-ONLY, NEVER POPULATED IN PRODUCTION OR LOGS.", -"format": "uint32", -"type": "integer" +"type": "object" }, -"ppDailyVisits": { -"description": "Binary mask representing \"physical-presence\" daily visits in the location. EVAL-ONLY, NEVER POPULATED IN PRODUCTION OR LOGS.", -"format": "uint32", -"type": "integer" +"EnumPropertyOptions": { +"description": "The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*.", +"id": "EnumPropertyOptions", +"properties": { +"operatorOptions": { +"$ref": "EnumOperatorOptions", +"description": "If set, describes how the enum should be used as a search operator." }, -"ppSupportingDays": { -"description": "Number of days the location was supported by any 'physical presence'-like location.", -"format": "int32", -"type": "integer" +"orderedRanking": { +"description": "Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results. If specified, integer values must be provided for all possible EnumValuePair values given for this property. Can only be used if isRepeatable is false.", +"enum": [ +"NO_ORDER", +"ASCENDING", +"DESCENDING" +], +"enumDescriptions": [ +"There is no ranking order for the property. Results aren't adjusted by this property's value.", +"This property is ranked in ascending order. Lower values indicate lower ranking.", +"This property is ranked in descending order. Lower values indicate higher ranking." +], +"type": "string" +}, +"possibleValues": { +"description": "The list of possible values for the enumeration property. All EnumValuePairs must provide a string value. If you specify an integer value for one EnumValuePair, then all possible EnumValuePairs must provide an integer value. Both the string value and integer value must be unique over all possible values. Once set, possible values cannot be removed or modified. If you supply an ordered ranking and think you might insert additional enum values in the future, leave gaps in the initial integer values to allow adding a value in between previously registered values. The maximum number of elements is 100.", +"items": { +"$ref": "EnumValuePair" +}, +"type": "array" +} +}, +"type": "object" }, -"ppSupportingWeeks": { -"description": "Number of weeks the location was supported by any 'physical presence'-like location.", +"EnumValuePair": { +"description": "The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as *p0* for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate *p0* with *0* and define another enum pair such as *p1* and *1*. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for *priority* properties results in a ranking boost for items indexed with a value of *p0* compared to items indexed with a value of *p1*. Without a specified ranking order, the integer value has no effect on item ranking.", +"id": "EnumValuePair", +"properties": { +"integerValue": { +"description": "The integer value of the EnumValuePair which must be non-negative. Optional.", "format": "int32", "type": "integer" }, -"supportingPackedIpRanges": { -"description": "IP ranges that the location was supported by.", +"stringValue": { +"description": "The string value of the EnumValuePair. The maximum length is 32 characters.", +"type": "string" +} +}, +"type": "object" +}, +"EnumValues": { +"description": "List of enum values.", +"id": "EnumValues", +"properties": { +"values": { +"description": "The maximum allowable length for string values is 32 characters.", "items": { -"format": "byte", "type": "string" }, "type": "array" @@ -19226,1456 +4779,1542 @@ false }, "type": "object" }, -"LocationUnifiedPolicyResult": { -"description": "PolicyResult contains all the data that is computed based on the classifier policy for a location.", -"id": "LocationUnifiedPolicyResult", +"ErrorInfo": { +"description": "Error information about the response.", +"id": "ErrorInfo", "properties": { -"confidenceRects": { +"errorMessages": { "items": { -"$ref": "LocationUnifiedPolicyResultConfidenceRect" +"$ref": "ErrorMessage" }, "type": "array" } }, "type": "object" }, -"LocationUnifiedPolicyResultConfidenceRect": { -"id": "LocationUnifiedPolicyResultConfidenceRect", +"ErrorMessage": { +"description": "Error message per source response.", +"id": "ErrorMessage", "properties": { -"confidence": { -"description": "Confidence in the range [0, 100].", +"errorMessage": { +"type": "string" +}, +"source": { +"$ref": "Source" +} +}, +"type": "object" +}, +"FacetBucket": { +"description": "A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.", +"id": "FacetBucket", +"properties": { +"count": { +"description": "Number of results that match the bucket value. Counts are only returned for searches when count accuracy is ensured. Cloud Search does not guarantee facet counts for any query and facet counts might be present only intermittently, even for identical queries. Do not build dependencies on facet count existence; instead use facet ount percentages which are always returned.", +"format": "int32", +"type": "integer" +}, +"filter": { +"$ref": "Filter", +"description": "Filter to be passed in the search request if the corresponding bucket is selected." +}, +"percentage": { +"description": "Percent of results that match the bucket value. The returned value is between (0-100], and is rounded down to an integer if fractional. If the value is not explicitly returned, it represents a percentage value that rounds to 0. Percentages are returned for all searches, but are an estimate. Because percentages are always returned, you should render percentages instead of counts.", "format": "int32", "type": "integer" }, -"rect": { -"$ref": "LocationUnifiedLatLngRect", -"description": "The bounding box that we believe is certain with probability given by confidence." +"value": { +"$ref": "Value" } }, "type": "object" }, -"LocationUnifiedPresenceInterval": { -"description": "Next ID: 4.", -"id": "LocationUnifiedPresenceInterval", +"FacetOptions": { +"description": "Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.", +"id": "FacetOptions", "properties": { -"confidence": { -"description": "Probability of presence as a percentage in [0, 100].", -"format": "uint32", +"integerFacetingOptions": { +"$ref": "IntegerFacetingOptions", +"description": "If set, describes integer faceting options for the given integer property. The corresponding integer property in the schema should be marked isFacetable. The number of buckets returned would be minimum of this and num_facet_buckets." +}, +"numFacetBuckets": { +"description": "Maximum number of facet buckets that should be returned for this facet. Defaults to 10. Maximum value is 100.", +"format": "int32", "type": "integer" }, -"durationSec": { -"description": "Interval duration in seconds.", -"format": "uint64", +"objectType": { +"description": "If object_type is set, only those objects of that type will be used to compute facets. If empty, then all objects will be used to compute facets.", "type": "string" }, -"startOffsetSec": { -"description": "Start of the interval as the number of seconds from the time of the location.", -"format": "uint64", +"operatorName": { +"description": "The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions", +"type": "string" +}, +"sourceName": { +"description": "Source name to facet on. Format: datasources/{source_id} If empty, all data sources will be used.", "type": "string" } }, "type": "object" }, -"LocationUnifiedSemanticPlace": { -"description": "Semantic location information from HULK Next Id: 6", -"id": "LocationUnifiedSemanticPlace", +"FacetResult": { +"description": "Source specific facet response", +"id": "FacetResult", "properties": { -"confidence": { -"enum": [ -"UNKNOWN_CONFIDENCE", -"LOW_CONFIDENCE", -"MEDIUM_CONFIDENCE", -"HIGH_CONFIDENCE" -], -"enumDescriptions": [ -"", -"", -"", -"" -], +"buckets": { +"description": "FacetBuckets for values in response containing at least a single result with the corresponding filter.", +"items": { +"$ref": "FacetBucket" +}, +"type": "array" +}, +"objectType": { +"description": "Object type for which facet results are returned. Can be empty.", "type": "string" }, -"featureId": { -"$ref": "LocationUnifiedFeatureIdProto", -"description": "The feature id of the semantic location POI" +"operatorName": { +"description": "The name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions", +"type": "string" }, -"gconceptInstance": { -"description": "Geo Ontology GConcept Instances of the semantic location", -"items": { -"$ref": "LocationUnifiedSemanticPlaceGConceptInstanceProto" +"sourceName": { +"description": "Source name for which facet results are returned. Will not be empty.", +"type": "string" +} }, -"type": "array" +"type": "object" }, -"score": { -"description": "The probability the user is at this place in [0 100].", -"format": "float", -"type": "number" +"FieldViolation": { +"id": "FieldViolation", +"properties": { +"description": { +"description": "The description of the error.", +"type": "string" }, -"source": { -"enum": [ -"UNKNOWN", -"HAPPY_HOUR", -"HULK_REAL_TIME", -"ANDROID_CONTEXT" -], -"enumDescriptions": [ -"", -"", -"", -"" -], +"field": { +"description": "Path of field with violation.", +"type": "string" +} +}, +"type": "object" +}, +"Filter": { +"description": "A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.", +"id": "Filter", +"properties": { +"compositeFilter": { +"$ref": "CompositeFilter" +}, +"valueFilter": { +"$ref": "ValueFilter" +} +}, +"type": "object" +}, +"FilterOptions": { +"description": "Filter options to be applied on query.", +"id": "FilterOptions", +"properties": { +"filter": { +"$ref": "Filter", +"description": "Generic filter to restrict the search, such as `lang:en`, `site:xyz`." +}, +"objectType": { +"description": "If object_type is set, only objects of that type are returned. This should correspond to the name of the object that was registered within the definition of schema. The maximum length is 256 characters.", "type": "string" } }, "type": "object" }, -"LocationUnifiedSemanticPlaceGConceptInstanceProto": { -"description": "A GConceptInstance (gcid), copied from geostore.GConceptInstanceProto. Copy is needed because - LocationDescriptor is used publicly, therefore should not have internal dependencies. - GConceptInstanceProto uses js_proto build rules which are incompatible with closure_js_proto_library rules.", -"id": "LocationUnifiedSemanticPlaceGConceptInstanceProto", +"FreshnessOptions": { +"description": "Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.", +"id": "FreshnessOptions", "properties": { -"gconceptId": { +"freshnessDuration": { +"description": "The duration after which an object should be considered stale. The default value is 180 days (in seconds).", +"format": "google-duration", "type": "string" }, -"prominence": { -"enum": [ -"NON_PRIMARY", -"PRIMARY" -], -"enumDescriptions": [ -"not a prominent GConcept", -"the most prominent GConcept" -], +"freshnessProperty": { +"description": "This property indicates the freshness level of the object in the index. If set, this property must be a top-level property within the property definitions and it must be a timestamp type or date type. Otherwise, the Indexing API uses updateTime as the freshness indicator. The maximum length is 256 characters. When a property is used to calculate freshness, the value defaults to 2 years from the current time.", +"type": "string" +} +}, +"type": "object" +}, +"GSuitePrincipal": { +"id": "GSuitePrincipal", +"properties": { +"gsuiteDomain": { +"description": "This principal represents all users of the Google Workspace domain of the customer.", +"type": "boolean" +}, +"gsuiteGroupEmail": { +"description": "This principal references a Google Workspace group name.", +"type": "string" +}, +"gsuiteUserEmail": { +"description": "This principal references a Google Workspace user account.", +"type": "string" +} +}, +"type": "object" +}, +"GetCustomerIndexStatsResponse": { +"id": "GetCustomerIndexStatsResponse", +"properties": { +"averageIndexedItemCount": { +"description": "Average item count for the given date range for which billing is done.", +"format": "int64", "type": "string" +}, +"stats": { +"description": "Summary of indexed item counts, one for each day in the requested range.", +"items": { +"$ref": "CustomerIndexStats" +}, +"type": "array" } }, "type": "object" }, -"LocationUnifiedVisibleNetwork": { -"description": "VisibleNetwork describes a location by providing the details of one of the networks visible at that location. GLS can be used to geocode a set of VisibleNetworks into a location, as explained in go/gls-in-gws. Currently only WiFi and cell networks are supported, but the message could be extended to support additional network types (e.g. bluetooth beacons, etc) in the future. Next Id: 5", -"id": "LocationUnifiedVisibleNetwork", +"GetCustomerQueryStatsResponse": { +"id": "GetCustomerQueryStatsResponse", "properties": { -"cell": { -"$ref": "LocationUnifiedVisibleNetworkCell" +"stats": { +"items": { +"$ref": "CustomerQueryStats" }, -"connected": { -"description": "True if the user's device is currently connected to the network.", -"type": "boolean" +"type": "array" }, -"timestampMs": { -"description": "The timestamp of this network. That is when this network was detected, expressed as the number of milliseconds since unix epoch. If not set, assumed to be \"now\" or irrelevant.", +"totalQueryCount": { +"description": "Total successful query count (status code 200) for the given date range.", "format": "int64", "type": "string" -}, -"wifi": { -"$ref": "LocationUnifiedVisibleNetworkWiFi" } }, "type": "object" }, -"LocationUnifiedVisibleNetworkCell": { -"description": "Definition derived from https://developers.google.com/maps/documentation/geolocation/intro#cell_tower_object Next Id: 9", -"id": "LocationUnifiedVisibleNetworkCell", +"GetCustomerSearchApplicationStatsResponse": { +"description": "Response format for search application stats for a customer.", +"id": "GetCustomerSearchApplicationStatsResponse", "properties": { -"cellId": { -"description": "For GSM, LTE and WCDMA networks, this field holds the cell ID of the network. For CDMA networks, this field holds the base station ID of the network.", -"format": "int32", -"type": "integer" -}, -"locationAreaCode": { -"description": "For GSM and WCDMA networks, this field holds the location area code of the network. For LTE networks, this field used to hold the tracking area code of the network, but this usage has been deprecated, and that value should now be provided through tracking_area_code. For CDMA networks, this field holds the network ID of the network.", -"format": "int32", -"type": "integer" -}, -"mobileCountryCode": { -"description": "The mobile country code of the network.", -"format": "int32", -"type": "integer" +"averageSearchApplicationCount": { +"description": "Average search application count for the given date range.", +"format": "int64", +"type": "string" }, -"mobileNetworkCode": { -"description": "The mobile network code of the network.", -"format": "int32", -"type": "integer" +"stats": { +"description": "Search application stats by date.", +"items": { +"$ref": "CustomerSearchApplicationStats" }, -"physicalCellId": { -"description": "Only set for LTE networks for which this field holds the physical cell ID.", -"format": "int32", -"type": "integer" +"type": "array" +} }, -"primaryScramblingCode": { -"description": "Only set for WCDMA networks for which this field holds the primary scrambling code of the network.", -"format": "int32", -"type": "integer" +"type": "object" }, -"trackingAreaCode": { -"description": "Only set for LTE networks for which this field holds the tracking area code.", -"format": "int32", -"type": "integer" +"GetCustomerSessionStatsResponse": { +"id": "GetCustomerSessionStatsResponse", +"properties": { +"stats": { +"items": { +"$ref": "CustomerSessionStats" }, -"type": { -"enum": [ -"UNKNOWN", -"GSM", -"LTE", -"CDMA", -"WCDMA" -], -"enumDescriptions": [ -"", -"", -"", -"", -"" -], -"type": "string" +"type": "array" } }, "type": "object" }, -"LocationUnifiedVisibleNetworkWiFi": { -"description": "Definition derived from https://developers.google.com/maps/documentation/geolocation/intro#wifi_access_point_object Next Id: 3", -"id": "LocationUnifiedVisibleNetworkWiFi", +"GetCustomerUserStatsResponse": { +"id": "GetCustomerUserStatsResponse", "properties": { -"bssid": { -"description": "The BSSID of the network (i.e. MAC address of the access point).", -"type": "string" +"stats": { +"items": { +"$ref": "CustomerUserStats" }, -"levelDbm": { -"description": "The signal level of the network in dBm (RSSI).", -"format": "int32", -"type": "integer" +"type": "array" } }, "type": "object" }, -"MapInfo": { -"description": "Geo information used for rendering a map that shows the user's work location.", -"id": "MapInfo", +"GetDataSourceIndexStatsResponse": { +"id": "GetDataSourceIndexStatsResponse", "properties": { -"lat": { -"description": "Latitude in degrees", -"format": "double", -"type": "number" +"averageIndexedItemCount": { +"description": "Average item count for the given date range for which billing is done.", +"format": "int64", +"type": "string" }, -"locationUrl": { -"$ref": "SafeUrlProto", -"description": "URL to a view of a map centered on the user's work location in Campus Maps (for google.com) or Google Maps (external)." +"stats": { +"description": "Summary of indexed item counts, one for each day in the requested range.", +"items": { +"$ref": "DataSourceIndexStats" }, -"long": { -"description": "Longitude in degrees", -"format": "double", -"type": "number" +"type": "array" +} }, -"mapTile": { -"description": "MapTiles for the area around a user's work location", +"type": "object" +}, +"GetSearchApplicationQueryStatsResponse": { +"description": "Response format for getting query stats for a search application between given dates.", +"id": "GetSearchApplicationQueryStatsResponse", +"properties": { +"stats": { +"description": "Query stats per date for a search application.", "items": { -"$ref": "MapTile" +"$ref": "SearchApplicationQueryStats" }, "type": "array" }, -"zoom": { -"description": "The zoom level of the map. A constant zoom value of 18 is used for now to match the zoom of the map shown on a Moma Teams Profile page", -"format": "int32", -"type": "integer" +"totalQueryCount": { +"description": "Total successful query count (status code 200) for the given date range.", +"format": "int64", +"type": "string" } }, "type": "object" }, -"MapTile": { -"description": "Information used to render a map tile image in the proper location on a map.", -"id": "MapTile", +"GetSearchApplicationSessionStatsResponse": { +"id": "GetSearchApplicationSessionStatsResponse", "properties": { -"imageUrl": { -"$ref": "SafeUrlProto", -"description": "URL to an image file containing an office layout of the user's location for their organization, if one is available. For google.com, this image is from Corp Campus Maps." -}, -"tileX": { -"description": "Map tile x coordinate", -"format": "double", -"type": "number" +"stats": { +"items": { +"$ref": "SearchApplicationSessionStats" }, -"tileY": { -"description": "Map tile y coordinate", -"format": "double", -"type": "number" +"type": "array" } }, "type": "object" }, -"MatchRange": { -"description": "Matched range of a snippet [start, end).", -"id": "MatchRange", +"GetSearchApplicationUserStatsResponse": { +"id": "GetSearchApplicationUserStatsResponse", "properties": { -"end": { -"description": "End of the match in the snippet.", -"format": "int32", -"type": "integer" +"stats": { +"items": { +"$ref": "SearchApplicationUserStats" }, -"start": { -"description": "Starting position of the match in the snippet.", -"format": "int32", -"type": "integer" +"type": "array" } }, "type": "object" }, -"Media": { -"description": "Media resource.", -"id": "Media", +"HtmlOperatorOptions": { +"description": "Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", +"id": "HtmlOperatorOptions", "properties": { -"resourceName": { -"description": "Name of the media resource.", +"operatorName": { +"description": "Indicates the operator name required in the query in order to isolate the html property. For example, if operatorName is *subject* and the property's name is *subjectLine*, then queries like *subject:* show results only where the value of the property named *subjectLine* matches **. By contrast, a search that uses the same ** without an operator return all items where ** matches the value of any html properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", "type": "string" } }, "type": "object" }, -"MessageSet": { -"description": "This is proto2's version of MessageSet.", -"id": "MessageSet", -"properties": {}, +"HtmlPropertyOptions": { +"description": "The options for html properties.", +"id": "HtmlPropertyOptions", +"properties": { +"operatorOptions": { +"$ref": "HtmlOperatorOptions", +"description": "If set, describes how the property should be used as a search operator." +}, +"retrievalImportance": { +"$ref": "RetrievalImportance", +"description": "Indicates the search quality importance of the tokens within the field when used for retrieval. Can only be set to DEFAULT or NONE." +} +}, "type": "object" }, -"Metadata": { -"description": "Metadata of a matched search result.", -"id": "Metadata", +"HtmlValues": { +"description": "List of html values.", +"id": "HtmlValues", "properties": { -"createTime": { -"description": "The creation time for this document or object in the search result.", -"format": "google-datetime", +"values": { +"description": "The maximum allowable length for html values is 2048 characters.", +"items": { "type": "string" }, -"displayOptions": { -"$ref": "ResultDisplayMetadata", -"description": "Options that specify how to display a structured data search result." +"type": "array" +} }, -"fields": { -"description": "Indexed fields in structured data, returned as a generic named property.", -"items": { -"$ref": "NamedProperty" +"type": "object" }, -"type": "array" +"IndexItemOptions": { +"id": "IndexItemOptions", +"properties": { +"allowUnknownGsuitePrincipals": { +"description": "Specifies if the index request should allow Google Workspace principals that do not exist or are deleted.", +"type": "boolean" +} }, -"mimeType": { -"description": "Mime type of the search result.", -"type": "string" +"type": "object" }, -"objectType": { -"description": "Object type of the search result.", +"IndexItemRequest": { +"id": "IndexItemRequest", +"properties": { +"connectorName": { +"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", "type": "string" }, -"owner": { -"$ref": "Person", -"description": "Owner (usually creator) of the document or object of the search result." +"debugOptions": { +"$ref": "DebugOptions", +"description": "Common debug options." }, -"source": { -"$ref": "Source", -"description": "The named source for the result, such as Gmail." +"indexItemOptions": { +"$ref": "IndexItemOptions" }, -"thumbnailUrl": { -"description": "The thumbnail URL of the result.", -"type": "string" +"item": { +"$ref": "Item", +"description": "The name of the item. Format: datasources/{source_id}/items/{item_id}" }, -"updateTime": { -"description": "The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.", -"format": "google-datetime", +"mode": { +"description": "Required. The RequestMode for this request.", +"enum": [ +"UNSPECIFIED", +"SYNCHRONOUS", +"ASYNCHRONOUS" +], +"enumDescriptions": [ +"The priority is not specified in the update request. Leaving priority unspecified results in an update failure.", +"For real-time updates.", +"For changes that are executed after the response is sent back to the caller." +], "type": "string" } }, "type": "object" }, -"Metaline": { -"description": "A metaline is a list of properties that are displayed along with the search result to provide context.", -"id": "Metaline", -"properties": { +"InitializeCustomerRequest": { +"description": "Request message for `InitializeCustomer` method.", +"id": "InitializeCustomerRequest", +"properties": {}, +"type": "object" +}, +"IntegerFacetingOptions": { +"description": "Used to specify integer faceting options.", +"id": "IntegerFacetingOptions", "properties": { -"description": "The list of displayed properties for the metaline. The maximum number of properties is 5.", +"integerBuckets": { +"description": "Buckets for given integer values should be in strictly ascending order. For example, if values supplied are (1,5,10,100), the following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.", "items": { -"$ref": "DisplayedProperty" +"format": "int64", +"type": "string" }, "type": "array" } }, "type": "object" }, -"Name": { -"description": "A person's name.", -"id": "Name", +"IntegerOperatorOptions": { +"description": "Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.", +"id": "IntegerOperatorOptions", "properties": { -"displayName": { -"description": "The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.", +"greaterThanOperatorName": { +"description": "Indicates the operator name required in the query in order to isolate the integer property using the greater-than operator. For example, if greaterThanOperatorName is *priorityabove* and the property's name is *priorityVal*, then queries like *priorityabove:* show results only where the value of the property named *priorityVal* is greater than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", "type": "string" -} -}, -"type": "object" -}, -"NamedProperty": { -"description": "A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.", -"id": "NamedProperty", -"properties": { -"booleanValue": { -"type": "boolean" -}, -"dateValues": { -"$ref": "DateValues" -}, -"doubleValues": { -"$ref": "DoubleValues" -}, -"enumValues": { -"$ref": "EnumValues" -}, -"htmlValues": { -"$ref": "HtmlValues" -}, -"integerValues": { -"$ref": "IntegerValues" }, -"name": { -"description": "The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.", +"lessThanOperatorName": { +"description": "Indicates the operator name required in the query in order to isolate the integer property using the less-than operator. For example, if lessThanOperatorName is *prioritybelow* and the property's name is *priorityVal*, then queries like *prioritybelow:* show results only where the value of the property named *priorityVal* is less than **. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", "type": "string" }, -"objectValues": { -"$ref": "ObjectValues" -}, -"textValues": { -"$ref": "TextValues" -}, -"timestampValues": { -"$ref": "TimestampValues" +"operatorName": { +"description": "Indicates the operator name required in the query in order to isolate the integer property. For example, if operatorName is *priority* and the property's name is *priorityVal*, then queries like *priority:* show results only where the value of the property named *priorityVal* matches **. By contrast, a search that uses the same ** without an operator returns all items where ** matches the value of any String properties or text within the content field for the item. The operator name can only contain lowercase letters (a-z). The maximum length is 32 characters.", +"type": "string" } }, "type": "object" }, -"NetStatsProto": { -"id": "NetStatsProto", +"IntegerPropertyOptions": { +"description": "The options for integer properties.", +"id": "IntegerPropertyOptions", "properties": { -"bandaidBandwidthKbps": { -"$ref": "BandWidthRangeKbps" +"integerFacetingOptions": { +"$ref": "IntegerFacetingOptions", +"description": "If set, describes integer faceting options for the given integer property. The corresponding integer property should be marked isFacetable." }, -"bandwidthKbps": { -"format": "int32", -"type": "integer" +"maximumValue": { +"description": "The maximum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values greater than the maximum are accepted and ranked with the same weight as items indexed with the maximum value.", +"format": "int64", +"type": "string" +}, +"minimumValue": { +"description": "The minimum value of the property. The minimum and maximum values for the property are used to rank results according to the ordered ranking. Indexing requests with values less than the minimum are accepted and ranked with the same weight as items indexed with the minimum value.", +"format": "int64", +"type": "string" }, -"gfeBandwidthKbps": { -"$ref": "BandWidthRangeKbps" +"operatorOptions": { +"$ref": "IntegerOperatorOptions", +"description": "If set, describes how the integer should be used as a search operator." }, -"videostatsBandwidthKbps": { -"$ref": "BandWidthRangeKbps" +"orderedRanking": { +"description": "Used to specify the ordered ranking for the integer. Can only be used if isRepeatable is false.", +"enum": [ +"NO_ORDER", +"ASCENDING", +"DESCENDING" +], +"enumDescriptions": [ +"There is no ranking order for the property. Results are not adjusted by this property's value.", +"This property is ranked in ascending order. Lower values indicate lower ranking.", +"This property is ranked in descending order. Lower values indicate higher ranking." +], +"type": "string" } }, "type": "object" }, -"ObjectDefinition": { -"description": "The definition for an object within a data source.", -"id": "ObjectDefinition", +"IntegerValues": { +"description": "List of integer values.", +"id": "IntegerValues", "properties": { -"name": { -"description": "The name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.", -"type": "string" -}, -"options": { -"$ref": "ObjectOptions", -"description": "The optional object-specific options." -}, -"propertyDefinitions": { -"description": "The property definitions for the object. The maximum number of elements is 1000.", +"values": { "items": { -"$ref": "PropertyDefinition" +"format": "int64", +"type": "string" }, "type": "array" } }, "type": "object" }, -"ObjectDisplayOptions": { -"description": "The display options for an object.", -"id": "ObjectDisplayOptions", +"Interaction": { +"description": "Represents an interaction between a user and an item.", +"id": "Interaction", "properties": { -"metalines": { -"description": "Defines the properties that are displayed in the metalines of the search results. The property values are displayed in the order given here. If a property holds multiple values, all of the values are displayed before the next properties. For this reason, it is a good practice to specify singular properties before repeated properties in this list. All of the properties must set is_returnable to true. The maximum number of metalines is 3.", -"items": { -"$ref": "Metaline" +"interactionTime": { +"description": "The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.", +"format": "google-datetime", +"type": "string" }, -"type": "array" +"principal": { +"$ref": "Principal", +"description": "The user that acted on the item." }, -"objectDisplayLabel": { -"description": "The user friendly label to display in the search result to indicate the type of the item. This is OPTIONAL; if not provided, an object label isn't displayed on the context line of the search results. The maximum length is 64 characters.", +"type": { +"enum": [ +"UNSPECIFIED", +"VIEW", +"EDIT" +], +"enumDescriptions": [ +"Invalid value.", +"This interaction indicates the user viewed the item.", +"This interaction indicates the user edited the item." +], "type": "string" } }, "type": "object" }, -"ObjectOptions": { -"description": "The options for an object.", -"id": "ObjectOptions", +"Item": { +"description": "Represents a single object that is an item in the search index, such as a file, folder, or a database record.", +"id": "Item", "properties": { -"displayOptions": { -"$ref": "ObjectDisplayOptions", -"description": "The options that determine how the object is displayed in the Cloud Search results page." +"acl": { +"$ref": "ItemAcl", +"description": "Access control list for this item." }, -"freshnessOptions": { -"$ref": "FreshnessOptions", -"description": "The freshness options for an object." +"content": { +"$ref": "ItemContent", +"description": "Item content to be indexed and made text searchable." }, -"suggestionFilteringOperators": { -"description": "Operators that can be used to filter suggestions. For Suggest API, only operators mentioned here will be honored in the FilterOptions. Only TEXT and ENUM operators are supported. NOTE: \"objecttype\", \"type\" and \"mimetype\" are already supported. This property is to configure schema specific operators. Even though this is an array, only one operator can be specified. This is an array for future extensibility. Operators mapping to multiple properties within the same object are not supported. If the operator spans across different object types, this option has to be set once for each object definition.", -"items": { +"itemType": { +"description": "The type for this item.", +"enum": [ +"UNSPECIFIED", +"CONTENT_ITEM", +"CONTAINER_ITEM", +"VIRTUAL_CONTAINER_ITEM" +], +"enumDescriptions": [ +"", +"An item that is indexed for the only purpose of serving information. These items cannot be referred in containerName or inheritAclFrom fields.", +"An item that gets indexed and whose purpose is to supply other items with ACLs and/or contain other items.", +"An item that does not get indexed, but otherwise has the same purpose as CONTAINER_ITEM." +], "type": "string" }, -"type": "array" -} +"metadata": { +"$ref": "ItemMetadata", +"description": "The metadata information." }, -"type": "object" +"name": { +"description": "The name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.", +"type": "string" }, -"ObjectPropertyOptions": { -"description": "The options for object properties.", -"id": "ObjectPropertyOptions", -"properties": { -"subobjectProperties": { -"description": "The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000.", -"items": { -"$ref": "PropertyDefinition" +"payload": { +"description": "Additional state connector can store for this item. The maximum length is 10000 bytes.", +"format": "byte", +"type": "string" }, -"type": "array" -} +"queue": { +"description": "Queue this item belongs to. The maximum length is 100 characters.", +"type": "string" }, -"type": "object" +"status": { +"$ref": "ItemStatus", +"description": "Status of the item. Output only field." }, -"ObjectValues": { -"description": "List of object values.", -"id": "ObjectValues", -"properties": { -"values": { -"items": { -"$ref": "StructuredDataObject" +"structuredData": { +"$ref": "ItemStructuredData", +"description": "The structured data for the item that should conform to a registered object definition in the schema for the data source." }, -"type": "array" +"version": { +"description": "Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to [Handle revisions after manual deletes](https://developers.google.com/cloud-search/docs/guides/operations).", +"format": "byte", +"type": "string" } }, "type": "object" }, -"Operation": { -"description": "This resource represents a long-running operation that is the result of a network API call.", -"id": "Operation", +"ItemAcl": { +"description": "Access control list information for the item. For more information see [Map ACLs](https://developers.google.com/cloud-search/docs/guides/acls).", +"id": "ItemAcl", "properties": { -"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": "Status", -"description": "The error result of the operation in case of failure or cancellation." +"aclInheritanceType": { +"description": "Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.", +"enum": [ +"NOT_APPLICABLE", +"CHILD_OVERRIDE", +"PARENT_OVERRIDE", +"BOTH_PERMIT" +], +"enumDescriptions": [ +"The default value when this item does not inherit an ACL. Use NOT_APPLICABLE when inheritAclFrom is empty. An item without ACL inheritance can still have ACLs supplied by its own readers and deniedReaders fields.", +"During an authorization conflict, the ACL of the child item determines its read access.", +"During an authorization conflict, the ACL of the parent item specified in the inheritAclFrom field determines read access.", +"Access is granted only if this item and the parent item specified in the inheritAclFrom field both permit read access." +], +"type": "string" }, -"metadata": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"deniedReaders": { +"description": "List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.", +"items": { +"$ref": "Principal" }, -"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" +"type": "array" }, -"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}`.", +"inheritAclFrom": { +"description": "The name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.", "type": "string" }, -"response": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"owners": { +"description": "Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.", +"items": { +"$ref": "Principal" }, -"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": "array" +}, +"readers": { +"description": "List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.", +"items": { +"$ref": "Principal" +}, +"type": "array" } }, "type": "object" }, -"OptInStatus": { -"description": "The status and eligibility information for a single feature.", -"id": "OptInStatus", +"ItemContent": { +"description": "Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded.", +"id": "ItemContent", "properties": { -"eligibility": { -"description": "If the user is ineligible, they should not be opted in!", +"contentDataRef": { +"$ref": "UploadItemRef", +"description": "Upload reference ID of a previously uploaded content via write method." +}, +"contentFormat": { "enum": [ -"UNKNOWN_ELIGIBILITY", -"ELIGIBLE", -"INELIGIBLE_DASHER", -"INELIGIBLE_GEO", -"INELIGIBLE_UNICORN", -"INELIGIBLE_OTHER" +"UNSPECIFIED", +"HTML", +"TEXT", +"RAW" ], "enumDescriptions": [ -"Default value.", -"The user is eligible.", -"Ineligible due to Dasher restriction.", -"Ineligible due to geo (country or territory) restriction.", -"Ineligible due to Unicorn underage child account.", -"Ineligible for some other reason." +"Invalid value.", +"contentFormat is HTML.", +"contentFormat is free text.", +"contentFormat is raw bytes." ], "type": "string" }, -"optedIn": { -"description": "If the user is ineligible, they should not be opted in!", -"type": "boolean" +"hash": { +"description": "Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", +"type": "string" +}, +"inlineContent": { +"description": "Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB).", +"format": "byte", +"type": "string" } }, "type": "object" }, -"PeoplePromotionCard": { -"id": "PeoplePromotionCard", +"ItemCountByStatus": { +"id": "ItemCountByStatus", "properties": { -"people": { -"items": { -"$ref": "PersonCore" +"count": { +"description": "Number of items matching the status code.", +"format": "int64", +"type": "string" }, -"type": "array" +"indexedItemsCount": { +"description": "Number of items matching the status code for which billing is done. This excludes virtual container items from the total count. This count would not be applicable for items with ERROR or NEW_ITEM status code.", +"format": "int64", +"type": "string" +}, +"statusCode": { +"description": "Status of the items.", +"enum": [ +"CODE_UNSPECIFIED", +"ERROR", +"MODIFIED", +"NEW_ITEM", +"ACCEPTED" +], +"enumDescriptions": [ +"Input-only value. Used with Items.list to list all items in the queue, regardless of status.", +"Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", +"Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", +"Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", +"API has accepted the up-to-date data of this item." +], +"type": "string" } }, "type": "object" }, -"PeopleSuggestion": { -"description": "This field contains information about the person being suggested.", -"id": "PeopleSuggestion", +"ItemMetadata": { +"description": "Available metadata fields for the item.", +"id": "ItemMetadata", "properties": { -"person": { -"$ref": "Person", -"description": "Suggested person. All fields of the person object might not be populated." -} +"containerName": { +"description": "The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.", +"type": "string" }, -"type": "object" +"contentLanguage": { +"description": "The BCP-47 language code for the item, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.", +"type": "string" }, -"Person": { -"description": "Object to represent a person.", -"id": "Person", -"properties": { -"emailAddresses": { -"description": "The person's email addresses", +"contextAttributes": { +"description": "A set of named attributes associated with the item. This can be used for influencing the ranking of the item based on the context in the request. The maximum number of elements is 10.", "items": { -"$ref": "EmailAddress" +"$ref": "ContextAttribute" }, "type": "array" }, -"name": { -"description": "The resource name of the person to provide information about. See [`People.get`](https://developers.google.com/people/api/rest/v1/people/get) from the Google People API.", +"createTime": { +"description": "The time when the item was created in the source repository.", +"format": "google-datetime", "type": "string" }, -"obfuscatedId": { -"description": "Obfuscated ID of a person.", +"hash": { +"description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", "type": "string" }, -"personNames": { -"description": "The person's name", +"interactions": { +"description": "A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.", "items": { -"$ref": "Name" +"$ref": "Interaction" }, "type": "array" }, -"phoneNumbers": { -"description": "The person's phone numbers", +"keywords": { +"description": "Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.", "items": { -"$ref": "PhoneNumber" +"type": "string" }, "type": "array" }, -"photos": { -"description": "A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.", -"items": { -"$ref": "Photo" +"mimeType": { +"description": "The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.", +"type": "string" }, -"type": "array" +"objectType": { +"description": "The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.", +"type": "string" +}, +"searchQualityMetadata": { +"$ref": "SearchQualityMetadata", +"description": "Additional search quality metadata of the item" +}, +"sourceRepositoryUrl": { +"description": "Link to the source repository serving the data. Seach results apply this link to the title. Whitespace or special characters may cause Cloud Seach result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.", +"type": "string" +}, +"title": { +"description": "The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.", +"type": "string" +}, +"updateTime": { +"description": "The time when the item was last modified in the source repository.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"PersonCore": { -"description": "Information for rendering a person. NEXT ID: 37", -"id": "PersonCore", +"ItemStatus": { +"description": "This contains item's status and any errors.", +"id": "ItemStatus", "properties": { -"addressMeAs": { -"description": "Instructions for how to address this person (e.g. custom pronouns). For google.com this is a set of pronouns from a defined list of options.", +"code": { +"description": "Status code.", +"enum": [ +"CODE_UNSPECIFIED", +"ERROR", +"MODIFIED", +"NEW_ITEM", +"ACCEPTED" +], +"enumDescriptions": [ +"Input-only value. Used with Items.list to list all items in the queue, regardless of status.", +"Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", +"Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", +"Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", +"API has accepted the up-to-date data of this item." +], "type": "string" }, -"adminTo": { -"description": "People the profile owner is an admin to. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", +"processingErrors": { +"description": "Error details in case the item is in ERROR state.", "items": { -"$ref": "PersonCore" +"$ref": "ProcessingError" }, "type": "array" }, -"admins": { -"description": "The profile owner's admins in no particular order. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", +"repositoryErrors": { +"description": "Repository error reported by connector.", "items": { -"$ref": "PersonCore" +"$ref": "RepositoryError" }, "type": "array" +} }, -"availabilityStatus": { -"enum": [ -"UNKNOWN", -"OUT_OF_OFFICE", -"OUTSIDE_WORKING_HOURS", -"AVAILABLE" -], -"enumDescriptions": [ -"", -"", -"", -"" -], -"type": "string" -}, -"birthday": { -"$ref": "Date", -"description": "Person birthday." +"type": "object" }, -"calendarUrl": { -"$ref": "SafeUrlProto", -"description": "The URL to open the profile owner's primary calendar." +"ItemStructuredData": { +"description": "Available structured data fields for the item.", +"id": "ItemStructuredData", +"properties": { +"hash": { +"description": "Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.", +"type": "string" }, -"chatUrl": { -"$ref": "SafeUrlProto", -"description": "The URL to start a chat conversation with the profile owner. For google.com this is a Hangouts URL." +"object": { +"$ref": "StructuredDataObject", +"description": "The structured data object that should conform to a registered object definition in the schema for the data source." +} }, -"costCenter": { -"description": "Person's cost center as a string, e.g. \"926: Googler Apps\".", -"type": "string" +"type": "object" }, -"department": { -"description": "The person's Organization department, e.g. \"People Operations\". For google.com this is usually called \"area\".", +"ListDataSourceResponse": { +"id": "ListDataSourceResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" -}, -"directReports": { -"description": "A subset of the profile owner's direct reports. The number of entities here may be less than total_direct_reports_count, because typically ProfileResponse does not include all the person's reports, if there are too many to retrieve efficiently. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", +}, +"sources": { "items": { -"$ref": "PersonCore" +"$ref": "DataSource" }, "type": "array" +} }, -"dottedLineManagers": { -"description": "The profile owner's direct dotted line managers in no particular order. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", +"type": "object" +}, +"ListItemNamesForUnmappedIdentityResponse": { +"id": "ListItemNamesForUnmappedIdentityResponse", +"properties": { +"itemNames": { "items": { -"$ref": "PersonCore" +"type": "string" }, "type": "array" }, -"dottedLineReports": { -"description": "A subset of the profile owner's dotted-line reports. The number of entities here may be less than total_dlr_count. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", -"items": { -"$ref": "PersonCore" +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +} }, -"type": "array" +"type": "object" }, -"emails": { -"description": "E-mail addresses of the person. The primary or preferred email should be first.", +"ListItemsResponse": { +"id": "ListItemsResponse", +"properties": { "items": { -"type": "string" +"items": { +"$ref": "Item" }, "type": "array" }, -"employeeId": { -"description": "Person's employee number (external ID of type \"organization\") For google.com this is the badge number (e.g. 2 for Larry Page).", +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" +} }, -"fingerprint": { -"description": "A fingerprint used by PAPI to reliably determine if a resource has changed Externally it is used as part of the etag.", -"type": "string" +"type": "object" }, -"ftePermille": { -"description": "Full-time equivalent (in \u2030) (e.g. 800 for a person who's working 80%).", -"format": "int64", +"ListOperationsResponse": { +"description": "The response message for Operations.ListOperations.", +"id": "ListOperationsResponse", +"properties": { +"nextPageToken": { +"description": "The standard List next-page token.", "type": "string" }, -"geoLocation": { -"$ref": "MapInfo" +"operations": { +"description": "A list of operations that matches the specified filter in the request.", +"items": { +"$ref": "Operation" }, -"gmailUrl": { -"type": "string" +"type": "array" +} }, -"jobTitle": { -"description": "Profile owner's job title (e.g. \"Software Engineer\"). For google.com this is the Workday preferred job title.", +"type": "object" +}, +"ListQuerySourcesResponse": { +"description": "List sources response.", +"id": "ListQuerySourcesResponse", +"properties": { +"nextPageToken": { "type": "string" }, -"keywordTypes": { -"description": "List of keys to use from the map 'keywords'.", +"sources": { "items": { -"type": "string" +"$ref": "QuerySource" }, "type": "array" +} }, -"keywords": { -"additionalProperties": { -"type": "string" -}, -"description": "Custom keywords the domain admin has added.", "type": "object" }, -"links": { -"description": "Custom links the profile owner has added.", +"ListSearchApplicationsResponse": { +"id": "ListSearchApplicationsResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"type": "string" +}, +"searchApplications": { "items": { -"$ref": "EnterpriseTopazFrontendTeamsLink" +"$ref": "SearchApplication" }, "type": "array" +} }, -"location": { -"description": "Detailed desk location within the company. For google.com this is the desk location code (e.g. \"DE-MUC-ARP-6T2-6T2C0C\") if the person has a desk.", +"type": "object" +}, +"ListUnmappedIdentitiesResponse": { +"id": "ListUnmappedIdentitiesResponse", +"properties": { +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" }, -"managers": { -"description": "The profile owner's management chain from top to bottom, where managers[0] is the CEO, manager[N-2] is the person's manager's manager and managers[N-1] is the person's direct manager. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", +"unmappedIdentities": { "items": { -"$ref": "PersonCore" +"$ref": "UnmappedIdentity" }, "type": "array" +} }, -"mission": { -"description": "Custom mission statement the profile owner has added.", -"type": "string" +"type": "object" }, -"name": { -"description": "Human-readable Unicode display name.", -"type": "string" +"MapInfo": { +"description": "Geo information used for rendering a map that shows the user's work location.", +"id": "MapInfo", +"properties": { +"lat": { +"description": "Latitude in degrees", +"format": "double", +"type": "number" }, -"officeLocation": { -"description": "Office/building identifier within the company. For google.com this is the office code (e.g. \"DE-MUC-ARP\").", -"type": "string" +"locationUrl": { +"$ref": "SafeUrlProto", +"description": "URL to a view of a map centered on the user's work location in Campus Maps (for google.com) or Google Maps (external)." }, -"personId": { -"description": "The person's obfuscated Gaia ID.", -"type": "string" +"long": { +"description": "Longitude in degrees", +"format": "double", +"type": "number" }, -"phoneNumbers": { +"mapTile": { +"description": "MapTiles for the area around a user's work location", "items": { -"$ref": "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber" +"$ref": "MapTile" }, "type": "array" }, -"photoUrl": { +"zoom": { +"description": "The zoom level of the map. A constant zoom value of 18 is used for now to match the zoom of the map shown on a Moma Teams Profile page", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"MapTile": { +"description": "Information used to render a map tile image in the proper location on a map.", +"id": "MapTile", +"properties": { +"imageUrl": { "$ref": "SafeUrlProto", -"description": "Person photo." +"description": "URL to an image file containing an office layout of the user's location for their organization, if one is available. For google.com, this image is from Corp Campus Maps." }, -"postalAddress": { -"description": "Postal address of office/building.", -"type": "string" +"tileX": { +"description": "Map tile x coordinate", +"format": "double", +"type": "number" }, -"totalDirectReportsCount": { -"description": "Total count of the profile owner's direct reports.", +"tileY": { +"description": "Map tile y coordinate", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"MatchRange": { +"description": "Matched range of a snippet [start, end).", +"id": "MatchRange", +"properties": { +"end": { +"description": "End of the match in the snippet.", "format": "int32", "type": "integer" }, -"totalDlrCount": { -"description": "Total count of the profile owner's dotted-line reports.", +"start": { +"description": "Starting position of the match in the snippet.", "format": "int32", "type": "integer" +} }, -"totalFteCount": { -"description": "The sum of all profile owner's reports and their own full-time-equivalents in \u2030 (e.g. 1800 if one report is working 80% and profile owner 100%).", -"format": "int64", +"type": "object" +}, +"Media": { +"description": "Media resource.", +"id": "Media", +"properties": { +"resourceName": { +"description": "Name of the media resource.", "type": "string" +} }, -"username": { -"description": "External ID of type \"login_id\" for the profile. For google.com this is the username/LDAP.", +"type": "object" +}, +"Metadata": { +"description": "Metadata of a matched search result.", +"id": "Metadata", +"properties": { +"createTime": { +"description": "The creation time for this document or object in the search result.", +"format": "google-datetime", "type": "string" }, -"waldoComeBackTime": { +"displayOptions": { +"$ref": "ResultDisplayMetadata", +"description": "Options that specify how to display a structured data search result." +}, +"fields": { +"description": "Indexed fields in structured data, returned as a generic named property.", +"items": { +"$ref": "NamedProperty" +}, +"type": "array" +}, +"mimeType": { +"description": "Mime type of the search result.", +"type": "string" +}, +"objectType": { +"description": "Object type of the search result.", +"type": "string" +}, +"owner": { +"$ref": "Person", +"description": "Owner (usually creator) of the document or object of the search result." +}, +"source": { +"$ref": "Source", +"description": "The named source for the result, such as Gmail." +}, +"thumbnailUrl": { +"description": "The thumbnail URL of the result.", +"type": "string" +}, +"updateTime": { +"description": "The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"PhoneNumber": { -"description": "A person's Phone Number", -"id": "PhoneNumber", +"Metaline": { +"description": "A metaline is a list of properties that are displayed along with the search result to provide context.", +"id": "Metaline", "properties": { -"phoneNumber": { -"description": "The phone number of the person.", -"type": "string" +"properties": { +"description": "The list of displayed properties for the metaline. The maximum number of properties is 5.", +"items": { +"$ref": "DisplayedProperty" }, -"type": { -"enum": [ -"OTHER", -"MOBILE", -"OFFICE" -], -"enumDescriptions": [ -"", -"", -"" -], -"type": "string" +"type": "array" } }, "type": "object" }, -"Photo": { -"description": "A person's photo.", -"id": "Photo", +"Name": { +"description": "A person's name.", +"id": "Name", "properties": { -"url": { -"description": "The URL of the photo.", +"displayName": { +"description": "The read-only display name formatted according to the locale specified by the viewer's account or the `Accept-Language` HTTP header.", "type": "string" } }, "type": "object" }, -"PollItemsRequest": { -"id": "PollItemsRequest", +"NamedProperty": { +"description": "A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.", +"id": "NamedProperty", "properties": { -"connectorName": { -"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", -"type": "string" +"booleanValue": { +"type": "boolean" }, -"debugOptions": { -"$ref": "DebugOptions", -"description": "Common debug options." +"dateValues": { +"$ref": "DateValues" }, -"limit": { -"description": "Maximum number of items to return. The maximum value is 100 and the default value is 20.", -"format": "int32", -"type": "integer" +"doubleValues": { +"$ref": "DoubleValues" }, -"queue": { -"description": "Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.", -"type": "string" +"enumValues": { +"$ref": "EnumValues" }, -"statusCodes": { -"description": "Limit the items polled to the ones with these statuses.", -"items": { -"enum": [ -"CODE_UNSPECIFIED", -"ERROR", -"MODIFIED", -"NEW_ITEM", -"ACCEPTED" -], -"enumDescriptions": [ -"Input-only value. Used with Items.list to list all items in the queue, regardless of status.", -"Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", -"Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", -"Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", -"API has accepted the up-to-date data of this item." -], +"htmlValues": { +"$ref": "HtmlValues" +}, +"integerValues": { +"$ref": "IntegerValues" +}, +"name": { +"description": "The name of the property. This name should correspond to the name of the property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.", "type": "string" }, -"type": "array" +"objectValues": { +"$ref": "ObjectValues" +}, +"textValues": { +"$ref": "TextValues" +}, +"timestampValues": { +"$ref": "TimestampValues" } }, "type": "object" }, -"PollItemsResponse": { -"id": "PollItemsResponse", +"ObjectDefinition": { +"description": "The definition for an object within a data source.", +"id": "ObjectDefinition", "properties": { +"name": { +"description": "The name for the object, which then defines its type. Item indexing requests should set the objectType field equal to this value. For example, if *name* is *Document*, then indexing requests for items of type Document should set objectType equal to *Document*. Each object definition must be uniquely named within a schema. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.", +"type": "string" +}, +"options": { +"$ref": "ObjectOptions", +"description": "The optional object-specific options." +}, +"propertyDefinitions": { +"description": "The property definitions for the object. The maximum number of elements is 1000.", "items": { -"description": "Set of items from the queue available for connector to process. These items have the following subset of fields populated: version metadata.hash structured_data.hash content.hash payload status queue", -"items": { -"$ref": "Item" +"$ref": "PropertyDefinition" }, "type": "array" } }, "type": "object" }, -"Principal": { -"description": "Reference to a user, group, or domain.", -"id": "Principal", +"ObjectDisplayOptions": { +"description": "The display options for an object.", +"id": "ObjectDisplayOptions", "properties": { -"groupResourceName": { -"description": "This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}", -"type": "string" +"metalines": { +"description": "Defines the properties that are displayed in the metalines of the search results. The property values are displayed in the order given here. If a property holds multiple values, all of the values are displayed before the next properties. For this reason, it is a good practice to specify singular properties before repeated properties in this list. All of the properties must set is_returnable to true. The maximum number of metalines is 3.", +"items": { +"$ref": "Metaline" }, -"gsuitePrincipal": { -"$ref": "GSuitePrincipal", -"description": "This principal is a Google Workspace user, group or domain." +"type": "array" }, -"userResourceName": { -"description": "This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}", +"objectDisplayLabel": { +"description": "The user friendly label to display in the search result to indicate the type of the item. This is OPTIONAL; if not provided, an object label isn't displayed on the context line of the search results. The maximum length is 64 characters.", "type": "string" } }, "type": "object" }, -"ProcessingError": { -"id": "ProcessingError", +"ObjectOptions": { +"description": "The options for an object.", +"id": "ObjectOptions", "properties": { -"code": { -"description": "Error code indicating the nature of the error.", -"enum": [ -"PROCESSING_ERROR_CODE_UNSPECIFIED", -"MALFORMED_REQUEST", -"UNSUPPORTED_CONTENT_FORMAT", -"INDIRECT_BROKEN_ACL", -"ACL_CYCLE" -], -"enumDescriptions": [ -"Input only value. Use this value in Items.", -"Item's ACL, metadata, or content is malformed or in invalid state. FieldViolations contains more details on where the problem is.", -"Countent format is unsupported.", -"Items with incomplete ACL information due to inheriting other items with broken ACL or having groups with unmapped descendants.", -"ACL inheritance graph formed a cycle." -], -"type": "string" +"displayOptions": { +"$ref": "ObjectDisplayOptions", +"description": "The options that determine how the object is displayed in the Cloud Search results page." }, -"errorMessage": { -"description": "The description of the error.", -"type": "string" +"freshnessOptions": { +"$ref": "FreshnessOptions", +"description": "The freshness options for an object." }, -"fieldViolations": { -"description": "In case the item fields are invalid, this field contains the details about the validation errors.", +"suggestionFilteringOperators": { +"description": "Operators that can be used to filter suggestions. For Suggest API, only operators mentioned here will be honored in the FilterOptions. Only TEXT and ENUM operators are supported. NOTE: \"objecttype\", \"type\" and \"mimetype\" are already supported. This property is to configure schema specific operators. Even though this is an array, only one operator can be specified. This is an array for future extensibility. Operators mapping to multiple properties within the same object are not supported. If the operator spans across different object types, this option has to be set once for each object definition.", "items": { -"$ref": "FieldViolation" +"type": "string" }, "type": "array" } }, "type": "object" }, -"ProminentEntity": { -"description": "prominent_entity(ies) field encodes the main subject(entities) which the client wants to bias the query into. For a Mini-App, it'll be the main entities in the current Mini-App page. It provides finer-granularity contexts on top of the \u201cmode\u201d field. Note that when QueryBiasingContext is passed to server through ClientDiscourseContext, the prominent_entity should NOT be set and the corresponding information will be merged from ClientDiscourseContext.entity field at the server side.", -"id": "ProminentEntity", +"ObjectPropertyOptions": { +"description": "The options for object properties.", +"id": "ObjectPropertyOptions", "properties": { -"mid": { -"type": "string" +"subobjectProperties": { +"description": "The properties of the sub-object. These properties represent a nested object. For example, if this property represents a postal address, the subobjectProperties might be named *street*, *city*, and *state*. The maximum number of elements is 1000.", +"items": { +"$ref": "PropertyDefinition" +}, +"type": "array" } }, "type": "object" }, -"PropertyDefinition": { -"description": "The definition of a property within an object.", -"id": "PropertyDefinition", +"ObjectValues": { +"description": "List of object values.", +"id": "ObjectValues", "properties": { -"booleanPropertyOptions": { -"$ref": "BooleanPropertyOptions" -}, -"datePropertyOptions": { -"$ref": "DatePropertyOptions" -}, -"displayOptions": { -"$ref": "PropertyDisplayOptions", -"description": "The options that determine how the property is displayed in the Cloud Search results page if it's specified to be displayed in the object's display options." -}, -"doublePropertyOptions": { -"$ref": "DoublePropertyOptions" -}, -"enumPropertyOptions": { -"$ref": "EnumPropertyOptions" -}, -"htmlPropertyOptions": { -"$ref": "HtmlPropertyOptions" -}, -"integerPropertyOptions": { -"$ref": "IntegerPropertyOptions" +"values": { +"items": { +"$ref": "StructuredDataObject" }, -"isFacetable": { -"description": "Indicates that the property can be used for generating facets. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, enum, integer, and text properties.", -"type": "boolean" +"type": "array" +} }, -"isRepeatable": { -"description": "Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value cause the indexing request for that item to be rejected.", -"type": "boolean" +"type": "object" }, -"isReturnable": { -"description": "Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object.", +"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" }, -"isSortable": { -"description": "Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, date, double, integer, and timestamp properties.", -"type": "boolean" +"error": { +"$ref": "Status", +"description": "The error result of the operation in case of failure or cancellation." }, -"isSuggestable": { -"description": "Indicates that the property can be used for generating query suggestions.", -"type": "boolean" +"metadata": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" }, -"isWildcardSearchable": { -"description": "Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/cloud-search/docs/guides/schema-guide#properties)", -"type": "boolean" +"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", +"type": "object" }, "name": { -"description": "The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.", +"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" }, -"objectPropertyOptions": { -"$ref": "ObjectPropertyOptions" +"response": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" }, -"textPropertyOptions": { -"$ref": "TextPropertyOptions" +"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" +}, +"PeoplePromotionCard": { +"id": "PeoplePromotionCard", +"properties": { +"people": { +"items": { +"$ref": "PersonCore" }, -"timestampPropertyOptions": { -"$ref": "TimestampPropertyOptions" +"type": "array" } }, "type": "object" }, -"PropertyDisplayOptions": { -"description": "The display options for a property.", -"id": "PropertyDisplayOptions", +"PeopleSuggestion": { +"description": "This field contains information about the person being suggested.", +"id": "PeopleSuggestion", "properties": { -"displayLabel": { -"description": "The user friendly label for the property that is used if the property is specified to be displayed in ObjectDisplayOptions. If provided, the display label is shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user sees 'priority : 1' in the search results which provides clear context to search users. This is OPTIONAL; if not given, only the property values are displayed. The maximum length is 64 characters.", -"type": "string" +"person": { +"$ref": "Person", +"description": "Suggested person. All fields of the person object might not be populated." } }, "type": "object" }, -"ProxyClassificationProto": { -"description": "The enums in ProxyClassificationProto have the same values as in Neustar's data, plus a NONE value, corresponding to empty value in the Neustar's data. See Neustar's IP Intelligence GeoPoint Data Glossary (https://ipintelligence.neustar.biz/portal/home#downloads) for a more detailed description of the meaning of the values. In the data as of January 2016, if the IP address is classified as a proxy, the four fields anonymizer_status, proxy_type, proxy_level and proxy_last_detected_s are all present and set to a value different from NONE; otherwise the enum fields are not set or set to the corresponding NONE constant and proxy_last_detected_s is not set.", -"id": "ProxyClassificationProto", +"Person": { +"description": "Object to represent a person.", +"id": "Person", "properties": { -"anonymizerStatus": { -"description": "WARNING: these fields are coming from a third party. Please consider using only privacy_proxy_operator. Before adding any new usage of this data, please talk to zszami@ and ipgeo-team@.", -"enum": [ -"NONE", -"ACTIVE", -"SUSPECT", -"INACTIVE", -"PRIVATE" -], -"enumDescriptions": [ -"This is not a proxy or it is unknown what status it has.", -"The anonymizer tested positive within the last month when the data were generated.", -"The anonymizer tested positive within the 3 months, but not last month when the data were generated.", -"The anonymizer tested positive within the last six months, but not in the last 3 months when the data were generated.", -"An anonymizer that is not publicly accessible and as such, cannot be routinely tested with automated tools. E.g. commercial VPN services. Unlike the classifications ACTIVE/SUSPECT/INACTIVE, classification as PRIVATE gives no guarantees about the age of last proxy detection (proxy_last_detected_s) - it can be older than 6 months." -], -"type": "string" +"emailAddresses": { +"description": "The person's email addresses", +"items": { +"$ref": "EmailAddress" }, -"hostingFacility": { -"type": "boolean" +"type": "array" }, -"privacyProxyOperator": { -"description": "Operator of a privacy proxy, e.g. Google One (PPN) or Apple Private Relay. Mapping maintained by Google, does not include data from Neustar. If in doubt, use privacy_proxy_operator == NONE and != NONE to check for privacy proxies.", -"enum": [ -"NONE", -"UNKNOWN_PRIVACY_PROXY", -"GOOGLE_PPN", -"APPLE_PRIVATE_RELAY", -"GOOGLE_IP_PROTECTION", -"CLOUDFLARE_WARP" -], -"enumDescriptions": [ -"This IP is not matched to any privacy proxy feeds maintained by IPGeo. Currently, proxy_type == PRIVACY_PROXY and privacy_proxy_operator = NONE may occur as the former field may also be filled by Neustar (3rd party), while this field is a google maintained datasource.", -"Privacy proxy, but we don't know any specific operator.", -"Values below may not be populated, most clients really should rely on ==NONE or !=NONE and have general messaging around privacy proxies.", -"", -"", -"" -], +"name": { +"description": "The resource name of the person to provide information about. See [`People.get`](https://developers.google.com/people/api/rest/v1/people/get) from the Google People API.", "type": "string" }, -"proxyLastDetectedS": { -"description": "In seconds since the Epoch.", -"format": "int64", +"obfuscatedId": { +"description": "Obfuscated ID of a person.", "type": "string" }, -"proxyLevel": { -"enum": [ -"NONE", -"ANONYMOUS", -"DISTORTING", -"ELITE", -"TRANSPARENT" -], -"enumDescriptions": [ -"This is not a proxy or it is unknown what level it has.", -"The proxy obscures the end user\u2019s IP address and does not conceal that it is a proxy. The following information is provided in the HTTP header: REMOTE_ADDR = Proxy IP Address HTTP_VIA = Proxy IP Address HTTP_X_FORWARDED_FOR = Proxy IP Address", -"The proxy obscures the end user\u2019s IP address and does not conceal that it is a proxy. However, the end user\u2019s IP address is replaced with a random IP address, thus there is a degree of subterfuge. The following information is provided in the HTTP header: REMOTE_ADDR = Proxy IP Address HTTP_VIA = Proxy IP Address HTTP_X_FORWARDED_FOR = Random IP Address", -"The proxy obscures the end user\u2019s IP address and conceals that it is a proxy. The proxy appears to be an actual end user as all HTTP header fields are configured to appear as if a proxy is not in use: REMOTE_ADDR = Proxy IP Address HTTP_VIA = Not Determined HTTP_X_FORWARDED_FOR = Not Determined", -"The proxy does not obscure the end user\u2019s IP address, nor does it conceal that it is a proxy. These proxies are typically used for information cashing and to provide joint access to Internet for multiple computers. The following information is provided in the HTTP header: REMOTE_ADDR = Proxy IP Address HTTP_VIA = Proxy IP Address HTTP_X_FORWARDED_FOR = End User IP Address" -], -"type": "string" +"personNames": { +"description": "The person's name", +"items": { +"$ref": "Name" }, -"proxyType": { -"enum": [ -"NONE", -"HTTP", -"SERVICE", -"SOCKS", -"SOCKS_HTTP", -"TOR", -"UNKNOWN", -"WEB", -"PRIVACY_PROXY" -], -"enumDescriptions": [ -"This is not a proxy or it is unknown what type it has.", -"The proxy uses the HTTP protocol and has open ports which are accessible by any Internet user.", -"The proxy is operated by an organization (often for profit) that provides access to subscribers as a service. The proxy is one of an array of proxies (often internationally distributed) that are part of a Virtual Private Network (VPN) that subscribers connect to by installing an application.", -"The proxy uses the SOCKet Secure (SOCKS) protocol and has open ports which are accessible by any Internet user.", -"The proxy has both the HTTP and SOCKS protocols setup and has open ports which are accessible by any Internet user.", -"The proxy is part of the onion router (Tor) network.", -"The proxy\u2019s type could not be determined. (Doesn't occur in the data as of January 2016).", -"The proxy operates through the use of an Internet web browser. Users navigate to the web proxy website, enter the URL of the site they actually wish to visit, and the contents of the requested URL are returned by the web proxy website within the browser.", -"Privacy proxies are IPs leveraged by Privacy Proxy Service Providers to add additional privacy protections for end users. End user traffic is proxied through an IP, masking the end user's IP. Users do not have the ability to control the IP their traffic is proxied through or change the country from which their IP is originating. However, user traffic may be generalized to a different postal code, city, state, or region. An example for a privacy proxy is Apple Private Relay." -], -"type": "string" +"type": "array" +}, +"phoneNumbers": { +"description": "The person's phone numbers", +"items": { +"$ref": "PhoneNumber" +}, +"type": "array" +}, +"photos": { +"description": "A person's read-only photo. A picture shown next to the person's name to help others recognize the person in search results.", +"items": { +"$ref": "Photo" +}, +"type": "array" } }, "type": "object" }, -"PushItem": { -"description": "Represents an item to be pushed to the indexing queue.", -"id": "PushItem", +"PersonCore": { +"description": "Information for rendering a person. NEXT ID: 37", +"id": "PersonCore", "properties": { -"contentHash": { -"description": "Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", -"type": "string" -}, -"metadataHash": { -"description": "The metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", +"addressMeAs": { +"description": "Instructions for how to address this person (e.g. custom pronouns). For google.com this is a set of pronouns from a defined list of options.", "type": "string" }, -"payload": { -"description": "Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes.", -"format": "byte", -"type": "string" +"adminTo": { +"description": "People the profile owner is an admin to. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", +"items": { +"$ref": "PersonCore" }, -"queue": { -"description": "Queue to which this item belongs. The `default` queue is chosen if this field is not specified. The maximum length is 512 characters.", -"type": "string" +"type": "array" }, -"repositoryError": { -"$ref": "RepositoryError", -"description": "Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR." +"admins": { +"description": "The profile owner's admins in no particular order. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", +"items": { +"$ref": "PersonCore" }, -"structuredDataHash": { -"description": "Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", -"type": "string" +"type": "array" }, -"type": { -"description": "The type of the push operation that defines the push behavior.", +"availabilityStatus": { "enum": [ -"UNSPECIFIED", -"MODIFIED", -"NOT_MODIFIED", -"REPOSITORY_ERROR", -"REQUEUE" +"UNKNOWN", +"OUT_OF_OFFICE", +"OUTSIDE_WORKING_HOURS", +"AVAILABLE" ], "enumDescriptions": [ -"Default UNSPECIFIED. Specifies that the push operation should not modify ItemStatus", -"Indicates that the repository document has been modified or updated since the previous update call. This changes status to MODIFIED state for an existing item. If this is called on a non existing item, the status is changed to NEW_ITEM.", -"Item in the repository has not been modified since the last update call. This push operation will set status to ACCEPTED state.", -"Connector is facing a repository error regarding this item. Change status to REPOSITORY_ERROR state. Item is unreserved and rescheduled at a future time determined by exponential backoff.", -"Call push with REQUEUE only for items that have been reserved. This action unreserves the item and resets its available time to the wall clock time." +"", +"", +"", +"" ], "type": "string" -} -}, -"type": "object" }, -"PushItemRequest": { -"id": "PushItemRequest", -"properties": { -"connectorName": { -"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", -"type": "string" +"birthday": { +"$ref": "Date", +"description": "Person birthday." }, -"debugOptions": { -"$ref": "DebugOptions", -"description": "Common debug options." +"calendarUrl": { +"$ref": "SafeUrlProto", +"description": "The URL to open the profile owner's primary calendar." }, -"item": { -"$ref": "PushItem", -"description": "Item to push onto the queue." -} +"chatUrl": { +"$ref": "SafeUrlProto", +"description": "The URL to start a chat conversation with the profile owner. For google.com this is a Hangouts URL." }, -"type": "object" +"costCenter": { +"description": "Person's cost center as a string, e.g. \"926: Googler Apps\".", +"type": "string" }, -"QueryActivity": { -"description": "Details about a user's query activity.", -"id": "QueryActivity", -"properties": { -"query": { -"description": "User input query to be logged/removed.", +"department": { +"description": "The person's Organization department, e.g. \"People Operations\". For google.com this is usually called \"area\".", "type": "string" -} }, -"type": "object" +"directReports": { +"description": "A subset of the profile owner's direct reports. The number of entities here may be less than total_direct_reports_count, because typically ProfileResponse does not include all the person's reports, if there are too many to retrieve efficiently. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", +"items": { +"$ref": "PersonCore" }, -"QueryBiasingContext": { -"deprecated": true, -"description": "The message encapsulates the relevant query biasing contexts from a particular client, e.g. an individual Mini-App or an individual Mini-App page. Next id: 3", -"id": "QueryBiasingContext", -"properties": { -"mode": { -"description": "Specifies the mode to bias the queries from the client into. The mode value should be coming from the Mode enum.", -"format": "int32", -"type": "integer" +"type": "array" }, -"prominentEntity": { +"dottedLineManagers": { +"description": "The profile owner's direct dotted line managers in no particular order. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", "items": { -"$ref": "ProminentEntity" +"$ref": "PersonCore" }, "type": "array" -} }, -"type": "object" +"dottedLineReports": { +"description": "A subset of the profile owner's dotted-line reports. The number of entities here may be less than total_dlr_count. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", +"items": { +"$ref": "PersonCore" }, -"QueryCountByStatus": { -"id": "QueryCountByStatus", -"properties": { -"count": { -"format": "int64", -"type": "string" +"type": "array" }, -"statusCode": { -"description": "This represents the http status code.", -"format": "int32", -"type": "integer" -} +"emails": { +"description": "E-mail addresses of the person. The primary or preferred email should be first.", +"items": { +"type": "string" }, -"type": "object" +"type": "array" }, -"QueryInterpretation": { -"id": "QueryInterpretation", -"properties": { -"interpretationType": { -"enum": [ -"NONE", -"BLEND", -"REPLACE" -], -"enumDescriptions": [ -"Neither the natural language interpretation, nor a broader version of the query is used to fetch the search results.", -"The results from original query are blended with other results. The reason for blending these other results with the results from original query is populated in the 'Reason' field below.", -"The results from original query are replaced. The reason for replacing the results from original query is populated in the 'Reason' field below." -], +"employeeId": { +"description": "Person's employee number (external ID of type \"organization\") For google.com this is the badge number (e.g. 2 for Larry Page).", "type": "string" }, -"interpretedQuery": { -"description": "The interpretation of the query used in search. For example, queries with natural language intent like \"email from john\" will be interpreted as \"from:john source:mail\". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.", +"fingerprint": { +"description": "A fingerprint used by PAPI to reliably determine if a resource has changed Externally it is used as part of the etag.", "type": "string" }, -"reason": { -"description": "The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.", -"enum": [ -"UNSPECIFIED", -"QUERY_HAS_NATURAL_LANGUAGE_INTENT", -"NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY" -], -"enumDescriptions": [ -"", -"Natural language interpretation of the query is used to fetch the search results.", -"Query and document terms similarity is used to selectively broaden the query to retrieve additional search results since enough results were not found for the user query. Interpreted query will be empty for this case." -], +"ftePermille": { +"description": "Full-time equivalent (in \u2030) (e.g. 800 for a person who's working 80%).", +"format": "int64", "type": "string" -} -}, -"type": "object" }, -"QueryInterpretationConfig": { -"description": "Default options to interpret user query.", -"id": "QueryInterpretationConfig", -"properties": { -"forceDisableSupplementalResults": { -"description": "Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.", -"type": "boolean" +"geoLocation": { +"$ref": "MapInfo" }, -"forceVerbatimMode": { -"description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.", -"type": "boolean" -} +"gmailUrl": { +"type": "string" }, -"type": "object" +"jobTitle": { +"description": "Profile owner's job title (e.g. \"Software Engineer\"). For google.com this is the Workday preferred job title.", +"type": "string" }, -"QueryInterpretationOptions": { -"description": "Options to interpret user query.", -"id": "QueryInterpretationOptions", -"properties": { -"disableNlInterpretation": { -"description": "Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.", -"type": "boolean" +"keywordTypes": { +"description": "List of keys to use from the map 'keywords'.", +"items": { +"type": "string" }, -"disableSupplementalResults": { -"description": "Use this flag to disable supplemental results for a query. Supplemental results setting chosen at SearchApplication level will take precedence if set to True.", -"type": "boolean" +"type": "array" }, -"enableVerbatimMode": { -"description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true.", -"type": "boolean" -} +"keywords": { +"additionalProperties": { +"type": "string" }, +"description": "Custom keywords the domain admin has added.", "type": "object" }, -"QueryItem": { -"description": "Information relevant only to a query entry.", -"id": "QueryItem", -"properties": { -"isSynthetic": { -"description": "True if the text was generated by means other than a previous user search.", -"type": "boolean" -} +"links": { +"description": "Custom links the profile owner has added.", +"items": { +"$ref": "EnterpriseTopazFrontendTeamsLink" }, -"type": "object" +"type": "array" }, -"QueryOperator": { -"description": "The definition of a operator that can be used in a Search/Suggest request.", -"id": "QueryOperator", -"properties": { -"displayName": { -"description": "Display name of the operator", +"location": { +"description": "Detailed desk location within the company. For google.com this is the desk location code (e.g. \"DE-MUC-ARP-6T2-6T2C0C\") if the person has a desk.", "type": "string" }, -"enumValues": { -"description": "Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator.", +"managers": { +"description": "The profile owner's management chain from top to bottom, where managers[0] is the CEO, manager[N-2] is the person's manager's manager and managers[N-1] is the person's direct manager. Note that not all fields of these PersonCores will be set, in particular, relationships will be empty.", "items": { -"type": "string" +"$ref": "PersonCore" }, "type": "array" }, -"greaterThanOperatorName": { -"description": "Indicates the operator name that can be used to isolate the property using the greater-than operator.", +"mission": { +"description": "Custom mission statement the profile owner has added.", "type": "string" }, -"isFacetable": { -"description": "Can this operator be used to get facets.", -"type": "boolean" +"name": { +"description": "Human-readable Unicode display name.", +"type": "string" }, -"isRepeatable": { -"description": "Indicates if multiple values can be set for this property.", -"type": "boolean" +"officeLocation": { +"description": "Office/building identifier within the company. For google.com this is the office code (e.g. \"DE-MUC-ARP\").", +"type": "string" }, -"isReturnable": { -"description": "Will the property associated with this facet be returned as part of search results.", -"type": "boolean" +"personId": { +"description": "The person's obfuscated Gaia ID.", +"type": "string" }, -"isSortable": { -"description": "Can this operator be used to sort results.", -"type": "boolean" +"phoneNumbers": { +"items": { +"$ref": "EnterpriseTopazFrontendTeamsPersonCorePhoneNumber" }, -"isSuggestable": { -"description": "Can get suggestions for this field.", -"type": "boolean" +"type": "array" }, -"lessThanOperatorName": { -"description": "Indicates the operator name that can be used to isolate the property using the less-than operator.", +"photoUrl": { +"$ref": "SafeUrlProto", +"description": "Person photo." +}, +"postalAddress": { +"description": "Postal address of office/building.", "type": "string" }, -"objectType": { -"description": "The name of the object corresponding to the operator. This field is only filled for schema-specific operators, and is unset for common operators.", +"totalDirectReportsCount": { +"description": "Total count of the profile owner's direct reports.", +"format": "int32", +"type": "integer" +}, +"totalDlrCount": { +"description": "Total count of the profile owner's dotted-line reports.", +"format": "int32", +"type": "integer" +}, +"totalFteCount": { +"description": "The sum of all profile owner's reports and their own full-time-equivalents in \u2030 (e.g. 1800 if one report is working 80% and profile owner 100%).", +"format": "int64", "type": "string" }, -"operatorName": { -"description": "The name of the operator.", +"username": { +"description": "External ID of type \"login_id\" for the profile. For google.com this is the username/LDAP.", +"type": "string" +}, +"waldoComeBackTime": { +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"PhoneNumber": { +"description": "A person's Phone Number", +"id": "PhoneNumber", +"properties": { +"phoneNumber": { +"description": "The phone number of the person.", "type": "string" }, "type": { -"description": "The type of the operator.", "enum": [ -"UNKNOWN", -"INTEGER", -"DOUBLE", -"TIMESTAMP", -"BOOLEAN", -"ENUM", -"DATE", -"TEXT", -"HTML" +"OTHER", +"MOBILE", +"OFFICE" ], "enumDescriptions": [ -"Invalid value.", -"", -"", -"", -"", -"", "", "", "" @@ -20685,860 +6324,779 @@ false }, "type": "object" }, -"QuerySource": { -"description": "List of sources that the user can search using the query API.", -"id": "QuerySource", +"Photo": { +"description": "A person's photo.", +"id": "Photo", "properties": { -"displayName": { -"description": "Display name of the data source.", -"type": "string" -}, -"operators": { -"description": "List of all operators applicable for this source.", -"items": { -"$ref": "QueryOperator" -}, -"type": "array" -}, -"shortName": { -"description": "A short name or alias for the source. This value can be used with the 'source' operator.", +"url": { +"description": "The URL of the photo.", "type": "string" -}, -"source": { -"$ref": "Source", -"description": "The name of the source" -} -}, -"type": "object" -}, -"QuerySuggestion": { -"description": "This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.", -"id": "QuerySuggestion", -"properties": {}, -"type": "object" -}, -"RemoveActivityRequest": { -"description": "Remove Logged Activity Request.", -"id": "RemoveActivityRequest", -"properties": { -"requestOptions": { -"$ref": "RequestOptions", -"description": "Request options, such as the search application and clientId." -}, -"userActivity": { -"$ref": "UserActivity", -"description": "User Activity containing the data to be deleted." } }, "type": "object" }, -"RemoveActivityResponse": { -"description": "Remove Logged Activity Response. will return an empty response for now. Will be revisited in later phases.", -"id": "RemoveActivityResponse", -"properties": {}, -"type": "object" -}, -"RepositoryError": { -"description": "Errors when the connector is communicating to the source repository.", -"id": "RepositoryError", +"PollItemsRequest": { +"id": "PollItemsRequest", "properties": { -"errorMessage": { -"description": "Message that describes the error. The maximum allowable length of the message is 8192 characters.", +"connectorName": { +"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", "type": "string" }, -"httpStatusCode": { -"description": "Error codes. Matches the definition of HTTP status codes.", +"debugOptions": { +"$ref": "DebugOptions", +"description": "Common debug options." +}, +"limit": { +"description": "Maximum number of items to return. The maximum value is 100 and the default value is 20.", "format": "int32", "type": "integer" }, -"type": { -"description": "The type of error.", -"enum": [ -"UNKNOWN", -"NETWORK_ERROR", -"DNS_ERROR", -"CONNECTION_ERROR", -"AUTHENTICATION_ERROR", -"AUTHORIZATION_ERROR", -"SERVER_ERROR", -"QUOTA_EXCEEDED", -"SERVICE_UNAVAILABLE", -"CLIENT_ERROR" -], -"enumDescriptions": [ -"Unknown error.", -"Unknown or unreachable host.", -"DNS problem, such as the DNS server is not responding.", -"Cannot connect to the repository server.", -"Failed authentication due to incorrect credentials.", -"Service account is not authorized for the repository.", -"Repository server error.", -"Quota exceeded.", -"Server temporarily unavailable.", -"Client-related error, such as an invalid request from the connector to the repository server." +"queue": { +"description": "Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.", +"type": "string" +}, +"statusCodes": { +"description": "Limit the items polled to the ones with these statuses.", +"items": { +"enum": [ +"CODE_UNSPECIFIED", +"ERROR", +"MODIFIED", +"NEW_ITEM", +"ACCEPTED" +], +"enumDescriptions": [ +"Input-only value. Used with Items.list to list all items in the queue, regardless of status.", +"Error encountered by Cloud Search while processing this item. Details of the error are in repositoryError.", +"Item has been modified in the repository, and is out of date with the version previously accepted into Cloud Search.", +"Item is known to exist in the repository, but is not yet accepted by Cloud Search. An item can be in this state when Items.push has been called for an item of this name that did not exist previously.", +"API has accepted the up-to-date data of this item." ], "type": "string" +}, +"type": "array" } }, "type": "object" }, -"RequestOptions": { -"description": "Shared request options for all RPC methods.", -"id": "RequestOptions", +"PollItemsResponse": { +"id": "PollItemsResponse", "properties": { -"debugOptions": { -"$ref": "DebugOptions", -"description": "Debug options of the request" -}, -"languageCode": { -"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions.", -"type": "string" -}, -"searchApplicationId": { -"description": "The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).", -"type": "string" +"items": { +"description": "Set of items from the queue available for connector to process. These items have the following subset of fields populated: version metadata.hash structured_data.hash content.hash payload status queue", +"items": { +"$ref": "Item" }, -"timeZone": { -"description": "Current user's time zone id, such as \"America/Los_Angeles\" or \"Australia/Sydney\". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.", -"type": "string" +"type": "array" } }, "type": "object" }, -"ResetSearchApplicationRequest": { -"id": "ResetSearchApplicationRequest", +"Principal": { +"description": "Reference to a user, group, or domain.", +"id": "Principal", "properties": { -"debugOptions": { -"$ref": "DebugOptions", -"description": "Common debug options." +"groupResourceName": { +"description": "This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}", +"type": "string" +}, +"gsuitePrincipal": { +"$ref": "GSuitePrincipal", +"description": "This principal is a Google Workspace user, group or domain." +}, +"userResourceName": { +"description": "This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}", +"type": "string" } }, "type": "object" }, -"ResponseDebugInfo": { -"description": "Debugging information about the response.", -"id": "ResponseDebugInfo", +"ProcessingError": { +"id": "ProcessingError", "properties": { -"formattedDebugInfo": { -"description": "General debug info formatted for display.", +"code": { +"description": "Error code indicating the nature of the error.", +"enum": [ +"PROCESSING_ERROR_CODE_UNSPECIFIED", +"MALFORMED_REQUEST", +"UNSUPPORTED_CONTENT_FORMAT", +"INDIRECT_BROKEN_ACL", +"ACL_CYCLE" +], +"enumDescriptions": [ +"Input only value. Use this value in Items.", +"Item's ACL, metadata, or content is malformed or in invalid state. FieldViolations contains more details on where the problem is.", +"Countent format is unsupported.", +"Items with incomplete ACL information due to inheriting other items with broken ACL or having groups with unmapped descendants.", +"ACL inheritance graph formed a cycle." +], +"type": "string" +}, +"errorMessage": { +"description": "The description of the error.", "type": "string" +}, +"fieldViolations": { +"description": "In case the item fields are invalid, this field contains the details about the validation errors.", +"items": { +"$ref": "FieldViolation" +}, +"type": "array" } }, "type": "object" }, -"RestrictItem": { -"description": "Information relevant only to a restrict entry. NextId: 12", -"id": "RestrictItem", +"PropertyDefinition": { +"description": "The definition of a property within an object.", +"id": "PropertyDefinition", "properties": { -"driveFollowUpRestrict": { -"$ref": "DriveFollowUpRestrict" +"booleanPropertyOptions": { +"$ref": "BooleanPropertyOptions" }, -"driveLocationRestrict": { -"$ref": "DriveLocationRestrict" +"datePropertyOptions": { +"$ref": "DatePropertyOptions" }, -"driveMimeTypeRestrict": { -"$ref": "DriveMimeTypeRestrict", -"description": "Drive Types." +"displayOptions": { +"$ref": "PropertyDisplayOptions", +"description": "The options that determine how the property is displayed in the Cloud Search results page if it's specified to be displayed in the object's display options." }, -"driveTimeSpanRestrict": { -"$ref": "DriveTimeSpanRestrict" +"doublePropertyOptions": { +"$ref": "DoublePropertyOptions" }, -"searchOperator": { -"description": "The search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").", +"enumPropertyOptions": { +"$ref": "EnumPropertyOptions" +}, +"htmlPropertyOptions": { +"$ref": "HtmlPropertyOptions" +}, +"integerPropertyOptions": { +"$ref": "IntegerPropertyOptions" +}, +"isFacetable": { +"description": "Indicates that the property can be used for generating facets. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, enum, integer, and text properties.", +"type": "boolean" +}, +"isRepeatable": { +"description": "Indicates that multiple values are allowed for the property. For example, a document only has one description but can have multiple comments. Cannot be true for properties whose type is a boolean. If set to false, properties that contain more than one value cause the indexing request for that item to be rejected.", +"type": "boolean" +}, +"isReturnable": { +"description": "Indicates that the property identifies data that should be returned in search results via the Query API. If set to *true*, indicates that Query API users can use matching property fields in results. However, storing fields requires more space allocation and uses more bandwidth for search queries, which impacts performance over large datasets. Set to *true* here only if the field is needed for search results. Cannot be true for properties whose type is an object.", +"type": "boolean" +}, +"isSortable": { +"description": "Indicates that the property can be used for sorting. Cannot be true for properties that are repeatable. Cannot be true for properties whose type is object. IsReturnable must be true to set this option. Only supported for boolean, date, double, integer, and timestamp properties.", +"type": "boolean" +}, +"isSuggestable": { +"description": "Indicates that the property can be used for generating query suggestions.", +"type": "boolean" +}, +"isWildcardSearchable": { +"description": "Indicates that users can perform wildcard search for this property. Only supported for Text properties. IsReturnable must be true to set this option. In a given datasource maximum of 5 properties can be marked as is_wildcard_searchable. For more details, see [Define object properties](https://developers.google.com/cloud-search/docs/guides/schema-guide#properties)", +"type": "boolean" +}, +"name": { +"description": "The name of the property. Item indexing requests sent to the Indexing API should set the property name equal to this value. For example, if name is *subject_line*, then indexing requests for document items with subject fields should set the name for that field equal to *subject_line*. Use the name as the identifier for the object property. Once registered as a property for an object, you cannot re-use this name for another property within that object. The name must start with a letter and can only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 characters.", "type": "string" -} }, -"type": "object" +"objectPropertyOptions": { +"$ref": "ObjectPropertyOptions" }, -"ResultCounts": { -"description": "Result count information", -"id": "ResultCounts", -"properties": { -"sourceResultCounts": { -"description": "Result count information for each source with results.", -"items": { -"$ref": "SourceResultCount" +"textPropertyOptions": { +"$ref": "TextPropertyOptions" }, -"type": "array" +"timestampPropertyOptions": { +"$ref": "TimestampPropertyOptions" } }, "type": "object" }, -"ResultDebugInfo": { -"description": "Debugging information about the result.", -"id": "ResultDebugInfo", +"PropertyDisplayOptions": { +"description": "The display options for a property.", +"id": "PropertyDisplayOptions", "properties": { -"formattedDebugInfo": { -"description": "General debug info formatted for display.", +"displayLabel": { +"description": "The user friendly label for the property that is used if the property is specified to be displayed in ObjectDisplayOptions. If provided, the display label is shown in front of the property values when the property is part of the object display options. For example, if the property value is '1', the value by itself may not be useful context for the user. If the display name given was 'priority', then the user sees 'priority : 1' in the search results which provides clear context to search users. This is OPTIONAL; if not given, only the property values are displayed. The maximum length is 64 characters.", "type": "string" } }, "type": "object" }, -"ResultDisplayField": { -"description": "Display Fields for Search Results", -"id": "ResultDisplayField", +"PushItem": { +"description": "Represents an item to be pushed to the indexing queue.", +"id": "PushItem", "properties": { -"label": { -"description": "The display label for the property.", +"contentHash": { +"description": "Content hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", "type": "string" }, -"operatorName": { -"description": "The operator name of the property.", +"metadataHash": { +"description": "The metadata hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", "type": "string" }, -"property": { -"$ref": "NamedProperty", -"description": "The name value pair for the property." -} +"payload": { +"description": "Provides additional document state information for the connector, such as an alternate repository ID and other metadata. The maximum length is 8192 bytes.", +"format": "byte", +"type": "string" }, -"type": "object" +"queue": { +"description": "Queue to which this item belongs. The `default` queue is chosen if this field is not specified. The maximum length is 512 characters.", +"type": "string" }, -"ResultDisplayLine": { -"description": "The collection of fields that make up a displayed line", -"id": "ResultDisplayLine", -"properties": { -"fields": { -"items": { -"$ref": "ResultDisplayField" +"repositoryError": { +"$ref": "RepositoryError", +"description": "Populate this field to store Connector or repository error details. This information is displayed in the Admin Console. This field may only be populated when the Type is REPOSITORY_ERROR." }, -"type": "array" +"structuredDataHash": { +"description": "Structured data hash of the item according to the repository. If specified, this is used to determine how to modify this item's status. Setting this field and the type field results in argument error. The maximum length is 2048 characters.", +"type": "string" +}, +"type": { +"description": "The type of the push operation that defines the push behavior.", +"enum": [ +"UNSPECIFIED", +"MODIFIED", +"NOT_MODIFIED", +"REPOSITORY_ERROR", +"REQUEUE" +], +"enumDescriptions": [ +"Default UNSPECIFIED. Specifies that the push operation should not modify ItemStatus", +"Indicates that the repository document has been modified or updated since the previous update call. This changes status to MODIFIED state for an existing item. If this is called on a non existing item, the status is changed to NEW_ITEM.", +"Item in the repository has not been modified since the last update call. This push operation will set status to ACCEPTED state.", +"Connector is facing a repository error regarding this item. Change status to REPOSITORY_ERROR state. Item is unreserved and rescheduled at a future time determined by exponential backoff.", +"Call push with REQUEUE only for items that have been reserved. This action unreserves the item and resets its available time to the wall clock time." +], +"type": "string" } }, "type": "object" }, -"ResultDisplayMetadata": { -"id": "ResultDisplayMetadata", +"PushItemRequest": { +"id": "PushItemRequest", "properties": { -"metalines": { -"description": "The metalines content to be displayed with the result.", -"items": { -"$ref": "ResultDisplayLine" -}, -"type": "array" -}, -"objectTypeLabel": { -"description": "The display label for the object.", +"connectorName": { +"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", "type": "string" +}, +"debugOptions": { +"$ref": "DebugOptions", +"description": "Common debug options." +}, +"item": { +"$ref": "PushItem", +"description": "Item to push onto the queue." } }, "type": "object" }, -"RetrievalImportance": { -"id": "RetrievalImportance", +"QueryActivity": { +"description": "Details about a user's query activity.", +"id": "QueryActivity", "properties": { -"importance": { -"description": "Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed.", -"enum": [ -"DEFAULT", -"HIGHEST", -"HIGH", -"LOW", -"NONE" -], -"enumDescriptions": [ -"Treat the match like a body text match.", -"Treat the match like a match against title of the item.", -"Treat the match with higher importance than body text.", -"Treat the match with lower importance than body text.", -"Do not match against this field during retrieval. The property can still be used for operator matching, faceting, and suggest if desired." -], +"query": { +"description": "User input query to be logged/removed.", "type": "string" } }, "type": "object" }, -"RewrittenQueries": { -"description": "The rewritten queries returned by Apps Search Query Understanding service.", -"id": "RewrittenQueries", +"QueryCountByStatus": { +"id": "QueryCountByStatus", "properties": { -"rewrittenQueries": { -"items": { -"$ref": "RewrittenQuery" -}, -"type": "array" +"count": { +"format": "int64", +"type": "string" }, -"selectedQueryIndex": { -"description": "The index of the selected query in `rewritten_queries` that is used by QAPI to call CSSR to get search results. If none of the queries were used (i.e. they all give empty search results), `selected_query_index` would default to -1.", +"statusCode": { +"description": "This represents the http status code.", "format": "int32", "type": "integer" } }, "type": "object" }, -"RewrittenQuery": { -"id": "RewrittenQuery", +"QueryInterpretation": { +"id": "QueryInterpretation", "properties": { -"rewrittenQuery": { +"interpretationType": { +"enum": [ +"NONE", +"BLEND", +"REPLACE" +], +"enumDescriptions": [ +"Neither the natural language interpretation, nor a broader version of the query is used to fetch the search results.", +"The results from original query are blended with other results. The reason for blending these other results with the results from original query is populated in the 'Reason' field below.", +"The results from original query are replaced. The reason for replacing the results from original query is populated in the 'Reason' field below." +], "type": "string" }, -"score": { -"format": "double", -"type": "number" +"interpretedQuery": { +"description": "The interpretation of the query used in search. For example, queries with natural language intent like \"email from john\" will be interpreted as \"from:john source:mail\". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.", +"type": "string" }, -"sortBy": { +"reason": { +"description": "The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.", "enum": [ -"SORTBY_UNSUPPORTED", -"SORTBY_RELEVANCY", -"SORTBY_LATEST", -"SORTBY_OLDEST", -"SORTBY_LARGEST", -"SORTBY_SMALLEST", -"SORTBY_MODIFY_LATEST", -"SORTBY_MODIFY_OLDEST", -"SORTBY_VIEW_LATEST", -"SORTBY_VIEW_OLDEST", -"SORTBY_CREATE_LATEST", -"SORTBY_CREATE_OLDEST" +"UNSPECIFIED", +"QUERY_HAS_NATURAL_LANGUAGE_INTENT", +"NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY" ], "enumDescriptions": [ "", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"", -"" +"Natural language interpretation of the query is used to fetch the search results.", +"Query and document terms similarity is used to selectively broaden the query to retrieve additional search results since enough results were not found for the user query. Interpreted query will be empty for this case." ], "type": "string" } }, "type": "object" }, -"SafeHtmlProto": { -"description": "IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests.", -"id": "SafeHtmlProto", +"QueryInterpretationConfig": { +"description": "Default options to interpret user query.", +"id": "QueryInterpretationConfig", "properties": { -"privateDoNotAccessOrElseSafeHtmlWrappedValue": { -"description": "IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.", -"type": "string" -} -}, -"type": "object" +"forceDisableSupplementalResults": { +"description": "Set this flag to disable supplemental results retrieval, setting a flag here will not retrieve supplemental results for queries associated with a given search application. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for supplemental results.", +"type": "boolean" }, -"SafeUrlProto": { -"description": "Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code.", -"id": "SafeUrlProto", -"properties": { -"privateDoNotAccessOrElseSafeUrlWrappedValue": { -"description": "IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.", -"type": "string" +"forceVerbatimMode": { +"description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental results retrieval, and usage of synonyms including custom ones. If this flag is set to True, it will take precedence over the option set at Query level. For the default value of False, query level flag will set the correct interpretation for verbatim mode.", +"type": "boolean" } }, "type": "object" }, -"Schema": { -"description": "The schema definition for a data source.", -"id": "Schema", +"QueryInterpretationOptions": { +"description": "Options to interpret user query.", +"id": "QueryInterpretationOptions", "properties": { -"objectDefinitions": { -"description": "The list of top-level objects for the data source. The maximum number of elements is 10.", -"items": { -"$ref": "ObjectDefinition" -}, -"type": "array" +"disableNlInterpretation": { +"description": "Flag to disable natural language (NL) interpretation of queries. Default is false, Set to true to disable natural language interpretation. NL interpretation only applies to predefined datasources.", +"type": "boolean" }, -"operationIds": { -"description": "IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for operations to complete before indexing additional content.", -"items": { -"type": "string" +"disableSupplementalResults": { +"description": "Use this flag to disable supplemental results for a query. Supplemental results setting chosen at SearchApplication level will take precedence if set to True.", +"type": "boolean" }, -"type": "array" +"enableVerbatimMode": { +"description": "Enable this flag to turn off all internal optimizations like natural language (NL) interpretation of queries, supplemental result retrieval, and usage of synonyms including custom ones. Nl interpretation will be disabled if either one of the two flags is true.", +"type": "boolean" } }, "type": "object" }, -"ScoringConfig": { -"description": "Scoring configurations for a source while processing a Search or Suggest request.", -"id": "ScoringConfig", +"QueryItem": { +"description": "Information relevant only to a query entry.", +"id": "QueryItem", "properties": { -"disableFreshness": { -"description": "Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.", -"type": "boolean" -}, -"disablePersonalization": { -"description": "Whether to personalize the results. By default, personal signals will be used to boost results.", +"isSynthetic": { +"description": "True if the text was generated by means other than a previous user search.", "type": "boolean" } }, "type": "object" }, -"SearchApplication": { -"description": "SearchApplication", -"id": "SearchApplication", +"QueryOperator": { +"description": "The definition of a operator that can be used in a Search/Suggest request.", +"id": "QueryOperator", "properties": { -"dataSourceRestrictions": { -"description": "Retrictions applied to the configurations. The maximum number of elements is 10.", -"items": { -"$ref": "DataSourceRestriction" -}, -"type": "array" -}, -"defaultFacetOptions": { -"description": "The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.", -"items": { -"$ref": "FacetOptions" -}, -"type": "array" -}, -"defaultSortOptions": { -"$ref": "SortOptions", -"description": "The default options for sorting the search results" -}, "displayName": { -"description": "Display name of the Search Application. The maximum length is 300 characters.", -"type": "string" -}, -"enableAuditLog": { -"description": "Indicates whether audit logging is on/off for requests made for the search application in query APIs.", -"type": "boolean" -}, -"name": { -"description": "The name of the Search Application. Format: searchapplications/{application_id}.", +"description": "Display name of the operator", "type": "string" }, -"operationIds": { -"description": "Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.", +"enumValues": { +"description": "Potential list of values for the opeatror field. This field is only filled when we can safely enumerate all the possible values of this operator.", "items": { "type": "string" }, -"readOnly": true, -"type": "array" -}, -"queryInterpretationConfig": { -"$ref": "QueryInterpretationConfig", -"description": "The default options for query interpretation" -}, -"returnResultThumbnailUrls": { -"description": "With each result we should return the URI for its thumbnail (when applicable)", -"type": "boolean" -}, -"scoringConfig": { -"$ref": "ScoringConfig", -"description": "Configuration for ranking results." -}, -"sourceConfig": { -"description": "Configuration for a sources specified in data_source_restrictions.", -"items": { -"$ref": "SourceConfig" -}, -"type": "array" -} -}, -"type": "object" -}, -"SearchApplicationQueryStats": { -"description": "Search application level query stats per date", -"id": "SearchApplicationQueryStats", -"properties": { -"date": { -"$ref": "Date", -"description": "The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned." -}, -"queryCountByStatus": { -"items": { -"$ref": "QueryCountByStatus" -}, "type": "array" -} -}, -"type": "object" -}, -"SearchApplicationSessionStats": { -"id": "SearchApplicationSessionStats", -"properties": { -"date": { -"$ref": "Date", -"description": "The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned." }, -"searchSessionsCount": { -"description": "The count of search sessions on the day", -"format": "int64", +"greaterThanOperatorName": { +"description": "Indicates the operator name that can be used to isolate the property using the greater-than operator.", "type": "string" -} }, -"type": "object" +"isFacetable": { +"description": "Can this operator be used to get facets.", +"type": "boolean" +}, +"isRepeatable": { +"description": "Indicates if multiple values can be set for this property.", +"type": "boolean" }, -"SearchApplicationUserStats": { -"id": "SearchApplicationUserStats", -"properties": { -"date": { -"$ref": "Date", -"description": "The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned." +"isReturnable": { +"description": "Will the property associated with this facet be returned as part of search results.", +"type": "boolean" }, -"oneDayActiveUsersCount": { -"description": "The count of unique active users in the past one day", -"format": "int64", -"type": "string" +"isSortable": { +"description": "Can this operator be used to sort results.", +"type": "boolean" }, -"sevenDaysActiveUsersCount": { -"description": "The count of unique active users in the past seven days", -"format": "int64", -"type": "string" +"isSuggestable": { +"description": "Can get suggestions for this field.", +"type": "boolean" }, -"thirtyDaysActiveUsersCount": { -"description": "The count of unique active users in the past thirty days", -"format": "int64", +"lessThanOperatorName": { +"description": "Indicates the operator name that can be used to isolate the property using the less-than operator.", "type": "string" -} -}, -"type": "object" }, -"SearchItemsByViewUrlRequest": { -"id": "SearchItemsByViewUrlRequest", -"properties": { -"debugOptions": { -"$ref": "DebugOptions", -"description": "Common debug options." +"objectType": { +"description": "The name of the object corresponding to the operator. This field is only filled for schema-specific operators, and is unset for common operators.", +"type": "string" }, -"pageToken": { -"description": "The next_page_token value returned from a previous request, if any.", +"operatorName": { +"description": "The name of the operator.", "type": "string" }, -"viewUrl": { -"description": "Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.", +"type": { +"description": "The type of the operator.", +"enum": [ +"UNKNOWN", +"INTEGER", +"DOUBLE", +"TIMESTAMP", +"BOOLEAN", +"ENUM", +"DATE", +"TEXT", +"HTML" +], +"enumDescriptions": [ +"Invalid value.", +"", +"", +"", +"", +"", +"", +"", +"" +], "type": "string" } }, "type": "object" }, -"SearchItemsByViewUrlResponse": { -"id": "SearchItemsByViewUrlResponse", +"QuerySource": { +"description": "List of sources that the user can search using the query API.", +"id": "QuerySource", "properties": { +"displayName": { +"description": "Display name of the data source.", +"type": "string" +}, +"operators": { +"description": "List of all operators applicable for this source.", "items": { -"items": { -"$ref": "Item" +"$ref": "QueryOperator" }, "type": "array" }, -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", +"shortName": { +"description": "A short name or alias for the source. This value can be used with the 'source' operator.", "type": "string" +}, +"source": { +"$ref": "Source", +"description": "The name of the source" } }, "type": "object" }, -"SearchQualityMetadata": { -"description": "Additional search quality metadata of the item.", -"id": "SearchQualityMetadata", -"properties": { -"quality": { -"description": "An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.", -"format": "double", -"type": "number" -} -}, +"QuerySuggestion": { +"description": "This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.", +"id": "QuerySuggestion", +"properties": {}, "type": "object" }, -"SearchRequest": { -"description": "The search API request.", -"id": "SearchRequest", +"RemoveActivityRequest": { +"description": "Remove Logged Activity Request.", +"id": "RemoveActivityRequest", "properties": { -"contextAttributes": { -"description": "Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.", -"items": { -"$ref": "ContextAttribute" -}, -"type": "array" +"requestOptions": { +"$ref": "RequestOptions", +"description": "Request options, such as the search application and clientId." }, -"dataSourceRestrictions": { -"description": "The sources to use for querying. If not specified, all data sources from the current search application are used.", -"items": { -"$ref": "DataSourceRestriction" +"userActivity": { +"$ref": "UserActivity", +"description": "User Activity containing the data to be deleted." +} }, -"type": "array" +"type": "object" }, -"facetOptions": { -"items": { -"$ref": "FacetOptions" +"RemoveActivityResponse": { +"description": "Remove Logged Activity Response. will return an empty response for now. Will be revisited in later phases.", +"id": "RemoveActivityResponse", +"properties": {}, +"type": "object" }, -"type": "array" +"RepositoryError": { +"description": "Errors when the connector is communicating to the source repository.", +"id": "RepositoryError", +"properties": { +"errorMessage": { +"description": "Message that describes the error. The maximum allowable length of the message is 8192 characters.", +"type": "string" }, -"pageSize": { -"description": "Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested.", +"httpStatusCode": { +"description": "Error codes. Matches the definition of HTTP status codes.", "format": "int32", "type": "integer" }, -"query": { -"description": "The raw query string. See supported search operators in the [Narrow your search with operators](https://support.google.com/cloudsearch/answer/6172299)", +"type": { +"description": "The type of error.", +"enum": [ +"UNKNOWN", +"NETWORK_ERROR", +"DNS_ERROR", +"CONNECTION_ERROR", +"AUTHENTICATION_ERROR", +"AUTHORIZATION_ERROR", +"SERVER_ERROR", +"QUOTA_EXCEEDED", +"SERVICE_UNAVAILABLE", +"CLIENT_ERROR" +], +"enumDescriptions": [ +"Unknown error.", +"Unknown or unreachable host.", +"DNS problem, such as the DNS server is not responding.", +"Cannot connect to the repository server.", +"Failed authentication due to incorrect credentials.", +"Service account is not authorized for the repository.", +"Repository server error.", +"Quota exceeded.", +"Server temporarily unavailable.", +"Client-related error, such as an invalid request from the connector to the repository server." +], "type": "string" -}, -"queryInterpretationOptions": { -"$ref": "QueryInterpretationOptions", -"description": "Options to interpret the user query." -}, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Request options, such as the search application and user timezone." -}, -"sortOptions": { -"$ref": "SortOptions", -"description": "The options for sorting the search results" -}, -"start": { -"description": "Starting index of the results.", -"format": "int32", -"type": "integer" } }, "type": "object" }, -"SearchResponse": { -"description": "The search API response.", -"id": "SearchResponse", +"RequestOptions": { +"description": "Shared request options for all RPC methods.", +"id": "RequestOptions", "properties": { -"debugInfo": { -"$ref": "ResponseDebugInfo", -"description": "Debugging information about the response." +"debugOptions": { +"$ref": "DebugOptions", +"description": "Debug options of the request" }, -"errorInfo": { -"$ref": "ErrorInfo", -"description": "Error information about the response." +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions.", +"type": "string" }, -"facetResults": { -"description": "Repeated facet results.", -"items": { -"$ref": "FacetResult" +"searchApplicationId": { +"description": "The ID generated when you create a search application using the [admin console](https://support.google.com/a/answer/9043922).", +"type": "string" }, -"type": "array" +"timeZone": { +"description": "Current user's time zone id, such as \"America/Los_Angeles\" or \"Australia/Sydney\". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.", +"type": "string" +} }, -"hasMoreResults": { -"description": "Whether there are more search results matching the query.", -"type": "boolean" +"type": "object" }, -"queryInterpretation": { -"$ref": "QueryInterpretation", -"description": "Query interpretation result for user query. Empty if query interpretation is disabled." +"ResetSearchApplicationRequest": { +"id": "ResetSearchApplicationRequest", +"properties": { +"debugOptions": { +"$ref": "DebugOptions", +"description": "Common debug options." +} }, -"resultCountEstimate": { -"description": "The estimated result count for this query.", -"format": "int64", -"type": "string" +"type": "object" }, -"resultCountExact": { -"description": "The exact result count for this query.", -"format": "int64", +"ResponseDebugInfo": { +"description": "Debugging information about the response.", +"id": "ResponseDebugInfo", +"properties": { +"formattedDebugInfo": { +"description": "General debug info formatted for display.", "type": "string" +} }, -"resultCounts": { -"$ref": "ResultCounts", -"description": "Expanded result count information." -}, -"results": { -"description": "Results from a search query.", -"items": { -"$ref": "SearchResult" +"type": "object" }, -"type": "array" +"RestrictItem": { +"description": "Information relevant only to a restrict entry. NextId: 12", +"id": "RestrictItem", +"properties": { +"driveFollowUpRestrict": { +"$ref": "DriveFollowUpRestrict" }, -"spellResults": { -"description": "Suggested spelling for the query.", -"items": { -"$ref": "SpellResult" +"driveLocationRestrict": { +"$ref": "DriveLocationRestrict" }, -"type": "array" +"driveMimeTypeRestrict": { +"$ref": "DriveMimeTypeRestrict", +"description": "Drive Types." }, -"structuredResults": { -"description": "Structured results for the user query. These results are not counted against the page_size.", -"items": { -"$ref": "StructuredResult" +"driveTimeSpanRestrict": { +"$ref": "DriveTimeSpanRestrict" }, -"type": "array" +"searchOperator": { +"description": "The search restrict (e.g. \"after:2017-09-11 before:2017-09-12\").", +"type": "string" } }, "type": "object" }, -"SearchResult": { -"description": "Results containing indexed information for a document.", -"id": "SearchResult", +"ResultCounts": { +"description": "Result count information", +"id": "ResultCounts", "properties": { -"clusteredResults": { -"description": "If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty.", +"sourceResultCounts": { +"description": "Result count information for each source with results.", "items": { -"$ref": "SearchResult" +"$ref": "SourceResultCount" }, "type": "array" +} }, -"debugInfo": { -"$ref": "ResultDebugInfo", -"description": "Debugging information about this search result." +"type": "object" }, -"metadata": { -"$ref": "Metadata", -"description": "Metadata of the search result." +"ResultDebugInfo": { +"description": "Debugging information about the result.", +"id": "ResultDebugInfo", +"properties": { +"formattedDebugInfo": { +"description": "General debug info formatted for display.", +"type": "string" +} }, -"snippet": { -"$ref": "Snippet", -"description": "The concatenation of all snippets (summaries) available for this result." +"type": "object" }, -"title": { -"description": "Title of the search result.", +"ResultDisplayField": { +"description": "Display Fields for Search Results", +"id": "ResultDisplayField", +"properties": { +"label": { +"description": "The display label for the property.", "type": "string" }, -"url": { -"description": "The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed.", +"operatorName": { +"description": "The operator name of the property.", "type": "string" +}, +"property": { +"$ref": "NamedProperty", +"description": "The name value pair for the property." } }, "type": "object" }, -"Snippet": { -"description": "Snippet of the search result, which summarizes the content of the resulting page.", -"id": "Snippet", +"ResultDisplayLine": { +"description": "The collection of fields that make up a displayed line", +"id": "ResultDisplayLine", "properties": { -"matchRanges": { -"description": "The matched ranges in the snippet.", +"fields": { "items": { -"$ref": "MatchRange" +"$ref": "ResultDisplayField" }, "type": "array" -}, -"snippet": { -"description": "The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering.", -"type": "string" } }, "type": "object" }, -"SortOptions": { -"id": "SortOptions", +"ResultDisplayMetadata": { +"id": "ResultDisplayMetadata", "properties": { -"operatorName": { -"description": "The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.", -"type": "string" +"metalines": { +"description": "The metalines content to be displayed with the result.", +"items": { +"$ref": "ResultDisplayLine" }, -"sortOrder": { -"description": "Ascending is the default sort order", -"enum": [ -"ASCENDING", -"DESCENDING" -], -"enumDescriptions": [ -"", -"" -], +"type": "array" +}, +"objectTypeLabel": { +"description": "The display label for the object.", "type": "string" } }, "type": "object" }, -"Source": { -"description": "Defines sources for the suggest/search APIs.", -"id": "Source", +"RetrievalImportance": { +"id": "RetrievalImportance", "properties": { -"name": { -"description": "Source name for content indexed by the Indexing API.", -"type": "string" -}, -"predefinedSource": { -"description": "Predefined content source for Google Apps.", +"importance": { +"description": "Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed.", "enum": [ -"NONE", -"QUERY_HISTORY", -"PERSON", -"GOOGLE_DRIVE", -"GOOGLE_GMAIL", -"GOOGLE_SITES", -"GOOGLE_GROUPS", -"GOOGLE_CALENDAR", -"GOOGLE_KEEP" +"DEFAULT", +"HIGHEST", +"HIGH", +"LOW", +"NONE" ], "enumDescriptions": [ -"", -"Suggests queries issued by the user in the past. Only valid when used with the suggest API. Ignored when used in the query API.", -"Suggests people in the organization. Only valid when used with the suggest API. Results in an error when used in the query API.", -"", -"", -"", -"", -"", -"" +"Treat the match like a body text match.", +"Treat the match like a match against title of the item.", +"Treat the match with higher importance than body text.", +"Treat the match with lower importance than body text.", +"Do not match against this field during retrieval. The property can still be used for operator matching, faceting, and suggest if desired." ], "type": "string" } }, "type": "object" }, -"SourceConfig": { -"description": "Configurations for a source while processing a Search or Suggest request.", -"id": "SourceConfig", +"RewrittenQueries": { +"description": "The rewritten queries returned by Apps Search Query Understanding service.", +"id": "RewrittenQueries", "properties": { -"crowdingConfig": { -"$ref": "SourceCrowdingConfig", -"description": "The crowding configuration for the source." -}, -"scoringConfig": { -"$ref": "SourceScoringConfig", -"description": "The scoring configuration for the source." -}, -"source": { -"$ref": "Source", -"description": "The source for which this configuration is to be used." -} -}, -"type": "object" +"rewrittenQueries": { +"items": { +"$ref": "RewrittenQuery" }, -"SourceCrowdingConfig": { -"description": "Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host \"crowd out\" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.", -"id": "SourceCrowdingConfig", -"properties": { -"numResults": { -"description": "Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.", -"format": "int32", -"type": "integer" +"type": "array" }, -"numSuggestions": { -"description": "Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.", +"selectedQueryIndex": { +"description": "The index of the selected query in `rewritten_queries` that is used by QAPI to call CSSR to get search results. If none of the queries were used (i.e. they all give empty search results), `selected_query_index` would default to -1.", "format": "int32", "type": "integer" } }, "type": "object" }, -"SourceResultCount": { -"description": "Per source result count information.", -"id": "SourceResultCount", +"RewrittenQuery": { +"id": "RewrittenQuery", "properties": { -"hasMoreResults": { -"description": "Whether there are more search results for this source.", -"type": "boolean" -}, -"resultCountEstimate": { -"description": "The estimated result count for this source.", -"format": "int64", -"type": "string" -}, -"resultCountExact": { -"description": "The exact result count for this source.", -"format": "int64", +"rewrittenQuery": { "type": "string" }, -"source": { -"$ref": "Source", -"description": "The source the result count information is associated with." -} -}, -"type": "object" +"score": { +"format": "double", +"type": "number" }, -"SourceScoringConfig": { -"description": "Set the scoring configuration. This allows modifying the ranking of results for a source.", -"id": "SourceScoringConfig", -"properties": { -"sourceImportance": { -"description": "Importance of the source.", +"sortBy": { "enum": [ -"DEFAULT", -"LOW", -"HIGH" +"SORTBY_UNSUPPORTED", +"SORTBY_RELEVANCY", +"SORTBY_LATEST", +"SORTBY_OLDEST", +"SORTBY_LARGEST", +"SORTBY_SMALLEST", +"SORTBY_MODIFY_LATEST", +"SORTBY_MODIFY_OLDEST", +"SORTBY_VIEW_LATEST", +"SORTBY_VIEW_OLDEST", +"SORTBY_CREATE_LATEST", +"SORTBY_CREATE_OLDEST" ], "enumDescriptions": [ "", "", +"", +"", +"", +"", +"", +"", +"", +"", +"", "" ], "type": "string" @@ -21546,814 +7104,692 @@ false }, "type": "object" }, -"SpellResult": { -"id": "SpellResult", +"SafeHtmlProto": { +"description": "IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests.", +"id": "SafeHtmlProto", "properties": { -"suggestedQuery": { -"description": "The suggested spelling of the query.", +"privateDoNotAccessOrElseSafeHtmlWrappedValue": { +"description": "IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.", "type": "string" +} }, -"suggestedQueryHtml": { -"$ref": "SafeHtmlProto", -"description": "The sanitized HTML representing the spell corrected query that can be used in the UI. This usually has language-specific tags to mark up parts of the query that are spell checked." +"type": "object" }, -"suggestionType": { -"description": "Suggestion triggered for the current query.", -"enum": [ -"SUGGESTION_TYPE_UNSPECIFIED", -"NON_EMPTY_RESULTS_SPELL_SUGGESTION", -"ZERO_RESULTS_FULL_PAGE_REPLACEMENT" -], -"enumDescriptions": [ -"Default spell check type", -"Spell suggestion without any results changed. The results are still shown for the original query (which has non zero / results) with a suggestion for spelling that would have results.", -"Spell suggestion triggered when original query has no results. When the original query has no results, and spell suggestion has results we trigger results for the spell corrected query." -], +"SafeUrlProto": { +"description": "Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code.", +"id": "SafeUrlProto", +"properties": { +"privateDoNotAccessOrElseSafeUrlWrappedValue": { +"description": "IMPORTANT: Never set or read this field, even from tests, it is private. See documentation at the top of .proto file for programming language packages with which to create or read this message.", "type": "string" } }, "type": "object" }, -"StarlightConsistency": { -"id": "StarlightConsistency", +"Schema": { +"description": "The schema definition for a data source.", +"id": "Schema", "properties": { -"consistency": { -"$ref": "MessageSet", -"description": "Optional, data-source specific, data to help achieve consistency." +"objectDefinitions": { +"description": "The list of top-level objects for the data source. The maximum number of elements is 10.", +"items": { +"$ref": "ObjectDefinition" }, -"timestampSec": { -"description": "Timestamp of last write operation. By setting this value, a client requests to trigger a new fresh data acquisition if the fresh model is older than this timestamp.", -"format": "double", -"type": "number" +"type": "array" +}, +"operationIds": { +"description": "IDs of the Long Running Operations (LROs) currently running for this schema. After modifying the schema, wait for operations to complete before indexing additional content.", +"items": { +"type": "string" +}, +"type": "array" } }, "type": "object" }, -"StartUploadItemRequest": { -"description": "Start upload file request.", -"id": "StartUploadItemRequest", +"ScoringConfig": { +"description": "Scoring configurations for a source while processing a Search or Suggest request.", +"id": "ScoringConfig", "properties": { -"connectorName": { -"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", -"type": "string" +"disableFreshness": { +"description": "Whether to use freshness as a ranking signal. By default, freshness is used as a ranking signal. Note that this setting is not available in the Admin UI.", +"type": "boolean" }, -"debugOptions": { -"$ref": "DebugOptions", -"description": "Common debug options." +"disablePersonalization": { +"description": "Whether to personalize the results. By default, personal signals will be used to boost results.", +"type": "boolean" } }, "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", +"SearchApplication": { +"description": "SearchApplication", +"id": "SearchApplication", "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.", +"dataSourceRestrictions": { +"description": "Retrictions applied to the configurations. The maximum number of elements is 10.", "items": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"$ref": "DataSourceRestriction" }, -"type": "object" +"type": "array" +}, +"defaultFacetOptions": { +"description": "The default fields for returning facet results. The sources specified here also have been included in data_source_restrictions above.", +"items": { +"$ref": "FacetOptions" }, "type": "array" }, -"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.", +"defaultSortOptions": { +"$ref": "SortOptions", +"description": "The default options for sorting the search results" +}, +"displayName": { +"description": "Display name of the Search Application. The maximum length is 300 characters.", "type": "string" -} }, -"type": "object" +"enableAuditLog": { +"description": "Indicates whether audit logging is on/off for requests made for the search application in query APIs.", +"type": "boolean" }, -"StructuredDataObject": { -"description": "A structured data object consisting of named properties.", -"id": "StructuredDataObject", -"properties": { -"properties": { -"description": "The properties for the object. The maximum number of elements is 1000.", +"name": { +"description": "The name of the Search Application. Format: searchapplications/{application_id}.", +"type": "string" +}, +"operationIds": { +"description": "Output only. IDs of the Long Running Operations (LROs) currently running for this schema. Output only field.", "items": { -"$ref": "NamedProperty" +"type": "string" }, +"readOnly": true, "type": "array" -} }, -"type": "object" +"queryInterpretationConfig": { +"$ref": "QueryInterpretationConfig", +"description": "The default options for query interpretation" }, -"StructuredResult": { -"description": "Structured results that are returned as part of search request.", -"id": "StructuredResult", -"properties": { -"person": { -"$ref": "Person", -"description": "Representation of a person" +"returnResultThumbnailUrls": { +"description": "With each result we should return the URI for its thumbnail (when applicable)", +"type": "boolean" +}, +"scoringConfig": { +"$ref": "ScoringConfig", +"description": "Configuration for ranking results." +}, +"sourceConfig": { +"description": "Configuration for a sources specified in data_source_restrictions.", +"items": { +"$ref": "SourceConfig" +}, +"type": "array" } }, "type": "object" }, -"SuggestPersonalRerankDebugInfo": { -"description": "Representation of user history for personal reranking. Debug only. Can be used for: 1) Manually entering the field to Suggest http debug GUI. 2) Sending protobuf using stubby tool. 3) Unit tests. 4) Offline analysis. Next ID to use: 3.", -"id": "SuggestPersonalRerankDebugInfo", +"SearchApplicationQueryStats": { +"description": "Search application level query stats per date", +"id": "SearchApplicationQueryStats", "properties": { -"additionalInfo": { -"$ref": "MessageSet", -"description": "Can be used to store additional user history." +"date": { +"$ref": "Date", +"description": "The date for which query stats were calculated. Stats calculated on the next day close to midnight are returned." }, -"userHistory": { -"description": "The first query is considered to be the most recent query.", +"queryCountByStatus": { "items": { -"type": "string" +"$ref": "QueryCountByStatus" }, "type": "array" } }, "type": "object" }, -"SuggestRequest": { -"description": "Request of suggest API.", -"id": "SuggestRequest", +"SearchApplicationSessionStats": { +"id": "SearchApplicationSessionStats", "properties": { -"dataSourceRestrictions": { -"description": "The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are only supported for the following sources: * Third-party data sources * PredefinedSource.PERSON * PredefinedSource.GOOGLE_DRIVE", -"items": { -"$ref": "DataSourceRestriction" -}, -"type": "array" +"date": { +"$ref": "Date", +"description": "The date for which session stats were calculated. Stats are calculated on the following day, close to midnight PST, and then returned." }, -"query": { -"description": "Partial query for which autocomplete suggestions will be shown. For example, if the query is \"sea\", then the server might return \"season\", \"search\", \"seagull\" and so on.", +"searchSessionsCount": { +"description": "The count of search sessions on the day", +"format": "int64", "type": "string" -}, -"requestOptions": { -"$ref": "RequestOptions", -"description": "Request options, such as the search application and user timezone." } }, "type": "object" }, -"SuggestRequestDebugOptions": { -"description": "Next ID to use: 13.", -"id": "SuggestRequestDebugOptions", +"SearchApplicationUserStats": { +"id": "SearchApplicationUserStats", "properties": { -"annotateWithSubtype": { -"description": "Whether to add the subtype to the suggestion so it can be displayed in a side-by-side", -"type": "boolean" -}, -"debug": { -"description": "Whether to enable debug info in SuggestResults.", -"type": "boolean" +"date": { +"$ref": "Date", +"description": "The date for which session stats were calculated. Stats calculated on the next day close to midnight are returned." }, -"disableBadwordFiltering": { -"type": "boolean" +"oneDayActiveUsersCount": { +"description": "The count of unique active users in the past one day", +"format": "int64", +"type": "string" }, -"disableHybridCache": { -"description": "Whether to disable the hybrid cache.", -"type": "boolean" +"sevenDaysActiveUsersCount": { +"description": "The count of unique active users in the past seven days", +"format": "int64", +"type": "string" }, -"disableKesemFiltering": { -"type": "boolean" +"thirtyDaysActiveUsersCount": { +"description": "The count of unique active users in the past thirty days", +"format": "int64", +"type": "string" +} }, -"enableGetDataFromStarlightForPersonalSxs": { -"description": "Whether to pull personal data from Starlight like Anima profile data for personal SxS eval.", -"type": "boolean" +"type": "object" }, -"enablePersonal": { -"description": "Whether to add the user gaia_id to the request, so it can return personal suggestions.", -"type": "boolean" +"SearchItemsByViewUrlRequest": { +"id": "SearchItemsByViewUrlRequest", +"properties": { +"debugOptions": { +"$ref": "DebugOptions", +"description": "Common debug options." }, -"freshMode": { -"enum": [ -"ENABLE_FRESH", -"DISABLE_FRESH", -"FORCE_FRESH", -"FORCE_FRESH_ONLY" -], -"enumDescriptions": [ -"Activate fresh when supported - the usual case.", -"Never return fresh completions.", -"Always activate fresh completions.", -"Always return only fresh completions." -], +"pageToken": { +"description": "The next_page_token value returned from a previous request, if any.", "type": "string" }, -"numResults": { -"description": "Number of results to return. If 0, this options is ignored. Is NOT subject to the upper bound limit controlled by num_results_limit_max_override flag", -"format": "int32", -"type": "integer" -}, -"sxs": { -"type": "boolean" -}, -"trace": { -"enum": [ -"NONE", -"ABBREVIATED_TRACE", -"FULL_TRACE" -], -"enumDescriptions": [ -"", -"", -"" -], +"viewUrl": { +"description": "Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.", "type": "string" } }, "type": "object" }, -"SuggestResponse": { -"description": "Response of the suggest API.", -"id": "SuggestResponse", +"SearchItemsByViewUrlResponse": { +"id": "SearchItemsByViewUrlResponse", "properties": { -"suggestResults": { -"description": "List of suggestions.", "items": { -"$ref": "SuggestResult" -}, -"type": "array" -} -}, -"type": "object" +"items": { +"$ref": "Item" }, -"SuggestRestrict": { -"id": "SuggestRestrict", -"properties": { -"name": { -"description": "Name of the restrict, e.g. lang.", -"type": "string" +"type": "array" }, -"value": { -"description": "Restrict value.", +"nextPageToken": { +"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", "type": "string" } }, "type": "object" }, -"SuggestResult": { -"description": "One suggestion result.", -"id": "SuggestResult", +"SearchQualityMetadata": { +"description": "Additional search quality metadata of the item.", +"id": "SearchQualityMetadata", "properties": { -"peopleSuggestion": { -"$ref": "PeopleSuggestion", -"description": "This is present when the suggestion indicates a person. It contains more information about the person - like their email ID, name etc." -}, -"querySuggestion": { -"$ref": "QuerySuggestion", -"description": "This field will be present if the suggested query is a word/phrase completion." -}, -"source": { -"$ref": "Source", -"description": "The source of the suggestion." -}, -"suggestedQuery": { -"description": "The suggested query that will be used for search, when the user clicks on the suggestion", -"type": "string" +"quality": { +"description": "An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.", +"format": "double", +"type": "number" } }, "type": "object" }, -"SuggestSuggestRequest": { -"description": "Protos for the stubby interface. Next IDs to use: 37, 38, 39, 40, 43, 44, 46, 47, 48, 71, 77, 100.", -"id": "SuggestSuggestRequest", +"SearchRequest": { +"description": "The search API request.", +"id": "SearchRequest", "properties": { -"requestdata": { +"contextAttributes": { +"description": "Context attributes for the request which will be used to adjust ranking of search results. The maximum number of elements is 10.", "items": { -"$ref": "SuggestSuggestRequestRequestData" +"$ref": "ContextAttribute" }, "type": "array" -} }, -"type": "object" +"dataSourceRestrictions": { +"description": "The sources to use for querying. If not specified, all data sources from the current search application are used.", +"items": { +"$ref": "DataSourceRestriction" }, -"SuggestSuggestRequestRequestData": { -"description": "A suggest request can ask for completions for one query only. For multiple request data an error is returned. Next IDs to use: 135.", -"id": "SuggestSuggestRequestRequestData", -"properties": { -"DEPRECATEDInfiniteSuggest": { -"description": "Whether to run in Infinite Suggest mode.", -"type": "boolean" +"type": "array" }, -"addedCharacterCount": { -"description": "Number of sequentially added characters after a sequential deletion.", -"format": "int32", -"type": "integer" +"facetOptions": { +"items": { +"$ref": "FacetOptions" }, -"calc": { -"description": "Enable calculator. Turning this field on will cause Complete Server to fill the SuggestResults.CalculatorSuggestion string field and it instead disables all the oneboxes (in SuggestResults.CompleteSuggestion.info), including the calculator onebox. Clients that are capable of rendering oneboxes should use the onebox calculator (and should leave this field turned off). When not specified, the default value of this field depends on the client. See suggestflow_state.cc: CommonInit().", -"type": "boolean" +"type": "array" }, -"cityId": { -"description": "City location ID.", +"pageSize": { +"description": "Maximum number of search results to return in one page. Valid values are between 1 and 100, inclusive. Default value is 10. Minimum value is 50 when results beyond 2000 are requested.", "format": "int32", "type": "integer" }, -"client": { -"description": "The name of the requesting client (firefox, chrome, etc.).", +"query": { +"description": "The raw query string. See supported search operators in the [Narrow your search with operators](https://support.google.com/cloudsearch/answer/6172299)", "type": "string" }, -"clientInstanceId": { -"description": "The client instance ID provided by AGSA. See http://go/client-instance-id", -"type": "string" +"queryInterpretationOptions": { +"$ref": "QueryInterpretationOptions", +"description": "Options to interpret the user query." }, -"clientThumbnailDimensions": { -"$ref": "SuggestSuggestRequestRequestDataClientThumbnailDimensions" +"requestOptions": { +"$ref": "RequestOptions", +"description": "Request options, such as the search application and user timezone." }, -"complete": { -"description": "Enable completion.", -"type": "boolean" +"sortOptions": { +"$ref": "SortOptions", +"description": "The options for sorting the search results" +}, +"start": { +"description": "Starting index of the results.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"SearchResponse": { +"description": "The search API response.", +"id": "SearchResponse", +"properties": { +"debugInfo": { +"$ref": "ResponseDebugInfo", +"description": "Debugging information about the response." }, -"consistency": { -"$ref": "StarlightConsistency", -"description": "Allow sending read-after-write consistency data to Starlight." +"errorInfo": { +"$ref": "ErrorInfo", +"description": "Error information about the response." }, -"contextUrls": { -"description": "Repeated list of URLs that we use to trigger context based suggestions (currently zero-prefix).", +"facetResults": { +"description": "Repeated facet results.", "items": { -"type": "string" +"$ref": "FacetResult" }, "type": "array" }, -"cookieInitTime": { -"description": "cookie_init_time is typically set by GoogleCookie::initial_time()", -"format": "int32", -"type": "integer" +"hasMoreResults": { +"description": "Whether there are more search results matching the query.", +"type": "boolean" }, -"country": { -"description": "Requested country (us, uk, jp, cn, etc.).", -"type": "string" +"queryInterpretation": { +"$ref": "QueryInterpretation", +"description": "Query interpretation result for user query. Empty if query interpretation is disabled." }, -"countryByIp": { -"description": "Country as determined by GeoIP.", +"resultCountEstimate": { +"description": "The estimated result count for this query.", +"format": "int64", "type": "string" }, -"cp": { -"description": "Cursor position (for result-page requests).", -"format": "int32", -"type": "integer" -}, -"dasherDomain": { -"description": "The dasher domain of the searcher.", +"resultCountExact": { +"description": "The exact result count for this query.", "format": "int64", "type": "string" }, -"debug": { -"description": "Enable debug output.", -"type": "boolean" +"resultCounts": { +"$ref": "ResultCounts", +"description": "Expanded result count information." }, -"debugOptions": { -"$ref": "SuggestRequestDebugOptions" +"results": { +"description": "Results from a search query.", +"items": { +"$ref": "SearchResult" }, -"deletedCharacters": { -"description": "Any sequentially deleted characters after the cursor position.", -"type": "string" +"type": "array" }, -"deviceOsVersion": { -"type": "string" +"spellResults": { +"description": "Suggested spelling for the query.", +"items": { +"$ref": "SpellResult" }, -"ds": { -"description": "Requested dataset (i, m, yt, etc.).", -"type": "string" +"type": "array" }, -"enableVisualSuggest": { -"description": "Whether to enable Visual Suggest. (Currently used for YouTube Suggest) Clients can opt to disable Visual Suggest based on current device specs and network conditions.", -"type": "boolean" +"structuredResults": { +"description": "Structured results for the user query. These results are not counted against the page_size.", +"items": { +"$ref": "StructuredResult" }, -"expid": { -"description": "Experiment ID.", -"type": "string" +"type": "array" +} }, -"forceUserLocation": { -"description": "Define the way to read data from the location context.", -"type": "boolean" +"type": "object" }, -"frozenClock": { -"description": "Parameter frozen_clock in microseconds passed by SXS eval. This will be used as random number generator bit for consistent randomization for SXS tests.", -"format": "int64", -"type": "string" +"SearchResult": { +"description": "Results containing indexed information for a document.", +"id": "SearchResult", +"properties": { +"clusteredResults": { +"description": "If source is clustered, provide list of clustered results. There will only be one level of clustered results. If current source is not enabled for clustering, this field will be empty.", +"items": { +"$ref": "SearchResult" }, -"gaiaId": { -"description": "Gaia ID for personal suggestions. Format is that of http://displayserver.corp.google.com/ Use ParseLeadingHex64Value in numbers.h to convert to an uint64", -"type": "string" +"type": "array" }, -"hourOfTheWeek": { -"description": "Hour of the week (UTC).", -"format": "int32", -"type": "integer" +"debugInfo": { +"$ref": "ResultDebugInfo", +"description": "Debugging information about this search result." }, -"includeAnswerData": { -"description": "For each completion, annotate with: https://cs.corp.google.com/#piper///depot/google3/suggest/base/ answer.proto&l=15&rcl=53295698&pv=1 which is the probability that issuing the completion as a query will result in an answer being displayed to the user (live-result,one-box, etc.) If there is no answer type for which the probability is above zero, the completion will not be annotated.", -"type": "boolean" +"metadata": { +"$ref": "Metadata", +"description": "Metadata of the search result." }, -"includeLocalSignals": { -"deprecated": true, -"type": "boolean" +"snippet": { +"$ref": "Snippet", +"description": "The concatenation of all snippets (summaries) available for this result." }, -"includeWebrefAnnotations": { -"description": "Annotate the suggestions with webref data.", -"type": "boolean" +"title": { +"description": "Title of the search result.", +"type": "string" }, -"ipAddress": { -"description": "The user's ip address. Should NOT be used to override domain.", +"url": { +"description": "The URL of the search result. The URL contains a Google redirect to the actual item. This URL is signed and shouldn't be changed.", "type": "string" +} }, -"isConsole": { -"description": "True only when using the CS debug console.", -"type": "boolean" +"type": "object" }, -"isDebugIp": { -"description": "Set once by the server. Can be used for dog-fooding or tests.", -"type": "boolean" +"Snippet": { +"description": "Snippet of the search result, which summarizes the content of the resulting page.", +"id": "Snippet", +"properties": { +"matchRanges": { +"description": "The matched ranges in the snippet.", +"items": { +"$ref": "MatchRange" }, -"isMobileDevice": { -"description": "The following two fields, is_mobile_device and is_mobile_ux are used to denote whether the request comes from a mobile device or a device with mobile user experience. It's possible for a device type to be different than UX type since tablet devices could receive either mobile or desktop UX, as explained in go/ux-tier-logging.", -"type": "boolean" +"type": "array" }, -"isMobileUx": { -"type": "boolean" +"snippet": { +"description": "The snippet of the document. May contain escaped HTML character that should be unescaped prior to rendering.", +"type": "string" +} }, -"isNonCorpDasherAccount": { -"description": "For users who are using Google Apps for work (dasher) but are not internal users, we would like to turn off instant apps.", -"type": "boolean" +"type": "object" }, -"isRequestFromChina": { -"description": "Indicates whether the request comes from china.", -"type": "boolean" +"SortOptions": { +"id": "SortOptions", +"properties": { +"operatorName": { +"description": "The name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.", +"type": "string" }, -"isUnicornAccount": { -"description": "Whether the user's account is a Unicorn child account.", -"type": "boolean" +"sortOrder": { +"description": "Ascending is the default sort order", +"enum": [ +"ASCENDING", +"DESCENDING" +], +"enumDescriptions": [ +"", +"" +], +"type": "string" +} }, -"isUserInitiatedRequest": { -"description": "This field should be set to false for requests that are generated due to something other than user interaction. For example: 0-prefix requests could be sent in the background (e.g. periodically) for updating a client side cache. On Android GSA, see http://go/android-0q-cache. Backends, such as Starlight, can then use this signal, e.g. for matters like load-shedding.", -"type": "boolean" +"type": "object" }, -"isVoiceQuery": { -"description": "Whether the query was from voice search (set by Youtube LR)", -"type": "boolean" +"Source": { +"description": "Defines sources for the suggest/search APIs.", +"id": "Source", +"properties": { +"name": { +"description": "Source name for content indexed by the Indexing API.", +"type": "string" +}, +"predefinedSource": { +"description": "Predefined content source for Google Apps.", +"enum": [ +"NONE", +"QUERY_HISTORY", +"PERSON", +"GOOGLE_DRIVE", +"GOOGLE_GMAIL", +"GOOGLE_SITES", +"GOOGLE_GROUPS", +"GOOGLE_CALENDAR", +"GOOGLE_KEEP" +], +"enumDescriptions": [ +"", +"Suggests queries issued by the user in the past. Only valid when used with the suggest API. Ignored when used in the query API.", +"Suggests people in the organization. Only valid when used with the suggest API. Results in an error when used in the query API.", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"SourceConfig": { +"description": "Configurations for a source while processing a Search or Suggest request.", +"id": "SourceConfig", +"properties": { +"crowdingConfig": { +"$ref": "SourceCrowdingConfig", +"description": "The crowding configuration for the source." }, -"lang": { -"description": "Requested language (en, ru, iw, etc.).", -"type": "string" +"scoringConfig": { +"$ref": "SourceScoringConfig", +"description": "The scoring configuration for the source." }, -"latitude": { -"description": "GPS coordinates of the mobile client in degrees, if known.", -"format": "float", -"type": "number" +"source": { +"$ref": "Source", +"description": "The source for which this configuration is to be used." +} }, -"locationContext": { -"$ref": "LocationUnifiedLocationContext", -"description": "Oolong LocationContext (see http://goto/oolong)." +"type": "object" }, -"locationId": { -"description": "Region location ID.", +"SourceCrowdingConfig": { +"description": "Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host \"crowd out\" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.", +"id": "SourceCrowdingConfig", +"properties": { +"numResults": { +"description": "Maximum number of results allowed from a datasource in a result page as long as results from other sources are not exhausted. Value specified must not be negative. A default value is used if this value is equal to 0. To disable crowding, set the value greater than 100.", "format": "int32", "type": "integer" }, -"logFlakyBackends": { -"description": "If true, will log if there was any flaky backend in SuggestResponse.", -"type": "boolean" +"numSuggestions": { +"description": "Maximum number of suggestions allowed from a source. No limits will be set on results if this value is less than or equal to 0.", +"format": "int32", +"type": "integer" +} }, -"longitude": { -"format": "float", -"type": "number" +"type": "object" }, -"lookaheadAdditionalResultsOnly": { -"deprecated": true, -"description": "If true, only fetch lookahead buffer and ignore suggest_results.", +"SourceResultCount": { +"description": "Per source result count information.", +"id": "SourceResultCount", +"properties": { +"hasMoreResults": { +"description": "Whether there are more search results for this source.", "type": "boolean" }, -"lookaheadCoverage": { -"deprecated": true, -"description": "If set, sends enough suggest results to cover the specified ratio of probable next characters the user will type.", -"format": "double", -"type": "number" -}, -"mapsMissPrefix": { -"description": "State that overrides whether or not the maps fallback flow should run.", +"resultCountEstimate": { +"description": "The estimated result count for this source.", +"format": "int64", "type": "string" }, -"nav": { -"description": "Enable navsuggest.", -"type": "boolean" -}, -"news": { -"description": "Enable news.", -"type": "boolean" +"resultCountExact": { +"description": "The exact result count for this source.", +"format": "int64", +"type": "string" }, -"numNavResults": { -"description": "Upper limit of the number of navsuggest results to return.", -"format": "int32", -"type": "integer" +"source": { +"$ref": "Source", +"description": "The source the result count information is associated with." +} }, -"numResultsLimit": { -"description": "Number of suggestions to return. * In non Generic-Suggest clients, when set, this overrides the client configuration. Subject to upper bound limit controlled by num_results_limit_max_override flag. * In Generic-Suggest clients, when set, this caps the number of suggestions in addition to the client configuration. Ignores num_results_limit_max_override flag.", -"format": "int32", -"type": "integer" +"type": "object" }, -"omniboxFocusType": { -"description": "Chrome Omnibox focus type. This param is passed in \"oft\" CGI param.", +"SourceScoringConfig": { +"description": "Set the scoring configuration. This allows modifying the ranking of results for a source.", +"id": "SourceScoringConfig", +"properties": { +"sourceImportance": { +"description": "Importance of the source.", "enum": [ -"INTERACTION_DEFAULT", -"INTERACTION_FOCUS", -"INTERACTION_CLOBBER" +"DEFAULT", +"LOW", +"HIGH" ], "enumDescriptions": [ -"The default value. This is used for any search requests without any special interaction annotation, including: normal omnibox searches, as-you-type omnibox suggestions, as well as non-omnibox searches.", -"This search request is triggered by the user focusing the omnibox.", -"This search request is triggered by the user deleting all of the omnibox permanent text at once, i.e. user is on \"https://example.com\", does Ctrl+L which selects the whole URL, then presses Backspace. Note that INTERACTION_CLOBBER applies in fairly limited circumstances. For example, the following cases do NOT qualify and are instead marked as INTERACTION_DEFAULT: - User deletes their own typed text. - User deletes the permanent text one character at a time. - User uses Cut (Ctrl+X) to delete the permanent text." +"", +"", +"" ], "type": "string" +} }, -"omniboxInputType": { -"description": "Chrome Omnibox input type. This param is passed in \"oit\" CGI param.", -"enum": [ -"EMPTY", -"UNKNOWN", -"DEPRECATED_REQUESTED_URL", -"URL", -"QUERY", -"DEPRECATED_FORCED_QUERY" -], -"enumDescriptions": [ -"Empty input", -"Valid input whose type cannot be determined", -"DEPRECATED. Input autodetected as UNKNOWN, which the user wants to treat as an URL by specifying a desired_tld.", -"Input autodetected as a URL", -"Input autodetected as a query", -"DEPRECATED. Input forced to be a query by an initial '?'" -], +"type": "object" +}, +"SpellResult": { +"id": "SpellResult", +"properties": { +"suggestedQuery": { +"description": "The suggested spelling of the query.", "type": "string" }, -"omniboxPageClassification": { -"description": "Chrome Omnibox page classification. This param is passed in \"pgcl\" CGI param.", +"suggestedQueryHtml": { +"$ref": "SafeHtmlProto", +"description": "The sanitized HTML representing the spell corrected query that can be used in the UI. This usually has language-specific tags to mark up parts of the query that are spell checked." +}, +"suggestionType": { +"description": "Suggestion triggered for the current query.", "enum": [ -"INVALID_SPEC", -"NTP", -"BLANK", -"HOME_PAGE", -"OTHER", -"OBSOLETE_INSTANT_NTP", -"SEARCH_RESULT_PAGE_DOING_SEARCH_TERM_REPLACEMENT", -"INSTANT_NTP_WITH_OMNIBOX_AS_STARTING_FOCUS", -"INSTANT_NTP_WITH_FAKEBOX_AS_STARTING_FOCUS", -"SEARCH_RESULT_PAGE_NO_SEARCH_TERM_REPLACEMENT", -"APP_HOME", -"APP_SEARCH", -"APP_MAPS", -"SEARCH_BUTTON_AS_STARTING_FOCUS", -"CHROMEOS_APP_LIST", -"NTP_REALBOX", -"ANDROID_SEARCH_WIDGET", -"START_SURFACE_HOMEPAGE", -"START_SURFACE_NEW_TAB", -"ANDROID_SHORTCUTS_WIDGET", -"NTP_ZPS_PREFETCH", -"JOURNEYS", -"SRP_ZPS_PREFETCH", -"OTHER_ZPS_PREFETCH", -"CONTEXTUAL_SEARCHBOX", -"SEARCH_SIDE_PANEL_SEARCHBOX", -"LENS_SIDE_PANEL_SEARCHBOX", -"SEARCH_RESULT_PAGE_ON_CCT", -"OTHER_ON_CCT" +"SUGGESTION_TYPE_UNSPECIFIED", +"NON_EMPTY_RESULTS_SPELL_SUGGESTION", +"ZERO_RESULTS_FULL_PAGE_REPLACEMENT" ], "enumDescriptions": [ -"BEGIN_GOOGLE_INTERNAL LINT.IfChange(omnibox_page_context) END_GOOGLE_INTERNAL An invalid URL; shouldn't happen.", -"chrome://newtab/. For modern versions of Chrome, this is only reported when an extension is replacing the new tab page. Otherwise, new tab page interactions will be reported as NTP_REALBOX, INSTANT_NTP_WITH_FAKEBOX_AS_STARTING_FOCUS or INSTANT_NTP_WITH_OMNIBOX_AS_STARTING_FOCUS. For old versions of Chrome, this was reported for the default New Tab Page.", -"about:blank.", -"The user's home page. Note that if the home page is set to any of the new tab page versions or to about:blank, then we'll classify the page into those categories, not HOME_PAGE.", -"The catch-all entry of everything not included somewhere else on this list.", -"The instant new tab page. DEPRECATED on August 2, 2013.", -"The user is on a search result page that does search term replacement. This means the search terms are shown in the omnibox instead of the URL. In other words: Query in Omnibox is Active for this SRP.", -"The new tab page in which this omnibox interaction first started with the user having focus in the omnibox.", -"The new tab page in which this omnibox interaction first started with the user having focus in the fakebox. This is replaced by NTP_REALBOX. DEPRECATED on Aug 17, 2020.", -"The user is on a search result page that does not do search term replacement. This means the URL of the SRP is shown in the omnibox. In other words: Query in Omnibox is Inactive for this SRP.", -"The user is on the home screen.", -"The user is in the search app.", -"The user is in the maps app.", -"This omnibox interaction started with the user tapping the search button.", -"This interaction started with the user focusing or typing in the search box of the ChromeOS app list (a.k.a., launcher).", -"The new tab page in which this omnibox interaction started with the user having focus in the realbox.", -"Android's Search Widget started directly from Launcher.", -"Android's Start surface homepage. DEPRECATED on Jun 17, 2022.", -"New Tab with Omnibox focused with Android's start surface finale enabled. DEPRECATED on Jun 17, 2022.", -"Android's improved Search Widget with new suggestions.", -"The New Tab Page zero-prefix suggestion prefetch. Used for prefetching suggestions and should never appear in an OmniboxEventProto or any of its derived histograms. (PageClassification enum is used in other places too, and not only OmniboxEventProto.)", -"Used for Journeys requests in its landing page, side Panel or the NTP. Should never appear in an OmniboxEventProto or any of its derived histograms. (PageClassification enum is used in other places too, and not only OmniboxEventProto.)", -"The Search Results Page zero-prefix suggestion prefetch. Used for prefetching suggestions and should never appear in an OmniboxEventProto or any of its derived histograms. (PageClassification enum is used in other places too, and not only OmniboxEventProto.)", -"The catch-all zero-prefix suggestion prefetch for everything other than NTP and SRP. Used for prefetching suggestions and should never appear in an OmniboxEventProto or any of its derived histograms. (PageClassification enum is used in other places too, and not only OmniboxEventProto.)", -"The searchbox in the lens overlay. BEGIN_GOOGLE_INTERNAL Used by the searchbox in the lens overlay (pre selection) which is contextual to the page. See go/chromnient-suggest-backend-integration for more details. END_GOOGLE_INTERNAL", -"The searchbox in the search side panel. BEGIN_GOOGLE_INTERNAL Used by the search side panel searchbox (post text-selection) which may or may not be contextual to the page. See go/chromnient-suggest-backend-integration for more details. END_GOOGLE_INTERNAL", -"The searchbox in the lens side panel. BEGIN_GOOGLE_INTERNAL Used by the lens side panel searchbox (post image-selection) which is multimodal. See go/chromnient-suggest-backend-integration for more details. END_GOOGLE_INTERNAL", -"The user is visiting a search result page using Chrome Custom Tab. Equivalent of SEARCH_RESULT_PAGE_NO_SEARCH_TERM_REPLACEMENT for CCT.", -"The user is visiting a non DSE web page using Chrome Custom Tab. Equivalent of OTHER for CCT." +"Default spell check type", +"Spell suggestion without any results changed. The results are still shown for the original query (which has non zero / results) with a suggestion for spelling that would have results.", +"Spell suggestion triggered when original query has no results. When the original query has no results, and spell suggestion has results we trigger results for the spell corrected query." ], "type": "string" +} }, -"opaOpaqueToken": { -"deprecated": true, -"description": "The OPA opaque token provided by OPA. NOTE: Deprecated. Please use consistency.FootprintsVersionInfo.version_info.", -"type": "string" -}, -"optInContext": { -"$ref": "ClientOptInContext", -"description": "The opt-in context passed by GSA for App History suggestions. The opt-in context has a list of apps that should be excluded from the personalized App History suggestions. More details at: go/apphistory-suggestions." -}, -"params": { -"$ref": "MessageSet", -"description": "Any additional SuggestRequest::RequestData params, like: RequestAndReferenceOverride (see experiments/suggest_experiment.proto): overrides the default client options; useful for enabling a feature on top of existing features defined for a given client. Person: extra params required by the people flow. MapsHeadRequestParams: extra params used by the maps head flow. OnFocusRequestParams: extra params used by on-focus request. SrDataForSuggestContextualizationRequestParams: extra params used by the SR for suggest context flow. MultimodalSuggestImageSignals: extra params used by Multimodal suggest flow." -}, -"personalRerankDebugInfo": { -"$ref": "SuggestPersonalRerankDebugInfo", -"description": "The user debug info used in testing, offline analysis." +"type": "object" }, -"prefId": { -"deprecated": true, -"description": "Deprecated.", +"StartUploadItemRequest": { +"description": "Start upload file request.", +"id": "StartUploadItemRequest", +"properties": { +"connectorName": { +"description": "The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}", "type": "string" }, -"previousQuery": { -"description": "For result-page requests.", -"type": "string" +"debugOptions": { +"$ref": "DebugOptions", +"description": "Common debug options." +} +}, +"type": "object" }, -"previousQuerySeconds": { -"description": "Seconds since the previous_query was issued. Default value -1 means this field is not set in request.", +"Status": { +"description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", +"id": "Status", +"properties": { +"code": { +"description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", "type": "integer" }, -"previousVideoId": { -"description": "Video id for the most recently watched Youtube Video on Android App. See go/pvideo-suggest for more details. Don't use this directly, instead use request_context->video_or_pvideo_id().", -"type": "string" -}, -"previousVideoSeconds": { -"description": "Time in seconds since end of watch on the most recently watched Youtube Video on Android App.", -"format": "int64", -"type": "string" -}, -"query": { -"description": "Ask Google Suggest server for completions for this query.", -"type": "string" -}, -"queryBiasingContext": { -"$ref": "QueryBiasingContext" -}, -"referrer": { -"description": "The HTTP request's referrer, it will be set for requests coming from web (desktop or mobile).", -"type": "string" -}, -"restrict": { -"description": "Thirdparty restricted search.", +"details": { +"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { -"$ref": "SuggestRestrict" -}, -"type": "array" -}, -"runtimeData": { -"$ref": "SuggestSuggestRequestRequestDataRuntimeData" -}, -"selectionEnd": { -"description": "End position of the user's selection (if any).", -"format": "int32", -"type": "integer" +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" }, -"shouldPersonalize": { -"description": "Specifies whether we should personalize Suggest results. Based on whether this field is set or not, we have the following interpretations: (1) this field is not set - we request a Kansas check to be done in PSuggest server (fall back to the user personalization settings) Note: this is the default behavior (2) this field is set to true - this forces personalization regardless Kansas settings (3) this field is set to false - this disables personalization (PSuggest flows are not invoked) Note: Originally, we planned to have Kansas check in GWS, however it turns out that Kansas is not on Suggest path and we were forced to implement this check in PSuggest server. See http://b/5265965 for more details.", -"type": "boolean" +"type": "object" }, -"siteRestrict": { -"description": "Requests suggestions for query restricted to specified site. Should be a sitename (ex: 'youtube.com')", -"type": "string" +"type": "array" }, -"sourceLang": { -"description": "The source language for dictionary/translate (en, ru, iw, etc.).", +"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" +} }, -"spell": { -"description": "Enable spell correction.", -"type": "boolean" +"type": "object" }, -"spellingExperimentIds": { -"deprecated": true, -"description": "Deprecated: GWS Experiment Ids that are tagged for Spelling.", +"StructuredDataObject": { +"description": "A structured data object consisting of named properties.", +"id": "StructuredDataObject", +"properties": { +"properties": { +"description": "The properties for the object. The maximum number of elements is 1000.", "items": { -"format": "int32", -"type": "integer" +"$ref": "NamedProperty" }, "type": "array" +} }, -"startIndex": { -"description": "If non-negative, determines the start index (starting at 0) for results: a value of '0' is a no-opt; and e.g. a value of '20' would skip the first 20 suggestions, returning results 21 - ?? (e.g. ?? = 30 if num_results_limit = 10). Currently, this is only used by PSuggest, and will be ignored by all other suggest backends.", -"format": "int32", -"type": "integer" -}, -"suggestRequestId": { -"description": "Request options, filled in a runtime.", -"format": "int32", -"type": "integer" -}, -"suppressBolding": { -"description": "Suppress fragment generation and bolding.", -"type": "boolean" -}, -"suppressPluspages": { -"description": "Disables pluspage suggestions. This overrides client config. Intended for temporary UI state change as it happens when toolbar is activated.", -"type": "boolean" -}, -"targetLang": { -"description": "The target language for dictionary/translate (en, ru, iw, etc.).", -"type": "string" -}, -"textAhead": { -"description": "For querynation, this is the psychic completed part of the query. For example if the user has entered [cancun hote] in the searchbox and this completes to [cancun hotels], then text_ahead=\"ls\".", -"type": "string" -}, -"uncorrectedOriginalQuery": { -"description": "Original query before it was refined or corrected (set by Youtube LR)", -"type": "string" -}, -"userAgent": { -"description": "The user agent string, to be used temporarily within CompleteServer to accurately compute data volume estimate for additional events added to Sessions for Proxima (namely, go/search-metrics-and-triggering-proxima). ", -"type": "string" -}, -"userLocationFeatureId": { -"description": "FeatureId associated with user location (from Oolong) as a string", -"type": "string" -}, -"userLocationResult": { -"deprecated": true, -"description": "Index of the result in location_context.results field that best describes the user location.", -"format": "int32", -"type": "integer" +"type": "object" }, -"userPrefs": { -"$ref": "SuggestSuggestRequestRequestDataUserPreferences" +"StructuredResult": { +"description": "Structured results that are returned as part of search request.", +"id": "StructuredResult", +"properties": { +"person": { +"$ref": "Person", +"description": "Representation of a person" +} }, -"uuld": { -"description": "Override the user location. Used for debugging.", -"type": "string" +"type": "object" }, -"videoId": { -"description": "Video id for the currently watching Youtube Video. Don't use this directly, instead use request_context->video_or_pvideo_id().", -"type": "string" +"SuggestRequest": { +"description": "Request of suggest API.", +"id": "SuggestRequest", +"properties": { +"dataSourceRestrictions": { +"description": "The sources to use for suggestions. If not specified, the data sources are taken from the current search application. NOTE: Suggestions are only supported for the following sources: * Third-party data sources * PredefinedSource.PERSON * PredefinedSource.GOOGLE_DRIVE", +"items": { +"$ref": "DataSourceRestriction" }, -"visitorData": { -"description": "Encrypted YouTube Visitor Data (see go/visitor-id-suggest). For privacy reasons, visitor_data can only be set in absence of gaia_id.", -"type": "string" +"type": "array" }, -"youtubeExternalChannelId": { -"description": "External YouTube Channel ID for channel scoped suggestions. This ID is is passed through for creator features and is used to fetch channel personalized suggestions.", +"query": { +"description": "Partial query for which autocomplete suggestions will be shown. For example, if the query is \"sea\", then the server might return \"season\", \"search\", \"seagull\" and so on.", "type": "string" }, -"zwiebackId": { -"description": "zwieback_id is set by GoogleCookie::uid() For SxS we override zwieback_id, please access through SuggestFlowUtils::GetZwiebackId(...).", -"type": "string" +"requestOptions": { +"$ref": "RequestOptions", +"description": "Request options, such as the search application and user timezone." } }, "type": "object" }, -"SuggestSuggestRequestRequestDataClientThumbnailDimensions": { -"description": "The thumbnail dimensions as per client requirements. Next ID: 5", -"id": "SuggestSuggestRequestRequestDataClientThumbnailDimensions", +"SuggestResponse": { +"description": "Response of the suggest API.", +"id": "SuggestResponse", "properties": { -"devicePixelRatio": { -"format": "double", -"type": "number" -}, -"iconSizeInDp": { -"format": "double", -"type": "number" -}, -"targetThumbnailHeight": { -"format": "uint32", -"type": "integer" +"suggestResults": { +"description": "List of suggestions.", +"items": { +"$ref": "SuggestResult" }, -"targetThumbnailWidth": { -"description": "Currently only used for YouTube Visual Suggest (go/ytandroid-visual-suggest).", -"format": "uint32", -"type": "integer" +"type": "array" } }, "type": "object" }, -"SuggestSuggestRequestRequestDataRuntimeData": { -"description": "Next ID: 2 TODO(b/237694378) Move this to ProcessedRequestContext.", -"id": "SuggestSuggestRequestRequestDataRuntimeData", +"SuggestResult": { +"description": "One suggestion result.", +"id": "SuggestResult", "properties": { -"sanitizedRequestLanguage": { -"type": "string" -} +"peopleSuggestion": { +"$ref": "PeopleSuggestion", +"description": "This is present when the suggestion indicates a person. It contains more information about the person - like their email ID, name etc." }, -"type": "object" +"querySuggestion": { +"$ref": "QuerySuggestion", +"description": "This field will be present if the suggested query is a word/phrase completion." }, -"SuggestSuggestRequestRequestDataUserPreferences": { -"id": "SuggestSuggestRequestRequestDataUserPreferences", -"properties": { -"isTrendsDisabled": { -"type": "boolean" +"source": { +"$ref": "Source", +"description": "The source of the suggestion." +}, +"suggestedQuery": { +"description": "The suggested query that will be used for search, when the user clicks on the suggestion", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudshell.v1.json b/googleapiclient/discovery_cache/documents/cloudshell.v1.json index 194185abb5d..513f8b46d56 100644 --- a/googleapiclient/discovery_cache/documents/cloudshell.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudshell.v1.json @@ -374,7 +374,7 @@ } } }, -"revision": "20240712", +"revision": "20240708", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AddPublicKeyMetadata": { diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index ce6b069d576..559fa738dcd 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -552,7 +552,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index 07663bb8a71..883883f8860 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -619,7 +619,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json index fa260897286..3785758992b 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -966,7 +966,7 @@ } } }, -"revision": "20240708", +"revision": "20240703", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index f491eb2a86f..c8099d587d7 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -994,7 +994,7 @@ } } }, -"revision": "20240708", +"revision": "20240703", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 2c7211ea865..e4b15b7d295 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -14084,210 +14084,6 @@ } } }, -"instantSnapshotGroups": { -"methods": { -"delete": { -"description": "deletes a Zonal InstantSnapshotGroup resource", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", -"httpMethod": "DELETE", -"id": "compute.instantSnapshotGroups.delete", -"parameterOrder": [ -"project", -"zone", -"instantSnapshotGroup" -], -"parameters": { -"instantSnapshotGroup": { -"description": "Name of the InstantSnapshot resource to delete.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"zone": { -"description": "The name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"get": { -"description": "returns the specified InstantSnapshotGroup resource in the specified zone.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", -"httpMethod": "GET", -"id": "compute.instantSnapshotGroups.get", -"parameterOrder": [ -"project", -"zone", -"instantSnapshotGroup" -], -"parameters": { -"instantSnapshotGroup": { -"description": "Name of the instantSnapshotGroup resource to return.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"zone": { -"description": "The name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", -"response": { -"$ref": "InstantSnapshotGroup" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"insert": { -"description": "inserts a Zonal InstantSnapshotGroup resource", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", -"httpMethod": "POST", -"id": "compute.instantSnapshotGroups.insert", -"parameterOrder": [ -"project", -"zone" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"sourceConsistencyGroup": { -"description": "begin_interface: MixerMutationRequestBuilder", -"location": "query", -"type": "string" -}, -"zone": { -"description": "Name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/instantSnapshotGroups", -"request": { -"$ref": "InstantSnapshotGroup" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"list": { -"description": "retrieves the list of InstantSnapshotGroup resources contained within the specified zone.", -"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", -"httpMethod": "GET", -"id": "compute.instantSnapshotGroups.list", -"parameterOrder": [ -"project", -"zone" -], -"parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", -"type": "string" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", -"location": "query", -"type": "boolean" -}, -"zone": { -"description": "The name of the zone for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/zones/{zone}/instantSnapshotGroups", -"response": { -"$ref": "ListInstantSnapshotGroups" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -} -} -}, "instantSnapshots": { "methods": { "aggregatedList": { @@ -26508,106 +26304,6 @@ } } }, -"regionInstanceGroupManagerResizeRequests": { -"methods": { -"get": { -"description": "Returns all of the details about the specified resize request.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", -"httpMethod": "GET", -"id": "compute.regionInstanceGroupManagerResizeRequests.get", -"parameterOrder": [ -"project", -"region", -"instanceGroupManager", -"resizeRequest" -], -"parameters": { -"instanceGroupManager": { -"description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", -"location": "path", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "The name of the region scoping this request. Name should conform to RFC1035.", -"location": "path", -"required": true, -"type": "string" -}, -"resizeRequest": { -"description": "The name of the resize request. Name should conform to RFC1035 or be a resource ID.", -"location": "path", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", -"response": { -"$ref": "InstanceGroupManagerResizeRequest" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"insert": { -"description": "Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.", -"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", -"httpMethod": "POST", -"id": "compute.regionInstanceGroupManagerResizeRequests.insert", -"parameterOrder": [ -"project", -"region", -"instanceGroupManager" -], -"parameters": { -"instanceGroupManager": { -"description": "Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID.", -"location": "path", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "Name of the region scoping this request. Name should conform to RFC1035.", -"location": "path", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", -"request": { -"$ref": "InstanceGroupManagerResizeRequest" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -} -} -}, "regionInstanceGroupManagers": { "methods": { "abandonInstances": { @@ -28511,210 +28207,6 @@ } } }, -"regionInstantSnapshotGroups": { -"methods": { -"delete": { -"description": "deletes a Regional InstantSnapshotGroup resource", -"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", -"httpMethod": "DELETE", -"id": "compute.regionInstantSnapshotGroups.delete", -"parameterOrder": [ -"project", -"region", -"instantSnapshotGroup" -], -"parameters": { -"instantSnapshotGroup": { -"description": "Name of the InstantSnapshotGroup resource to delete.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "The name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"get": { -"description": "returns the specified InstantSnapshotGroup resource in the specified region.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshot}", -"httpMethod": "GET", -"id": "compute.regionInstantSnapshotGroups.get", -"parameterOrder": [ -"project", -"region", -"instantSnapshot" -], -"parameters": { -"instantSnapshot": { -"description": "Name of the InstantSnapshotGroup resource to return.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "The name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshot}", -"response": { -"$ref": "InstantSnapshotGroup" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, -"insert": { -"description": "creates a Regional InstantSnapshotGroup resource", -"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", -"httpMethod": "POST", -"id": "compute.regionInstantSnapshotGroups.insert", -"parameterOrder": [ -"project", -"region" -], -"parameters": { -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "Name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -}, -"sourceConsistencyGroup": { -"description": "begin_interface: MixerMutationRequestBuilder", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/regions/{region}/instantSnapshotGroups", -"request": { -"$ref": "InstantSnapshotGroup" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, -"list": { -"description": "retrieves the list of InstantSnapshotGroup resources contained within the specified region.", -"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", -"httpMethod": "GET", -"id": "compute.regionInstantSnapshotGroups.list", -"parameterOrder": [ -"project", -"region" -], -"parameters": { -"filter": { -"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", -"location": "query", -"type": "string" -}, -"maxResults": { -"default": "500", -"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", -"format": "uint32", -"location": "query", -"minimum": "0", -"type": "integer" -}, -"orderBy": { -"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", -"location": "query", -"type": "string" -}, -"pageToken": { -"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", -"location": "query", -"type": "string" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"region": { -"description": "The name of the region for this request.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"required": true, -"type": "string" -}, -"returnPartialSuccess": { -"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", -"location": "query", -"type": "boolean" -} -}, -"path": "projects/{project}/regions/{region}/instantSnapshotGroups", -"response": { -"$ref": "ListInstantSnapshotGroups" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -} -} -}, "regionInstantSnapshots": { "methods": { "delete": { @@ -34072,7 +33564,7 @@ "regions": { "methods": { "get": { -"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", +"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -45223,7 +44715,7 @@ } } }, -"revision": "20240707", +"revision": "20240618", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -46647,14 +46139,6 @@ false "sourceInstanceTemplateId": { "description": "ID of the instance template used to populate reservation properties.", "type": "string" -}, -"utilizations": { -"additionalProperties": { -"format": "int64", -"type": "string" -}, -"description": "Per service utilization breakdown. The Key is the Google Cloud managed service name.", -"type": "object" } }, "type": "object" @@ -47995,13 +47479,11 @@ false "description": "Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.", "enum": [ "CONNECTION", -"CUSTOM_METRICS", "RATE", "UTILIZATION" ], "enumDescriptions": [ "Balance based on the number of simultaneous connections.", -"Based on custom defined and reported metrics.", "Balance based on requests per second (RPS).", "Balance based on the backend utilization." ], @@ -48012,13 +47494,6 @@ false "format": "float", "type": "number" }, -"customMetrics": { -"description": "List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy.", -"items": { -"$ref": "BackendCustomMetric" -}, -"type": "array" -}, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -48448,26 +47923,6 @@ false }, "type": "object" }, -"BackendCustomMetric": { -"description": "Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy.", -"id": "BackendCustomMetric", -"properties": { -"dryRun": { -"description": "If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.", -"type": "boolean" -}, -"maxUtilization": { -"description": "Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].", -"format": "float", -"type": "number" -}, -"name": { -"description": "Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", -"type": "string" -} -}, -"type": "object" -}, "BackendService": { "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices) For more information, see Backend Services.", "id": "BackendService", @@ -48650,8 +48105,7 @@ false "RANDOM", "RING_HASH", "ROUND_ROBIN", -"WEIGHTED_MAGLEV", -"WEIGHTED_ROUND_ROBIN" +"WEIGHTED_MAGLEV" ], "enumDescriptions": [ "", @@ -48661,8 +48115,7 @@ false "The load balancer selects a random healthy host.", "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.", "This is a simple policy in which each healthy backend is selected in round robin order. This is the default.", -"Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.", -"Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields." +"Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing." ], "type": "string" }, @@ -48804,7 +48257,6 @@ false "type": "integer" }, "usedBy": { -"description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -49639,8 +49091,7 @@ false "RANDOM", "RING_HASH", "ROUND_ROBIN", -"WEIGHTED_MAGLEV", -"WEIGHTED_ROUND_ROBIN" +"WEIGHTED_MAGLEV" ], "enumDescriptions": [ "", @@ -49650,8 +49101,7 @@ false "The load balancer selects a random healthy host.", "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.", "This is a simple policy in which each healthy backend is selected in round robin order. This is the default.", -"Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.", -"Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields." +"Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing." ], "type": "string" } @@ -49762,7 +49212,6 @@ false "id": "BackendServiceUsedBy", "properties": { "reference": { -"description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -50609,10 +50058,6 @@ false "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, -"customEndTimestamp": { -"description": "[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.", -"type": "string" -}, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -51103,10 +50548,6 @@ false "cancellationInformation": { "$ref": "CommitmentResourceStatusCancellationInformation", "description": "[Output Only] An optional, contains all the needed information of cancellation." -}, -"customTermEligibilityEndTimestamp": { -"description": "[Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.", -"type": "string" } }, "type": "object" @@ -60165,7 +59606,8 @@ false "type": "array" }, "baseInstanceName": { -"description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", +"description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", +"pattern": "[a-z][-a-z0-9]{0,57}", "type": "string" }, "creationTimestamp": { @@ -60265,10 +59707,6 @@ false "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).", "type": "string" }, -"resourcePolicies": { -"$ref": "InstanceGroupManagerResourcePolicies", -"description": "Resource policies for this managed instance group." -}, "satisfiesPzi": { "description": "[Output Only] Reserved for future use.", "type": "boolean" @@ -61311,16 +60749,6 @@ false }, "type": "object" }, -"InstanceGroupManagerResourcePolicies": { -"id": "InstanceGroupManagerResourcePolicies", -"properties": { -"workloadPolicy": { -"description": "The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", -"type": "string" -} -}, -"type": "object" -}, "InstanceGroupManagerStandbyPolicy": { "id": "InstanceGroupManagerStandbyPolicy", "properties": { @@ -64369,101 +63797,6 @@ false }, "type": "object" }, -"InstantSnapshotGroup": { -"id": "InstantSnapshotGroup", -"properties": { -"creationTimestamp": { -"description": "[Output Only] Creation timestamp in RFC3339 text format.", -"type": "string" -}, -"description": { -"description": "Optional. An optional description of this resource. Provide this property when you create the resource.", -"type": "string" -}, -"id": { -"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", -"format": "uint64", -"type": "string" -}, -"kind": { -"default": "compute#instantSnapshotGroup", -"description": "[Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.", -"type": "string" -}, -"name": { -"description": "Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", -"type": "string" -}, -"region": { -"description": "[Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", -"type": "string" -}, -"resourceStatus": { -"$ref": "InstantSnapshotGroupResourceStatus" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for the resource.", -"type": "string" -}, -"selfLinkWithId": { -"description": "[Output Only] Server-defined URL for this resource's resource id.", -"type": "string" -}, -"status": { -"description": "[Output Only]", -"enum": [ -"CREATING", -"DELETING", -"FAILED", -"INVALID", -"READY", -"UNKNOWN" -], -"enumDescriptions": [ -"", -"", -"", -"", -"", -"" -], -"type": "string" -}, -"zone": { -"description": "[Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", -"type": "string" -} -}, -"type": "object" -}, -"InstantSnapshotGroupResourceStatus": { -"id": "InstantSnapshotGroupResourceStatus", -"properties": { -"consistencyMembershipResolutionTime": { -"description": "[Output Only]", -"format": "google-datetime", -"type": "string" -}, -"sourceInfo": { -"$ref": "InstantSnapshotGroupSourceInfo", -"description": "[Output Only]" -} -}, -"type": "object" -}, -"InstantSnapshotGroupSourceInfo": { -"id": "InstantSnapshotGroupSourceInfo", -"properties": { -"consistencyGroup": { -"type": "string" -}, -"consistencyGroupId": { -"type": "string" -} -}, -"type": "object" -}, "InstantSnapshotList": { "description": "Contains a list of InstantSnapshot resources.", "id": "InstantSnapshotList", @@ -64999,9 +64332,6 @@ false "bandwidthPercentagePolicy": { "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" }, -"egressMinBandwidthPercentagePolicy": { -"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" -}, "profileDescription": { "description": "A description for the AAI profile on this interconnect.", "type": "string" @@ -67796,168 +67126,6 @@ false }, "type": "object" }, -"ListInstantSnapshotGroups": { -"description": "Contains a list of InstantSnapshotGroup resources.", -"id": "ListInstantSnapshotGroups", -"properties": { -"etag": { -"type": "string" -}, -"id": { -"description": "[Output Only] Unique identifier for the resource; defined by the server.", -"type": "string" -}, -"items": { -"description": "A list of InstantSnapshotGroup resources.", -"items": { -"$ref": "InstantSnapshotGroup" -}, -"type": "array" -}, -"kind": { -"default": "compute#instantSnapshotGroupsList", -"description": "Type of resource.", -"type": "string" -}, -"nextPageToken": { -"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", -"type": "string" -}, -"selfLink": { -"description": "[Output Only] Server-defined URL for this resource.", -"type": "string" -}, -"unreachables": { -"description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", -"items": { -"type": "string" -}, -"type": "array" -}, -"warning": { -"description": "[Output Only] Informational warning message.", -"properties": { -"code": { -"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", -"enum": [ -"CLEANUP_FAILED", -"DEPRECATED_RESOURCE_USED", -"DEPRECATED_TYPE_USED", -"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", -"EXPERIMENTAL_TYPE_USED", -"EXTERNAL_API_WARNING", -"FIELD_VALUE_OVERRIDEN", -"INJECTED_KERNELS_DEPRECATED", -"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", -"LARGE_DEPLOYMENT_WARNING", -"LIST_OVERHEAD_QUOTA_EXCEED", -"MISSING_TYPE_DEPENDENCY", -"NEXT_HOP_ADDRESS_NOT_ASSIGNED", -"NEXT_HOP_CANNOT_IP_FORWARD", -"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", -"NEXT_HOP_INSTANCE_NOT_FOUND", -"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", -"NEXT_HOP_NOT_RUNNING", -"NOT_CRITICAL_ERROR", -"NO_RESULTS_ON_PAGE", -"PARTIAL_SUCCESS", -"REQUIRED_TOS_AGREEMENT", -"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", -"RESOURCE_NOT_DELETED", -"SCHEMA_VALIDATION_IGNORED", -"SINGLE_INSTANCE_PROPERTY_TEMPLATE", -"UNDECLARED_PROPERTIES", -"UNREACHABLE" -], -"enumDeprecated": [ -false, -false, -false, -false, -false, -false, -true, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false, -false -], -"enumDescriptions": [ -"Warning about failed cleanup of transient changes made by a failed operation.", -"A link to a deprecated resource was created.", -"When deploying and at least one of the resources has a type marked as deprecated", -"The user created a boot disk that is larger than image size.", -"When deploying and at least one of the resources has a type marked as experimental", -"Warning that is present in an external api call", -"Warning that value of a field has been overridden. Deprecated unused field.", -"The operation involved use of an injected kernel, which is deprecated.", -"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", -"When deploying a deployment with a exceedingly large number of resources", -"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", -"A resource depends on a missing type", -"The route's nextHopIp address is not assigned to an instance on the network.", -"The route's next hop instance cannot ip forward.", -"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", -"The route's nextHopInstance URL refers to an instance that does not exist.", -"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", -"The route's next hop instance does not have a status of RUNNING.", -"Error which is not critical. We decided to continue the process despite the mentioned error.", -"No results are present on a particular list page.", -"Success is reported, but some results may be missing due to errors", -"The user attempted to use a resource that requires a TOS they have not accepted.", -"Warning that a resource is in use.", -"One or more of the resources set to auto-delete could not be deleted because they were in use.", -"When a resource schema validation is ignored.", -"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", -"When undeclared properties in the schema are present", -"A given scope cannot be reached." -], -"type": "string" -}, -"data": { -"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", -"items": { -"properties": { -"key": { -"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", -"type": "string" -}, -"value": { -"description": "[Output Only] A warning data value corresponding to the key.", -"type": "string" -} -}, -"type": "object" -}, -"type": "array" -}, -"message": { -"description": "[Output Only] A human-readable description of the warning code.", -"type": "string" -} -}, -"type": "object" -} -}, -"type": "object" -}, "LocalDisk": { "id": "LocalDisk", "properties": { @@ -69476,9 +68644,6 @@ false "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" -}, -"status": { -"$ref": "MultiMigStatus" } }, "type": "object" @@ -69531,18 +68696,6 @@ false }, "type": "object" }, -"MultiMigStatus": { -"id": "MultiMigStatus", -"properties": { -"memberInstanceGroupManagers": { -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "MultiMigsList": { "id": "MultiMigsList", "properties": { @@ -70908,6 +70061,12 @@ false "format": "int32", "type": "integer" }, +"clientPort": { +"deprecated": true, +"description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode.", +"format": "int32", +"type": "integer" +}, "fqdn": { "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", "type": "string" @@ -70951,6 +70110,19 @@ false "$ref": "NetworkEndpointGroupAppEngine", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, +"clientPortMappingMode": { +"deprecated": true, +"description": "Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional.", +"enum": [ +"CLIENT_PORT_PER_ENDPOINT", +"PORT_MAPPING_DISABLED" +], +"enumDescriptions": [ +"For each endpoint there is exactly one client port.", +"NEG should not be used for mapping client port to destination." +], +"type": "string" +}, "cloudFunction": { "$ref": "NetworkEndpointGroupCloudFunction", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." @@ -82945,9 +82117,6 @@ false "vmMaintenancePolicy": { "$ref": "ResourcePolicyVmMaintenancePolicy", "description": "Resource policy applicable to VMs for infrastructure maintenance." -}, -"workloadPolicy": { -"$ref": "ResourcePolicyWorkloadPolicy" } }, "type": "object" @@ -83627,24 +82796,6 @@ false }, "type": "object" }, -"ResourcePolicyWorkloadPolicy": { -"description": "Represents the workload policy.", -"id": "ResourcePolicyWorkloadPolicy", -"properties": { -"type": { -"enum": [ -"HIGH_AVAILABILITY", -"HIGH_THROUGHPUT" -], -"enumDescriptions": [ -"VMs will be provisioned in such a way which provides high availability.", -"VMs will be provisioned in such a way which provides high throughput." -], -"type": "string" -} -}, -"type": "object" -}, "ResourceStatus": { "description": "Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.", "id": "ResourceStatus", @@ -83723,7 +82874,7 @@ false "id": "ResourceStatusScheduling", "properties": { "availabilityDomain": { -"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", +"description": "Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.", "format": "int32", "type": "integer" }, @@ -86703,7 +85854,7 @@ false "type": "boolean" }, "availabilityDomain": { -"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", +"description": "Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.", "format": "int32", "type": "integer" }, @@ -99749,7 +98900,7 @@ false "type": "string" }, "stackType": { -"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", +"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 77345d6b9a2..2ea6da97f9c 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -3669,40 +3669,6 @@ "https://www.googleapis.com/auth/compute" ] }, -"addPacketMirroringRule": { -"description": "Inserts a packet mirroring rule into a firewall policy.", -"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", -"httpMethod": "POST", -"id": "compute.firewallPolicies.addPacketMirroringRule", -"parameterOrder": [ -"firewallPolicy" -], -"parameters": { -"firewallPolicy": { -"description": "Name of the firewall policy to update.", -"location": "path", -"pattern": "(firewallPolicies/)?[0-9]{0,20}", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", -"request": { -"$ref": "FirewallPolicyRule" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "addRule": { "description": "Inserts a rule into a firewall policy.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addRule", @@ -3896,39 +3862,6 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"getPacketMirroringRule": { -"description": "Gets a packet mirroring rule of the specified priority.", -"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", -"httpMethod": "GET", -"id": "compute.firewallPolicies.getPacketMirroringRule", -"parameterOrder": [ -"firewallPolicy" -], -"parameters": { -"firewallPolicy": { -"description": "Name of the firewall policy to which the queried rule belongs.", -"location": "path", -"pattern": "(firewallPolicies/)?[0-9]{0,20}", -"required": true, -"type": "string" -}, -"priority": { -"description": "The priority of the rule to get from the firewall policy.", -"format": "int32", -"location": "query", -"type": "integer" -} -}, -"path": "locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", -"response": { -"$ref": "FirewallPolicyRule" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, "getRule": { "description": "Gets a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getRule", @@ -4133,46 +4066,6 @@ "https://www.googleapis.com/auth/compute" ] }, -"patchPacketMirroringRule": { -"description": "Patches a packet mirroring rule of the specified priority.", -"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", -"httpMethod": "POST", -"id": "compute.firewallPolicies.patchPacketMirroringRule", -"parameterOrder": [ -"firewallPolicy" -], -"parameters": { -"firewallPolicy": { -"description": "Name of the firewall policy to update.", -"location": "path", -"pattern": "(firewallPolicies/)?[0-9]{0,20}", -"required": true, -"type": "string" -}, -"priority": { -"description": "The priority of the rule to patch.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", -"request": { -"$ref": "FirewallPolicyRule" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "patchRule": { "description": "Patches a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchRule", @@ -4249,43 +4142,6 @@ "https://www.googleapis.com/auth/compute" ] }, -"removePacketMirroringRule": { -"description": "Deletes a packet mirroring rule of the specified priority.", -"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", -"httpMethod": "POST", -"id": "compute.firewallPolicies.removePacketMirroringRule", -"parameterOrder": [ -"firewallPolicy" -], -"parameters": { -"firewallPolicy": { -"description": "Name of the firewall policy to update.", -"location": "path", -"pattern": "(firewallPolicies/)?[0-9]{0,20}", -"required": true, -"type": "string" -}, -"priority": { -"description": "The priority of the rule to remove from the firewall policy.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "removeRule": { "description": "Deletes a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeRule", @@ -17328,60 +17184,6 @@ "https://www.googleapis.com/auth/compute" ] }, -"addPacketMirroringRule": { -"description": "Inserts a packet mirroring rule into a firewall policy.", -"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", -"httpMethod": "POST", -"id": "compute.networkFirewallPolicies.addPacketMirroringRule", -"parameterOrder": [ -"project", -"firewallPolicy" -], -"parameters": { -"firewallPolicy": { -"description": "Name of the firewall policy to update.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"maxPriority": { -"description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"minPriority": { -"description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", -"request": { -"$ref": "FirewallPolicyRule" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "addRule": { "description": "Inserts a rule into a firewall policy.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule", @@ -17635,47 +17437,6 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, -"getPacketMirroringRule": { -"description": "Gets a packet mirroring rule of the specified priority.", -"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", -"httpMethod": "GET", -"id": "compute.networkFirewallPolicies.getPacketMirroringRule", -"parameterOrder": [ -"project", -"firewallPolicy" -], -"parameters": { -"firewallPolicy": { -"description": "Name of the firewall policy to which the queried rule belongs.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"priority": { -"description": "The priority of the rule to get from the firewall policy.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -} -}, -"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", -"response": { -"$ref": "FirewallPolicyRule" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" -] -}, "getRule": { "description": "Gets a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule", @@ -17848,54 +17609,6 @@ "https://www.googleapis.com/auth/compute" ] }, -"patchPacketMirroringRule": { -"description": "Patches a packet mirroring rule of the specified priority.", -"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", -"httpMethod": "POST", -"id": "compute.networkFirewallPolicies.patchPacketMirroringRule", -"parameterOrder": [ -"project", -"firewallPolicy" -], -"parameters": { -"firewallPolicy": { -"description": "Name of the firewall policy to update.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"priority": { -"description": "The priority of the rule to patch.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", -"request": { -"$ref": "FirewallPolicyRule" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "patchRule": { "description": "Patches a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", @@ -17988,51 +17701,6 @@ "https://www.googleapis.com/auth/compute" ] }, -"removePacketMirroringRule": { -"description": "Deletes a packet mirroring rule of the specified priority.", -"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", -"httpMethod": "POST", -"id": "compute.networkFirewallPolicies.removePacketMirroringRule", -"parameterOrder": [ -"project", -"firewallPolicy" -], -"parameters": { -"firewallPolicy": { -"description": "Name of the firewall policy to update.", -"location": "path", -"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", -"required": true, -"type": "string" -}, -"priority": { -"description": "The priority of the rule to remove from the firewall policy.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"project": { -"description": "Project ID for this request.", -"location": "path", -"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", -"required": true, -"type": "string" -}, -"requestId": { -"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", -"location": "query", -"type": "string" -} -}, -"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute" -] -}, "removeRule": { "description": "Deletes a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule", @@ -31516,7 +31184,7 @@ "regions": { "methods": { "get": { -"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", +"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -41911,7 +41579,7 @@ } } }, -"revision": "20240702", +"revision": "20240618", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -45236,8 +44904,7 @@ false "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", -"NONE", -"STRONG_COOKIE_AFFINITY" +"NONE" ], "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", @@ -45247,15 +44914,10 @@ false "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.", "The hash is based on a user specified header field.", "The hash is based on a user provided cookie.", -"No session affinity. Connections from the same client IP may go to any instance in the pool.", -"Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." +"No session affinity. Connections from the same client IP may go to any instance in the pool." ], "type": "string" }, -"strongSessionAffinityCookie": { -"$ref": "BackendServiceHttpCookie", -"description": "Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY." -}, "subsetting": { "$ref": "Subsetting" }, @@ -45265,7 +44927,6 @@ false "type": "integer" }, "usedBy": { -"description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -45632,25 +45293,6 @@ false }, "type": "object" }, -"BackendServiceHttpCookie": { -"description": "The HTTP cookie used for stateful session affinity.", -"id": "BackendServiceHttpCookie", -"properties": { -"name": { -"description": "Name of the cookie.", -"type": "string" -}, -"path": { -"description": "Path to set for the cookie.", -"type": "string" -}, -"ttl": { -"$ref": "Duration", -"description": "Lifetime of the cookie." -} -}, -"type": "object" -}, "BackendServiceIAP": { "description": "Identity-Aware Proxy", "id": "BackendServiceIAP", @@ -46087,7 +45729,6 @@ false "id": "BackendServiceUsedBy", "properties": { "reference": { -"description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -46945,7 +46586,6 @@ false "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", "GENERAL_PURPOSE", -"GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", @@ -46976,7 +46616,6 @@ false "", "", "", -"", "" ], "type": "string" @@ -50209,13 +49848,6 @@ false "description": "Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.", "type": "string" }, -"packetMirroringRules": { -"description": "A list of packet mirroring rules that belong to this policy.", -"items": { -"$ref": "FirewallPolicyRule" -}, -"type": "array" -}, "parent": { "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.", "type": "string" @@ -55698,7 +55330,8 @@ false "type": "array" }, "baseInstanceName": { -"description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", +"description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", +"pattern": "[a-z][-a-z0-9]{0,57}", "type": "string" }, "creationTimestamp": { @@ -59123,11 +58756,6 @@ false "description": "[Output Only] The name of the firewall policy.", "type": "string" }, -"priority": { -"description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", -"format": "int32", -"type": "integer" -}, "rules": { "description": "The rules that apply to the network.", "items": { @@ -59145,16 +58773,12 @@ false "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", -"SYSTEM_GLOBAL", -"SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ "", "", "", -"", -"", "" ], "type": "string" @@ -65035,6 +64659,12 @@ false "format": "int32", "type": "integer" }, +"clientPort": { +"deprecated": true, +"description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode.", +"format": "int32", +"type": "integer" +}, "fqdn": { "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", "type": "string" @@ -65074,6 +64704,19 @@ false "$ref": "NetworkEndpointGroupAppEngine", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, +"clientPortMappingMode": { +"deprecated": true, +"description": "Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional.", +"enum": [ +"CLIENT_PORT_PER_ENDPOINT", +"PORT_MAPPING_DISABLED" +], +"enumDescriptions": [ +"For each endpoint there is exactly one client port.", +"NEG should not be used for mapping client port to destination." +], +"type": "string" +}, "cloudFunction": { "$ref": "NetworkEndpointGroupCloudFunction", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." @@ -73791,11 +73434,6 @@ false "description": "[Output Only] The name of the firewall policy.", "type": "string" }, -"priority": { -"description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", -"format": "int32", -"type": "integer" -}, "rules": { "description": "The rules that apply to the network.", "items": { @@ -73809,16 +73447,12 @@ false "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", -"SYSTEM_GLOBAL", -"SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ "", "", "", -"", -"", "" ], "type": "string" @@ -75386,11 +75020,6 @@ false "ResourceStatusScheduling": { "id": "ResourceStatusScheduling", "properties": { -"availabilityDomain": { -"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", -"format": "int32", -"type": "integer" -}, "terminationTimestamp": { "description": "Time in future when the instance will be terminated in RFC3339 text format.", "type": "string" @@ -78017,11 +77646,6 @@ false "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", "type": "boolean" }, -"availabilityDomain": { -"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", -"format": "int32", -"type": "integer" -}, "hostErrorTimeoutSeconds": { "description": "Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.", "format": "int32", @@ -86740,8 +86364,7 @@ false "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", -"NONE", -"STRONG_COOKIE_AFFINITY" +"NONE" ], "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", @@ -86751,8 +86374,7 @@ false "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.", "The hash is based on a user specified header field.", "The hash is based on a user provided cookie.", -"No session affinity. Connections from the same client IP may go to any instance in the pool.", -"Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." +"No session affinity. Connections from the same client IP may go to any instance in the pool." ], "type": "string" } @@ -90029,7 +89651,7 @@ false "type": "string" }, "stackType": { -"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", +"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index cb70f3014c7..efb1177a57c 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -27980,7 +27980,7 @@ "regions": { "methods": { "get": { -"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", +"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -37421,7 +37421,7 @@ } } }, -"revision": "20240702", +"revision": "20240618", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -40687,7 +40687,6 @@ false "type": "integer" }, "usedBy": { -"description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -41490,7 +41489,6 @@ false "id": "BackendServiceUsedBy", "properties": { "reference": { -"description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -42244,7 +42242,6 @@ false "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", "GENERAL_PURPOSE", -"GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", @@ -42275,7 +42272,6 @@ false "", "", "", -"", "" ], "type": "string" @@ -50043,7 +50039,8 @@ false "type": "array" }, "baseInstanceName": { -"description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", +"description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", +"pattern": "[a-z][-a-z0-9]{0,57}", "type": "string" }, "creationTimestamp": { @@ -71225,11 +71222,6 @@ false "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", "type": "boolean" }, -"availabilityDomain": { -"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", -"format": "int32", -"type": "integer" -}, "instanceTerminationAction": { "description": "Specifies the termination action for the instance.", "enum": [ @@ -82692,7 +82684,7 @@ false "type": "string" }, "stackType": { -"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", +"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index 004d1971fc3..2838e46435a 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -1187,7 +1187,7 @@ } } }, -"revision": "20240708", +"revision": "20240626", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index bb83e86d4b9..97550fa8fb3 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2427,7 +2427,7 @@ } } }, -"revision": "20240708", +"revision": "20240701", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -5892,7 +5892,7 @@ false "type": "array" }, "valueSeparator": { -"description": "Required. Value separator. Only \",\" can be used for OAuth auth code flow scope field.", +"description": "Required. Value separator.", "type": "string" } }, @@ -6536,10 +6536,6 @@ false ], "type": "string" }, -"defaultValue": { -"description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", -"type": "any" -}, "description": { "description": "A brief description of the field.", "type": "string" @@ -6551,10 +6547,6 @@ false "jsonSchema": { "$ref": "JsonSchema", "description": "JsonSchema representation of this action's result" -}, -"nullable": { -"description": "Specifies whether a null value is allowed.", -"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 621a267ecb0..217f519e688 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -660,7 +660,7 @@ } } }, -"revision": "20240708", +"revision": "20240701", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -2269,10 +2269,6 @@ false ], "type": "string" }, -"defaultValue": { -"description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", -"type": "any" -}, "description": { "description": "A brief description of the metadata field.", "type": "string" @@ -2284,10 +2280,6 @@ false "name": { "description": "Name of the metadata field.", "type": "string" -}, -"nullable": { -"description": "Specifies whether a null value is allowed.", -"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json index 80b52946b1b..a8c8ce4ec72 100644 --- a/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/contactcenteraiplatform.v1alpha1.json @@ -512,7 +512,7 @@ } } }, -"revision": "20240703", +"revision": "20240702", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index 96a9dc7d755..b4279a8319c 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -6219,7 +6219,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/css.v1.json b/googleapiclient/discovery_cache/documents/css.v1.json deleted file mode 100644 index 7b15254c4df..00000000000 --- a/googleapiclient/discovery_cache/documents/css.v1.json +++ /dev/null @@ -1,1216 +0,0 @@ -{ -"auth": { -"oauth2": { -"scopes": { -"https://www.googleapis.com/auth/content": { -"description": "Manage your product listings and accounts for Google Shopping" -} -} -} -}, -"basePath": "", -"baseUrl": "https://css.googleapis.com/", -"batchPath": "batch", -"canonicalName": "Css", -"description": "Programmatically manage your Comparison Shopping Service (CSS) account data at scale.", -"discoveryVersion": "v1", -"documentationLink": "https://developers.google.com/comparison-shopping-services/api/overview", -"fullyEncodeReservedExpansion": true, -"icons": { -"x16": "http://www.google.com/images/icons/product/search-16.gif", -"x32": "http://www.google.com/images/icons/product/search-32.gif" -}, -"id": "css:v1", -"kind": "discovery#restDescription", -"mtlsRootUrl": "https://css.mtls.googleapis.com/", -"name": "css", -"ownerDomain": "google.com", -"ownerName": "Google", -"parameters": { -"$.xgafv": { -"description": "V1 error format.", -"enum": [ -"1", -"2" -], -"enumDescriptions": [ -"v1 error format", -"v2 error format" -], -"location": "query", -"type": "string" -}, -"access_token": { -"description": "OAuth access token.", -"location": "query", -"type": "string" -}, -"alt": { -"default": "json", -"description": "Data format for response.", -"enum": [ -"json", -"media", -"proto" -], -"enumDescriptions": [ -"Responses with Content-Type of application/json", -"Media download with context-dependent Content-Type", -"Responses with Content-Type of application/x-protobuf" -], -"location": "query", -"type": "string" -}, -"callback": { -"description": "JSONP", -"location": "query", -"type": "string" -}, -"fields": { -"description": "Selector specifying which fields to include in a partial response.", -"location": "query", -"type": "string" -}, -"key": { -"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", -"location": "query", -"type": "string" -}, -"oauth_token": { -"description": "OAuth 2.0 token for the current user.", -"location": "query", -"type": "string" -}, -"prettyPrint": { -"default": "true", -"description": "Returns response with indentations and line breaks.", -"location": "query", -"type": "boolean" -}, -"quotaUser": { -"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", -"location": "query", -"type": "string" -}, -"uploadType": { -"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", -"location": "query", -"type": "string" -}, -"upload_protocol": { -"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", -"location": "query", -"type": "string" -} -}, -"protocol": "rest", -"resources": { -"accounts": { -"methods": { -"get": { -"description": "Retrieves a single CSS/MC account by ID.", -"flatPath": "v1/accounts/{accountsId}", -"httpMethod": "GET", -"id": "css.accounts.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the managed CSS/MC account. Format: accounts/{account}", -"location": "path", -"pattern": "^accounts/[^/]+$", -"required": true, -"type": "string" -}, -"parent": { -"description": "Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "Account" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"listChildAccounts": { -"description": "Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.", -"flatPath": "v1/accounts/{accountsId}:listChildAccounts", -"httpMethod": "GET", -"id": "css.accounts.listChildAccounts", -"parameterOrder": [ -"parent" -], -"parameters": { -"fullName": { -"description": "If set, only the MC accounts with the given name (case sensitive) will be returned.", -"location": "query", -"type": "string" -}, -"labelId": { -"description": "If set, only the MC accounts with the given label ID will be returned.", -"format": "int64", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent account. Must be a CSS group or domain. Format: accounts/{account}", -"location": "path", -"pattern": "^accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}:listChildAccounts", -"response": { -"$ref": "ListChildAccountsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"updateLabels": { -"description": "Updates labels assigned to CSS/MC accounts by a CSS domain.", -"flatPath": "v1/accounts/{accountsId}:updateLabels", -"httpMethod": "POST", -"id": "css.accounts.updateLabels", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The label resource name. Format: accounts/{account}", -"location": "path", -"pattern": "^accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:updateLabels", -"request": { -"$ref": "UpdateAccountLabelsRequest" -}, -"response": { -"$ref": "Account" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -} -}, -"resources": { -"cssProductInputs": { -"methods": { -"delete": { -"description": "Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.", -"flatPath": "v1/accounts/{accountsId}/cssProductInputs/{cssProductInputsId}", -"httpMethod": "DELETE", -"id": "css.accounts.cssProductInputs.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}", -"location": "path", -"pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$", -"required": true, -"type": "string" -}, -"supplementalFeedId": { -"description": "The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "Empty" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"insert": { -"description": "Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.", -"flatPath": "v1/accounts/{accountsId}/cssProductInputs:insert", -"httpMethod": "POST", -"id": "css.accounts.cssProductInputs.insert", -"parameterOrder": [ -"parent" -], -"parameters": { -"feedId": { -"description": "Required. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet.", -"format": "int64", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The account where this CSS Product will be inserted. Format: accounts/{account}", -"location": "path", -"pattern": "^accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/cssProductInputs:insert", -"request": { -"$ref": "CssProductInput" -}, -"response": { -"$ref": "CssProductInput" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -} -} -}, -"cssProducts": { -"methods": { -"get": { -"description": "Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.", -"flatPath": "v1/accounts/{accountsId}/cssProducts/{cssProductsId}", -"httpMethod": "GET", -"id": "css.accounts.cssProducts.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the CSS product to retrieve.", -"location": "path", -"pattern": "^accounts/[^/]+/cssProducts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "CssProduct" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"list": { -"description": "Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.", -"flatPath": "v1/accounts/{accountsId}/cssProducts", -"httpMethod": "GET", -"id": "css.accounts.cssProducts.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "A page token, received from a previous `ListCssProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCssProducts` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The account/domain to list processed CSS Products for. Format: accounts/{account}", -"location": "path", -"pattern": "^accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/cssProducts", -"response": { -"$ref": "ListCssProductsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -} -} -}, -"labels": { -"methods": { -"create": { -"description": "Creates a new label, not assigned to any account.", -"flatPath": "v1/accounts/{accountsId}/labels", -"httpMethod": "POST", -"id": "css.accounts.labels.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The parent account. Format: accounts/{account}", -"location": "path", -"pattern": "^accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/labels", -"request": { -"$ref": "AccountLabel" -}, -"response": { -"$ref": "AccountLabel" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"delete": { -"description": "Deletes a label and removes it from all accounts to which it was assigned.", -"flatPath": "v1/accounts/{accountsId}/labels/{labelsId}", -"httpMethod": "DELETE", -"id": "css.accounts.labels.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the label to delete. Format: accounts/{account}/labels/{label}", -"location": "path", -"pattern": "^accounts/[^/]+/labels/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "Empty" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"list": { -"description": "Lists the labels assigned to an account.", -"flatPath": "v1/accounts/{accountsId}/labels", -"httpMethod": "GET", -"id": "css.accounts.labels.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent account. Format: accounts/{account}", -"location": "path", -"pattern": "^accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/labels", -"response": { -"$ref": "ListAccountLabelsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"patch": { -"description": "Updates a label.", -"flatPath": "v1/accounts/{accountsId}/labels/{labelsId}", -"httpMethod": "PATCH", -"id": "css.accounts.labels.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The resource name of the label. Format: accounts/{account}/labels/{label}", -"location": "path", -"pattern": "^accounts/[^/]+/labels/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "AccountLabel" -}, -"response": { -"$ref": "AccountLabel" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -} -} -} -} -} -}, -"revision": "20240712", -"rootUrl": "https://css.googleapis.com/", -"schemas": { -"Account": { -"description": "Information about CSS/MC account.", -"id": "Account", -"properties": { -"accountType": { -"description": "Output only. The type of this account.", -"enum": [ -"ACCOUNT_TYPE_UNSPECIFIED", -"CSS_GROUP", -"CSS_DOMAIN", -"MC_PRIMARY_CSS_MCA", -"MC_CSS_MCA", -"MC_MARKETPLACE_MCA", -"MC_OTHER_MCA", -"MC_STANDALONE", -"MC_MCA_SUBACCOUNT" -], -"enumDescriptions": [ -"Unknown account type.", -"CSS group account.", -"CSS domain account.", -"MC Primary CSS MCA account.", -"MC CSS MCA account.", -"MC Marketplace MCA account.", -"MC Other MCA account.", -"MC Standalone account.", -"MC MCA sub-account." -], -"readOnly": true, -"type": "string" -}, -"automaticLabelIds": { -"description": "Automatically created label IDs assigned to the MC account by CSS Center.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -}, -"displayName": { -"description": "The CSS/MC account's short display name.", -"type": "string" -}, -"fullName": { -"description": "Output only. Immutable. The CSS/MC account's full name.", -"readOnly": true, -"type": "string" -}, -"homepageUri": { -"description": "Output only. Immutable. The CSS/MC account's homepage.", -"readOnly": true, -"type": "string" -}, -"labelIds": { -"description": "Manually created label IDs assigned to the CSS/MC account by a CSS parent account.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -}, -"name": { -"description": "The label resource name. Format: accounts/{account}", -"type": "string" -}, -"parent": { -"description": "The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.", -"type": "string" -} -}, -"type": "object" -}, -"AccountLabel": { -"description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.", -"id": "AccountLabel", -"properties": { -"accountId": { -"description": "Output only. The ID of account this label belongs to.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "The description of this label.", -"type": "string" -}, -"displayName": { -"description": "The display name of this label.", -"type": "string" -}, -"labelId": { -"description": "Output only. The ID of the label.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"labelType": { -"description": "Output only. The type of this label.", -"enum": [ -"LABEL_TYPE_UNSPECIFIED", -"MANUAL", -"AUTOMATIC" -], -"enumDescriptions": [ -"Unknown label type.", -"Indicates that the label was created manually.", -"Indicates that the label was created automatically by CSS Center." -], -"readOnly": true, -"type": "string" -}, -"name": { -"description": "The resource name of the label. Format: accounts/{account}/labels/{label}", -"type": "string" -} -}, -"type": "object" -}, -"Attributes": { -"description": "Attributes for CSS Product.", -"id": "Attributes", -"properties": { -"additionalImageLinks": { -"description": "Additional URL of images of the item.", -"items": { -"type": "string" -}, -"type": "array" -}, -"adult": { -"description": "Set to true if the item is targeted towards adults.", -"type": "boolean" -}, -"ageGroup": { -"description": "Target age group of the item.", -"type": "string" -}, -"brand": { -"description": "Product Related Attributes.[14-36] Brand of the item.", -"type": "string" -}, -"certifications": { -"description": "A list of certificates claimed by the CSS for the given product.", -"items": { -"$ref": "Certification" -}, -"type": "array" -}, -"color": { -"description": "Color of the item.", -"type": "string" -}, -"cppAdsRedirect": { -"description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads.", -"type": "string" -}, -"cppLink": { -"description": "URL directly linking to your the Product Detail Page of the CSS.", -"type": "string" -}, -"cppMobileLink": { -"description": "URL for the mobile-optimized version of the Product Detail Page of the CSS.", -"type": "string" -}, -"customLabel0": { -"description": "Custom label 0 for custom grouping of items in a Shopping campaign.", -"type": "string" -}, -"customLabel1": { -"description": "Custom label 1 for custom grouping of items in a Shopping campaign.", -"type": "string" -}, -"customLabel2": { -"description": "Custom label 2 for custom grouping of items in a Shopping campaign.", -"type": "string" -}, -"customLabel3": { -"description": "Custom label 3 for custom grouping of items in a Shopping campaign.", -"type": "string" -}, -"customLabel4": { -"description": "Custom label 4 for custom grouping of items in a Shopping campaign.", -"type": "string" -}, -"description": { -"description": "Description of the item.", -"type": "string" -}, -"excludedDestinations": { -"description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).", -"items": { -"type": "string" -}, -"type": "array" -}, -"expirationDate": { -"description": "Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.", -"format": "google-datetime", -"type": "string" -}, -"gender": { -"description": "Target gender of the item.", -"type": "string" -}, -"googleProductCategory": { -"description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.", -"type": "string" -}, -"gtin": { -"description": "Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.", -"type": "string" -}, -"headlineOfferCondition": { -"description": "Condition of the headline offer.", -"type": "string" -}, -"headlineOfferLink": { -"description": "Link to the headline offer.", -"type": "string" -}, -"headlineOfferMobileLink": { -"description": "Mobile Link to the headline offer.", -"type": "string" -}, -"headlineOfferPrice": { -"$ref": "Price", -"description": "Headline Price of the aggregate offer." -}, -"headlineOfferShippingPrice": { -"$ref": "Price", -"description": "Headline Price of the aggregate offer." -}, -"highPrice": { -"$ref": "Price", -"description": "High Price of the aggregate offer." -}, -"imageLink": { -"description": "URL of an image of the item.", -"type": "string" -}, -"includedDestinations": { -"description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.", -"items": { -"type": "string" -}, -"type": "array" -}, -"isBundle": { -"description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.", -"type": "boolean" -}, -"itemGroupId": { -"description": "Shared identifier for all variants of the same product.", -"type": "string" -}, -"lowPrice": { -"$ref": "Price", -"description": "Low Price of the aggregate offer." -}, -"material": { -"description": "The material of which the item is made.", -"type": "string" -}, -"mpn": { -"description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.", -"type": "string" -}, -"multipack": { -"description": "The number of identical products in a merchant-defined multipack.", -"format": "int64", -"type": "string" -}, -"numberOfOffers": { -"description": "The number of aggregate offers.", -"format": "int64", -"type": "string" -}, -"pattern": { -"description": "The item's pattern (e.g. polka dots).", -"type": "string" -}, -"pause": { -"description": "Publication of this item will be temporarily paused.", -"type": "string" -}, -"productDetails": { -"description": "Technical specification or additional product details.", -"items": { -"$ref": "ProductDetail" -}, -"type": "array" -}, -"productHeight": { -"$ref": "ProductDimension", -"description": "The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." -}, -"productHighlights": { -"description": "Bullet points describing the most relevant highlights of a product.", -"items": { -"type": "string" -}, -"type": "array" -}, -"productLength": { -"$ref": "ProductDimension", -"description": "The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." -}, -"productTypes": { -"description": "Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).", -"items": { -"type": "string" -}, -"type": "array" -}, -"productWeight": { -"$ref": "ProductWeight", -"description": "The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive)." -}, -"productWidth": { -"$ref": "ProductDimension", -"description": "The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." -}, -"size": { -"description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).", -"type": "string" -}, -"sizeSystem": { -"description": "System in which the size is specified. Recommended for apparel items.", -"type": "string" -}, -"sizeTypes": { -"description": "The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).", -"items": { -"type": "string" -}, -"type": "array" -}, -"title": { -"description": "Title of the item.", -"type": "string" -} -}, -"type": "object" -}, -"Certification": { -"description": "The certification for the product.", -"id": "Certification", -"properties": { -"authority": { -"description": "Name of the certification body.", -"type": "string" -}, -"code": { -"description": "A unique code to identify the certification.", -"type": "string" -}, -"name": { -"description": "Name of the certification.", -"type": "string" -} -}, -"type": "object" -}, -"CssProduct": { -"description": "The processed CSS Product(a.k.a Aggregate Offer internally).", -"id": "CssProduct", -"properties": { -"attributes": { -"$ref": "Attributes", -"description": "Output only. A list of product attributes.", -"readOnly": true -}, -"contentLanguage": { -"description": "Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.", -"readOnly": true, -"type": "string" -}, -"cssProductStatus": { -"$ref": "CssProductStatus", -"description": "Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.", -"readOnly": true -}, -"customAttributes": { -"description": "Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.", -"items": { -"$ref": "CustomAttribute" -}, -"readOnly": true, -"type": "array" -}, -"feedLabel": { -"description": "Output only. The feed label for the product.", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "The name of the CSS Product. Format: `\"accounts/{account}/cssProducts/{css_product}\"`", -"type": "string" -}, -"rawProvidedId": { -"description": "Output only. Your unique raw identifier for the product.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"CssProductInput": { -"description": "This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.", -"id": "CssProductInput", -"properties": { -"attributes": { -"$ref": "Attributes", -"description": "A list of CSS Product attributes." -}, -"contentLanguage": { -"description": "Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product.", -"type": "string" -}, -"customAttributes": { -"description": "A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.", -"items": { -"$ref": "CustomAttribute" -}, -"type": "array" -}, -"feedLabel": { -"description": "Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to \"target country\" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.", -"type": "string" -}, -"finalName": { -"description": "Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` \"", -"readOnly": true, -"type": "string" -}, -"freshnessTime": { -"description": "Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.", -"format": "google-datetime", -"type": "string" -}, -"name": { -"description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`", -"type": "string" -}, -"rawProvidedId": { -"description": "Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details.", -"type": "string" -} -}, -"type": "object" -}, -"CssProductStatus": { -"description": "The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously.", -"id": "CssProductStatus", -"properties": { -"creationDate": { -"description": "Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", -"format": "google-datetime", -"type": "string" -}, -"destinationStatuses": { -"description": "The intended destinations for the product.", -"items": { -"$ref": "DestinationStatus" -}, -"type": "array" -}, -"googleExpirationDate": { -"description": "Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", -"format": "google-datetime", -"type": "string" -}, -"itemLevelIssues": { -"description": "A list of all issues associated with the product.", -"items": { -"$ref": "ItemLevelIssue" -}, -"type": "array" -}, -"lastUpdateDate": { -"description": "Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, -"CustomAttribute": { -"description": "A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.", -"id": "CustomAttribute", -"properties": { -"groupValues": { -"description": "Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.", -"items": { -"$ref": "CustomAttribute" -}, -"type": "array" -}, -"name": { -"description": "The name of the attribute.", -"type": "string" -}, -"value": { -"description": "The value of the attribute. If `value` is not empty, `group_values` must be empty.", -"type": "string" -} -}, -"type": "object" -}, -"DestinationStatus": { -"description": "The destination status of the product status.", -"id": "DestinationStatus", -"properties": { -"approvedCountries": { -"description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved.", -"items": { -"type": "string" -}, -"type": "array" -}, -"destination": { -"description": "The name of the destination", -"type": "string" -}, -"disapprovedCountries": { -"description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved.", -"items": { -"type": "string" -}, -"type": "array" -}, -"pendingCountries": { -"description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"Empty": { -"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", -"id": "Empty", -"properties": {}, -"type": "object" -}, -"ItemLevelIssue": { -"description": "The ItemLevelIssue of the product status.", -"id": "ItemLevelIssue", -"properties": { -"applicableCountries": { -"description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer.", -"items": { -"type": "string" -}, -"type": "array" -}, -"attribute": { -"description": "The attribute's name, if the issue is caused by a single attribute.", -"type": "string" -}, -"code": { -"description": "The error code of the issue.", -"type": "string" -}, -"description": { -"description": "A short issue description in English.", -"type": "string" -}, -"destination": { -"description": "The destination the issue applies to.", -"type": "string" -}, -"detail": { -"description": "A detailed issue description in English.", -"type": "string" -}, -"documentation": { -"description": "The URL of a web page to help with resolving this issue.", -"type": "string" -}, -"resolution": { -"description": "Whether the issue can be resolved by the merchant.", -"type": "string" -}, -"servability": { -"description": "How this issue affects serving of the aggregate offer.", -"type": "string" -} -}, -"type": "object" -}, -"ListAccountLabelsResponse": { -"description": "Response message for the `ListAccountLabels` method.", -"id": "ListAccountLabelsResponse", -"properties": { -"accountLabels": { -"description": "The labels from the specified account.", -"items": { -"$ref": "AccountLabel" -}, -"type": "array" -}, -"nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", -"type": "string" -} -}, -"type": "object" -}, -"ListChildAccountsResponse": { -"description": "Response message for the `ListChildAccounts` method.", -"id": "ListChildAccountsResponse", -"properties": { -"accounts": { -"description": "The CSS/MC accounts returned for the specified CSS parent account.", -"items": { -"$ref": "Account" -}, -"type": "array" -}, -"nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", -"type": "string" -} -}, -"type": "object" -}, -"ListCssProductsResponse": { -"description": "Response message for the ListCssProducts method.", -"id": "ListCssProductsResponse", -"properties": { -"cssProducts": { -"description": "The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds.", -"items": { -"$ref": "CssProduct" -}, -"type": "array" -}, -"nextPageToken": { -"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", -"type": "string" -} -}, -"type": "object" -}, -"Price": { -"description": "The price represented as a number and currency.", -"id": "Price", -"properties": { -"amountMicros": { -"description": "The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).", -"format": "int64", -"type": "string" -}, -"currencyCode": { -"description": "The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).", -"type": "string" -} -}, -"type": "object" -}, -"ProductDetail": { -"description": "The product details.", -"id": "ProductDetail", -"properties": { -"attributeName": { -"description": "The name of the product detail.", -"type": "string" -}, -"attributeValue": { -"description": "The value of the product detail.", -"type": "string" -}, -"sectionName": { -"description": "The section header used to group a set of product details.", -"type": "string" -} -}, -"type": "object" -}, -"ProductDimension": { -"description": "The dimension of the product.", -"id": "ProductDimension", -"properties": { -"unit": { -"description": "Required. The dimension units. Acceptable values are: * \"`in`\" * \"`cm`\"", -"type": "string" -}, -"value": { -"description": "Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.", -"format": "double", -"type": "number" -} -}, -"type": "object" -}, -"ProductWeight": { -"description": "The weight of the product.", -"id": "ProductWeight", -"properties": { -"unit": { -"description": "Required. The weight unit. Acceptable values are: * \"`g`\" * \"`kg`\" * \"`oz`\" * \"`lb`\"", -"type": "string" -}, -"value": { -"description": "Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.", -"format": "double", -"type": "number" -} -}, -"type": "object" -}, -"UpdateAccountLabelsRequest": { -"description": "The request message for the `UpdateLabels` method.", -"id": "UpdateAccountLabelsRequest", -"properties": { -"labelIds": { -"description": "The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.", -"items": { -"format": "int64", -"type": "string" -}, -"type": "array" -}, -"parent": { -"description": "Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}", -"type": "string" -} -}, -"type": "object" -} -}, -"servicePath": "", -"title": "CSS API", -"version": "v1", -"version_module": true -} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/customsearch.v1.json b/googleapiclient/discovery_cache/documents/customsearch.v1.json index f89eb6389d2..9814acec944 100644 --- a/googleapiclient/discovery_cache/documents/customsearch.v1.json +++ b/googleapiclient/discovery_cache/documents/customsearch.v1.json @@ -702,7 +702,7 @@ false } } }, -"revision": "20240713", +"revision": "20240704", "rootUrl": "https://customsearch.googleapis.com/", "schemas": { "Promotion": { diff --git a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json index 49c74b8758c..cd7333247b6 100644 --- a/googleapiclient/discovery_cache/documents/dataform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/dataform.v1beta1.json @@ -2236,7 +2236,7 @@ } } }, -"revision": "20240706", +"revision": "20240629", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "Assertion": { diff --git a/googleapiclient/discovery_cache/documents/datalineage.v1.json b/googleapiclient/discovery_cache/documents/datalineage.v1.json index 5312f547e57..e23da12fc2d 100644 --- a/googleapiclient/discovery_cache/documents/datalineage.v1.json +++ b/googleapiclient/discovery_cache/documents/datalineage.v1.json @@ -798,7 +798,7 @@ } } }, -"revision": "20240705", +"revision": "20240621", "rootUrl": "https://datalineage.googleapis.com/", "schemas": { "GoogleCloudDatacatalogLineageV1BatchSearchLinkProcessesRequest": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index 4de03160b05..b9ffd8f5968 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2125,7 +2125,7 @@ } } }, -"revision": "20240701", +"revision": "20240628", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json index 91019f28cff..8b32c20910b 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1beta1.json @@ -1049,7 +1049,7 @@ } } }, -"revision": "20240701", +"revision": "20240628", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 6b935d6b42a..5a65926ebea 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -5273,7 +5273,7 @@ } } }, -"revision": "20240705", +"revision": "20240624", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1.json b/googleapiclient/discovery_cache/documents/dataportability.v1.json index 010ab296098..8487af7cfdd 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1.json @@ -641,7 +641,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json index 433cca0f568..39ebeb7eed8 100644 --- a/googleapiclient/discovery_cache/documents/dataportability.v1beta.json +++ b/googleapiclient/discovery_cache/documents/dataportability.v1beta.json @@ -641,7 +641,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://dataportability.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 8e8960a5da7..b27648821e2 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -3072,7 +3072,7 @@ } } }, -"revision": "20240710", +"revision": "20240626", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1.json b/googleapiclient/discovery_cache/documents/datastore.v1.json index e1c6090ac77..6b94f6ce4e0 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1.json @@ -654,7 +654,7 @@ } } }, -"revision": "20240630", +"revision": "20240626", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json index 97d84f16384..2a8e82466b8 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta1.json @@ -168,7 +168,7 @@ } } }, -"revision": "20240630", +"revision": "20240626", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "GoogleDatastoreAdminV1CommonMetadata": { diff --git a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json index f045f039de5..5553cc57756 100644 --- a/googleapiclient/discovery_cache/documents/datastore.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/datastore.v1beta3.json @@ -336,7 +336,7 @@ } } }, -"revision": "20240630", +"revision": "20240626", "rootUrl": "https://datastore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 4ec62039ad5..43f21acf3df 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1250,7 +1250,7 @@ } } }, -"revision": "20240703", +"revision": "20240626", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { diff --git a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json index b97ff9701c9..5584fccf35f 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1alpha1.json @@ -1224,7 +1224,7 @@ } } }, -"revision": "20240703", +"revision": "20240626", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AvroFileFormat": { diff --git a/googleapiclient/discovery_cache/documents/developerconnect.v1.json b/googleapiclient/discovery_cache/documents/developerconnect.v1.json index 2dc1659b2a7..5fa911433d0 100644 --- a/googleapiclient/discovery_cache/documents/developerconnect.v1.json +++ b/googleapiclient/discovery_cache/documents/developerconnect.v1.json @@ -840,7 +840,7 @@ } } }, -"revision": "20240708", +"revision": "20240628", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index ca7a422ff21..9c56048ca9a 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -4343,32 +4343,6 @@ "https://www.googleapis.com/auth/dialogflow" ] }, -"getEncryptionSpec": { -"description": "Gets location-level encryption key specification.", -"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec", -"httpMethod": "GET", -"id": "dialogflow.projects.locations.getEncryptionSpec", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the encryption spec resource to get.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", -"required": true, -"type": "string" -} -}, -"path": "v2/{+name}", -"response": { -"$ref": "GoogleCloudDialogflowV2EncryptionSpec" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dialogflow" -] -}, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2/projects/{projectsId}/locations", @@ -7743,39 +7717,6 @@ } } }, -"encryptionSpec": { -"methods": { -"initialize": { -"description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", -"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", -"httpMethod": "POST", -"id": "dialogflow.projects.locations.encryptionSpec.initialize", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", -"required": true, -"type": "string" -} -}, -"path": "v2/{+name}:initialize", -"request": { -"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dialogflow" -] -} -} -}, "generators": { "methods": { "create": { @@ -8714,7 +8655,7 @@ } } }, -"revision": "20240704", +"revision": "20240617", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -9226,10 +9167,6 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, -"targetPlaybook": { -"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", -"type": "string" -}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -11620,10 +11557,6 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, -"targetPlaybook": { -"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", -"type": "string" -}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -15080,21 +15013,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2EncryptionSpec": { -"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", -"id": "GoogleCloudDialogflowV2EncryptionSpec", -"properties": { -"kmsKey": { -"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", -"type": "string" -}, -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -16299,29 +16217,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { -"description": "Metadata for initializing a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", -"properties": { -"request": { -"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", -"description": "Output only. The original request for initialization.", -"readOnly": true -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { -"description": "The request to initialize a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", -"properties": { -"encryptionSpec": { -"$ref": "GoogleCloudDialogflowV2EncryptionSpec", -"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2InputAudioConfig": { "description": "Instructs the speech recognizer how to process the audio content.", "id": "GoogleCloudDialogflowV2InputAudioConfig", @@ -19700,21 +19595,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1EncryptionSpec": { -"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", -"id": "GoogleCloudDialogflowV2beta1EncryptionSpec", -"properties": { -"kmsKey": { -"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", -"type": "string" -}, -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -19919,29 +19799,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { -"description": "Metadata for initializing a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", -"properties": { -"request": { -"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", -"description": "Output only. The original request for initialization.", -"readOnly": true -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { -"description": "The request to initialize a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", -"properties": { -"encryptionSpec": { -"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", -"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -21401,13 +21258,6 @@ true "readOnly": true, "type": "string" }, -"responseMessages": { -"description": "Optional. Automated agent responses.", -"items": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" -}, -"type": "array" -}, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -21557,125 +21407,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1ResponseMessage": { -"description": "Response messages from an automated agent.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessage", -"properties": { -"endInteraction": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", -"description": "A signal that indicates the interaction with the Dialogflow agent has ended." -}, -"liveAgentHandoff": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", -"description": "Hands off conversation to a live agent." -}, -"mixedAudio": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", -"description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." -}, -"payload": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "Returns a response containing a custom, platform-specific payload.", -"type": "object" -}, -"telephonyTransferCall": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", -"description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." -}, -"text": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", -"description": "Returns a text response." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { -"description": "Indicates that interaction with the Dialogflow agent has ended.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", -"properties": {}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { -"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", -"properties": { -"metadata": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", -"type": "object" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { -"description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", -"properties": { -"segments": { -"description": "Segments this audio response is composed of.", -"items": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { -"description": "Represents one segment of audio.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", -"properties": { -"allowPlaybackInterruption": { -"description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", -"type": "boolean" -}, -"audio": { -"description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", -"format": "byte", -"type": "string" -}, -"uri": { -"description": "Client-specific URI that points to an audio clip accessible to the client.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { -"description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", -"properties": { -"phoneNumber": { -"description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", -"type": "string" -}, -"sipUri": { -"description": "Transfer the call to a SIP endpoint.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageText": { -"description": "The text response message.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageText", -"properties": { -"text": { -"description": "A collection of text responses.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 3d334b12234..ad31295c55a 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -4108,32 +4108,6 @@ "https://www.googleapis.com/auth/dialogflow" ] }, -"getEncryptionSpec": { -"description": "Gets location-level encryption key specification.", -"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", -"httpMethod": "GET", -"id": "dialogflow.projects.locations.getEncryptionSpec", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the encryption spec resource to get.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", -"required": true, -"type": "string" -} -}, -"path": "v2beta1/{+name}", -"response": { -"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dialogflow" -] -}, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2beta1/projects/{projectsId}/locations", @@ -7135,39 +7109,6 @@ } } }, -"encryptionSpec": { -"methods": { -"initialize": { -"description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", -"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", -"httpMethod": "POST", -"id": "dialogflow.projects.locations.encryptionSpec.initialize", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", -"required": true, -"type": "string" -} -}, -"path": "v2beta1/{+name}:initialize", -"request": { -"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dialogflow" -] -} -} -}, "generators": { "methods": { "create": { @@ -8082,7 +8023,7 @@ } } }, -"revision": "20240704", +"revision": "20240617", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8594,10 +8535,6 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, -"targetPlaybook": { -"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", -"type": "string" -}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -10988,10 +10925,6 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, -"targetPlaybook": { -"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", -"type": "string" -}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -13341,21 +13274,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowV2EncryptionSpec": { -"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", -"id": "GoogleCloudDialogflowV2EncryptionSpec", -"properties": { -"kmsKey": { -"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", -"type": "string" -}, -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -13599,29 +13517,6 @@ }, "type": "object" }, -"GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { -"description": "Metadata for initializing a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", -"properties": { -"request": { -"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", -"description": "Output only. The original request for initialization.", -"readOnly": true -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { -"description": "The request to initialize a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", -"properties": { -"encryptionSpec": { -"$ref": "GoogleCloudDialogflowV2EncryptionSpec", -"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -16617,21 +16512,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1EncryptionSpec": { -"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", -"id": "GoogleCloudDialogflowV2beta1EncryptionSpec", -"properties": { -"kmsKey": { -"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", -"type": "string" -}, -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -17726,29 +17606,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { -"description": "Metadata for initializing a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", -"properties": { -"request": { -"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", -"description": "Output only. The original request for initialization.", -"readOnly": true -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { -"description": "The request to initialize a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", -"properties": { -"encryptionSpec": { -"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", -"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowV2beta1InputAudioConfig", @@ -19642,13 +19499,6 @@ true "readOnly": true, "type": "string" }, -"responseMessages": { -"description": "Optional. Automated agent responses.", -"items": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" -}, -"type": "array" -}, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 37ab72d10a3..2ccf651f72a 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -4453,7 +4453,7 @@ } } }, -"revision": "20240704", +"revision": "20240617", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5273,10 +5273,6 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { -"model": { -"description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", -"type": "string" -}, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5368,10 +5364,6 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { -"model": { -"description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", -"type": "string" -}, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5835,10 +5827,6 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, -"targetPlaybook": { -"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", -"type": "string" -}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -7876,7 +7864,6 @@ false "NO_MATCH", "NO_INPUT", "EVENT", -"KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -7887,7 +7874,6 @@ false "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", -"The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -10726,10 +10712,6 @@ false "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, -"targetPlaybook": { -"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", -"type": "string" -}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -13079,21 +13061,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowV2EncryptionSpec": { -"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", -"id": "GoogleCloudDialogflowV2EncryptionSpec", -"properties": { -"kmsKey": { -"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", -"type": "string" -}, -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -13337,29 +13304,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { -"description": "Metadata for initializing a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", -"properties": { -"request": { -"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", -"description": "Output only. The original request for initialization.", -"readOnly": true -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { -"description": "The request to initialize a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", -"properties": { -"encryptionSpec": { -"$ref": "GoogleCloudDialogflowV2EncryptionSpec", -"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -15181,21 +15125,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1EncryptionSpec": { -"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", -"id": "GoogleCloudDialogflowV2beta1EncryptionSpec", -"properties": { -"kmsKey": { -"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", -"type": "string" -}, -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -15400,29 +15329,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { -"description": "Metadata for initializing a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", -"properties": { -"request": { -"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", -"description": "Output only. The original request for initialization.", -"readOnly": true -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { -"description": "The request to initialize a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", -"properties": { -"encryptionSpec": { -"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", -"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -16882,13 +16788,6 @@ true "readOnly": true, "type": "string" }, -"responseMessages": { -"description": "Optional. Automated agent responses.", -"items": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" -}, -"type": "array" -}, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -17038,125 +16937,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1ResponseMessage": { -"description": "Response messages from an automated agent.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessage", -"properties": { -"endInteraction": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", -"description": "A signal that indicates the interaction with the Dialogflow agent has ended." -}, -"liveAgentHandoff": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", -"description": "Hands off conversation to a live agent." -}, -"mixedAudio": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", -"description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." -}, -"payload": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "Returns a response containing a custom, platform-specific payload.", -"type": "object" -}, -"telephonyTransferCall": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", -"description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." -}, -"text": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", -"description": "Returns a text response." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { -"description": "Indicates that interaction with the Dialogflow agent has ended.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", -"properties": {}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { -"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", -"properties": { -"metadata": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", -"type": "object" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { -"description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", -"properties": { -"segments": { -"description": "Segments this audio response is composed of.", -"items": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { -"description": "Represents one segment of audio.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", -"properties": { -"allowPlaybackInterruption": { -"description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", -"type": "boolean" -}, -"audio": { -"description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", -"format": "byte", -"type": "string" -}, -"uri": { -"description": "Client-specific URI that points to an audio clip accessible to the client.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { -"description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", -"properties": { -"phoneNumber": { -"description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", -"type": "string" -}, -"sipUri": { -"description": "Transfer the call to a SIP endpoint.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageText": { -"description": "The text response message.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageText", -"properties": { -"text": { -"description": "A collection of text responses.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 41558e76a42..9b269057509 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5185,7 +5185,7 @@ } } }, -"revision": "20240704", +"revision": "20240617", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5697,10 +5697,6 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, -"targetPlaybook": { -"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", -"type": "string" -}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -8703,10 +8699,6 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { -"model": { -"description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", -"type": "string" -}, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -8798,10 +8790,6 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { -"model": { -"description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", -"type": "string" -}, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -9269,10 +9257,6 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, -"targetPlaybook": { -"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", -"type": "string" -}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -11600,7 +11584,6 @@ false "NO_MATCH", "NO_INPUT", "EVENT", -"KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -11611,7 +11594,6 @@ false "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", -"The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -15000,21 +14982,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowV2EncryptionSpec": { -"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", -"id": "GoogleCloudDialogflowV2EncryptionSpec", -"properties": { -"kmsKey": { -"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", -"type": "string" -}, -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -15258,29 +15225,6 @@ false }, "type": "object" }, -"GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { -"description": "Metadata for initializing a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", -"properties": { -"request": { -"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", -"description": "Output only. The original request for initialization.", -"readOnly": true -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { -"description": "The request to initialize a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", -"properties": { -"encryptionSpec": { -"$ref": "GoogleCloudDialogflowV2EncryptionSpec", -"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -17102,21 +17046,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1EncryptionSpec": { -"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", -"id": "GoogleCloudDialogflowV2beta1EncryptionSpec", -"properties": { -"kmsKey": { -"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", -"type": "string" -}, -"name": { -"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -17321,29 +17250,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { -"description": "Metadata for initializing a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", -"properties": { -"request": { -"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", -"description": "Output only. The original request for initialization.", -"readOnly": true -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { -"description": "The request to initialize a location-level encryption specification.", -"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", -"properties": { -"encryptionSpec": { -"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", -"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -18803,13 +18709,6 @@ true "readOnly": true, "type": "string" }, -"responseMessages": { -"description": "Optional. Automated agent responses.", -"items": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" -}, -"type": "array" -}, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -18959,125 +18858,6 @@ true }, "type": "object" }, -"GoogleCloudDialogflowV2beta1ResponseMessage": { -"description": "Response messages from an automated agent.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessage", -"properties": { -"endInteraction": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", -"description": "A signal that indicates the interaction with the Dialogflow agent has ended." -}, -"liveAgentHandoff": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", -"description": "Hands off conversation to a live agent." -}, -"mixedAudio": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", -"description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." -}, -"payload": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "Returns a response containing a custom, platform-specific payload.", -"type": "object" -}, -"telephonyTransferCall": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", -"description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." -}, -"text": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", -"description": "Returns a text response." -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { -"description": "Indicates that interaction with the Dialogflow agent has ended.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", -"properties": {}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { -"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", -"properties": { -"metadata": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", -"type": "object" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { -"description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", -"properties": { -"segments": { -"description": "Segments this audio response is composed of.", -"items": { -"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { -"description": "Represents one segment of audio.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", -"properties": { -"allowPlaybackInterruption": { -"description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", -"type": "boolean" -}, -"audio": { -"description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", -"format": "byte", -"type": "string" -}, -"uri": { -"description": "Client-specific URI that points to an audio clip accessible to the client.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { -"description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", -"properties": { -"phoneNumber": { -"description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", -"type": "string" -}, -"sipUri": { -"description": "Transfer the call to a SIP endpoint.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDialogflowV2beta1ResponseMessageText": { -"description": "The text response message.", -"id": "GoogleCloudDialogflowV2beta1ResponseMessageText", -"properties": { -"text": { -"description": "A collection of text responses.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json index d3837bdc28d..778ff535688 100644 --- a/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json +++ b/googleapiclient/discovery_cache/documents/digitalassetlinks.v1.json @@ -199,7 +199,7 @@ } } }, -"revision": "20240709", +"revision": "20240702", "rootUrl": "https://digitalassetlinks.googleapis.com/", "schemas": { "AndroidAppAsset": { diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 333411ed03b..2979816235f 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -5711,7 +5711,7 @@ } } }, -"revision": "20240704", +"revision": "20240701", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6177,11 +6177,6 @@ "disable": { "description": "Disable query rephraser.", "type": "boolean" -}, -"maxRephraseSteps": { -"description": "Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.", -"format": "int32", -"type": "integer" } }, "type": "object" @@ -12322,38 +12317,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { -"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { -"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", -"properties": { -"outputResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", -"description": "Output result indicating where the data were exported to." -}, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of the export operation." -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -12783,32 +12746,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaOutputResult": { -"description": "Output result that stores the information about where the exported data is stored.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", -"properties": { -"bigqueryResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"description": "The BigQuery location where the result is stored." -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { -"description": "A BigQuery output result.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"properties": { -"datasetId": { -"description": "The ID of a BigQuery Dataset.", -"type": "string" -}, -"tableId": { -"description": "The ID of a BigQuery Table.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 3f6b0851113..91c7d6a8757 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -6761,7 +6761,7 @@ } } }, -"revision": "20240704", +"revision": "20240701", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -11416,38 +11416,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { -"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { -"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", -"properties": { -"outputResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", -"description": "Output result indicating where the data were exported to." -}, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of the export operation." -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaFactChunk": { "description": "Fact Chunk.", "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", @@ -12441,32 +12409,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaOutputResult": { -"description": "Output result that stores the information about where the exported data is stored.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", -"properties": { -"bigqueryResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"description": "The BigQuery location where the result is stored." -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { -"description": "A BigQuery output result.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"properties": { -"datasetId": { -"description": "The ID of a BigQuery Dataset.", -"type": "string" -}, -"tableId": { -"description": "The ID of a BigQuery Table.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 3a7a3ab31b8..fa33383aa34 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -6175,7 +6175,7 @@ } } }, -"revision": "20240704", +"revision": "20240701", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -9150,38 +9150,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { -"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { -"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", -"properties": { -"outputResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", -"description": "Output result indicating where the data were exported to." -}, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of the export operation." -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -9611,32 +9579,6 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaOutputResult": { -"description": "Output result that stores the information about where the exported data is stored.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", -"properties": { -"bigqueryResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"description": "The BigQuery location where the result is stored." -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { -"description": "A BigQuery output result.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"properties": { -"datasetId": { -"description": "The ID of a BigQuery Dataset.", -"type": "string" -}, -"tableId": { -"description": "The ID of a BigQuery Table.", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index a893dcc91da..5a51cbefe70 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -23,213 +23,13 @@ }, { "description": "Regional Endpoint", -"endpointUrl": "https://dlp.asia-east1.rep.googleapis.com/", -"location": "asia-east1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.asia-east2.rep.googleapis.com/", -"location": "asia-east2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.asia-northeast1.rep.googleapis.com/", -"location": "asia-northeast1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.asia-northeast2.rep.googleapis.com/", -"location": "asia-northeast2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.asia-northeast3.rep.googleapis.com/", -"location": "asia-northeast3" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.asia-south1.rep.googleapis.com/", -"location": "asia-south1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.asia-south2.rep.googleapis.com/", -"location": "asia-south2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.asia-southeast1.rep.googleapis.com/", -"location": "asia-southeast1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.asia-southeast2.rep.googleapis.com/", -"location": "asia-southeast2" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dlp.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1" }, { "description": "Regional Endpoint", -"endpointUrl": "https://dlp.australia-southeast2.rep.googleapis.com/", -"location": "australia-southeast2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-central2.rep.googleapis.com/", -"location": "europe-central2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-north1.rep.googleapis.com/", -"location": "europe-north1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-north2.rep.googleapis.com/", -"location": "europe-north2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-southwest1.rep.googleapis.com/", -"location": "europe-southwest1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-west1.rep.googleapis.com/", -"location": "europe-west1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-west10.rep.googleapis.com/", -"location": "europe-west10" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-west12.rep.googleapis.com/", -"location": "europe-west12" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-west2.rep.googleapis.com/", -"location": "europe-west2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-west3.rep.googleapis.com/", -"location": "europe-west3" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-west4.rep.googleapis.com/", -"location": "europe-west4" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-west6.rep.googleapis.com/", -"location": "europe-west6" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.europe-west8.rep.googleapis.com/", -"location": "europe-west8" -}, -{ -"description": "Regional Endpoint", "endpointUrl": "https://dlp.europe-west9.rep.googleapis.com/", "location": "europe-west9" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.me-central1.rep.googleapis.com/", -"location": "me-central1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.me-central2.rep.googleapis.com/", -"location": "me-central2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.me-west1.rep.googleapis.com/", -"location": "me-west1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.northamerica-northeast1.rep.googleapis.com/", -"location": "northamerica-northeast1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.northamerica-northeast2.rep.googleapis.com/", -"location": "northamerica-northeast2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.northamerica-south1.rep.googleapis.com/", -"location": "northamerica-south1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.southamerica-east1.rep.googleapis.com/", -"location": "southamerica-east1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.southamerica-west1.rep.googleapis.com/", -"location": "southamerica-west1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-central1.rep.googleapis.com/", -"location": "us-central1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-east1.rep.googleapis.com/", -"location": "us-east1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-east4.rep.googleapis.com/", -"location": "us-east4" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-east5.rep.googleapis.com/", -"location": "us-east5" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-south1.rep.googleapis.com/", -"location": "us-south1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-west1.rep.googleapis.com/", -"location": "us-west1" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-west2.rep.googleapis.com/", -"location": "us-west2" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-west3.rep.googleapis.com/", -"location": "us-west3" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-west4.rep.googleapis.com/", -"location": "us-west4" -}, -{ -"description": "Regional Endpoint", -"endpointUrl": "https://dlp.us-west8.rep.googleapis.com/", -"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -4974,7 +4774,7 @@ } } }, -"revision": "20240707", +"revision": "20240702", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -6569,7 +6369,7 @@ "id": "GooglePrivacyDlpV2DataProfileLocation", "properties": { "folderId": { -"description": "The ID of the folder within an organization to scan.", +"description": "The ID of the Folder within an organization to scan.", "format": "int64", "type": "string" }, @@ -7576,7 +7376,7 @@ "id": "GooglePrivacyDlpV2DiscoveryStartingLocation", "properties": { "folderId": { -"description": "The ID of the folder within an organization to scan.", +"description": "The ID of the Folder within an organization to scan.", "format": "int64", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index 92ac9b12d51..9735a9cee25 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -1824,7 +1824,7 @@ } } }, -"revision": "20240704", +"revision": "20240627", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index 7361d6d87f1..677b1c60c52 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -1821,7 +1821,7 @@ } } }, -"revision": "20240704", +"revision": "20240627", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index d11ebb5be6e..a39d7a4abbd 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -216,7 +216,7 @@ } } }, -"revision": "20240711", +"revision": "20240626", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index c7e0e4f74b0..d5db73c2377 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1042,7 +1042,7 @@ } } }, -"revision": "20240708", +"revision": "20240703", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json index 2e2d99a6581..b73dd7d3f89 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta2.json @@ -292,7 +292,7 @@ } } }, -"revision": "20240708", +"revision": "20240703", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 5abdd15b13c..9a61f6c8847 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1284,7 +1284,7 @@ } } }, -"revision": "20240708", +"revision": "20240703", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { diff --git a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json index a6c3ada940f..ac147710c8b 100644 --- a/googleapiclient/discovery_cache/documents/domainsrdap.v1.json +++ b/googleapiclient/discovery_cache/documents/domainsrdap.v1.json @@ -289,7 +289,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://domainsrdap.googleapis.com/", "schemas": { "HttpBody": { diff --git a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json index 3fde892fae9..1f7d62ca0c0 100644 --- a/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclickbidmanager.v2.json @@ -319,7 +319,7 @@ } } }, -"revision": "20240703", +"revision": "20240626", "rootUrl": "https://doubleclickbidmanager.googleapis.com/", "schemas": { "DataRange": { diff --git a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json index 469ddad48d9..5280d5df300 100644 --- a/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json +++ b/googleapiclient/discovery_cache/documents/doubleclicksearch.v2.json @@ -543,7 +543,7 @@ } } }, -"revision": "20240709", +"revision": "20240625", "rootUrl": "https://doubleclicksearch.googleapis.com/", "schemas": { "Availability": { diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index ad038247a53..413513812a8 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -3869,7 +3869,7 @@ } } }, -"revision": "20240708", +"revision": "20240628", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index c135a00ea36..1cc341e8fe7 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -2523,7 +2523,7 @@ } } }, -"revision": "20240708", +"revision": "20240628", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/driveactivity.v2.json b/googleapiclient/discovery_cache/documents/driveactivity.v2.json index 67781097de9..74f03dfed28 100644 --- a/googleapiclient/discovery_cache/documents/driveactivity.v2.json +++ b/googleapiclient/discovery_cache/documents/driveactivity.v2.json @@ -132,7 +132,7 @@ } } }, -"revision": "20240707", +"revision": "20240625", "rootUrl": "https://driveactivity.googleapis.com/", "schemas": { "Action": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2.json b/googleapiclient/discovery_cache/documents/drivelabels.v2.json index 5d7d4e8c7a0..d92f7058f27 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2.json @@ -1032,7 +1032,7 @@ } } }, -"revision": "20240711", +"revision": "20240701", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2BadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json index c47bc571cb6..1667b785b18 100644 --- a/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json +++ b/googleapiclient/discovery_cache/documents/drivelabels.v2beta.json @@ -1032,7 +1032,7 @@ } } }, -"revision": "20240711", +"revision": "20240701", "rootUrl": "https://drivelabels.googleapis.com/", "schemas": { "GoogleAppsDriveLabelsV2betaBadgeColors": { diff --git a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json index 3f4963ef304..ef9c6a499c9 100644 --- a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json @@ -850,7 +850,7 @@ } } }, -"revision": "20240713", +"revision": "20240630", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { @@ -923,7 +923,7 @@ "type": "string" }, "validationState": { -"description": "Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.", +"description": "The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.", "enum": [ "VALIDATION_STATE_UNSPECIFIED", "VALID", @@ -934,7 +934,6 @@ "The contact is marked as valid. This is usually done manually by the contact admin. All new contacts begin in the valid state.", "The contact is considered invalid. This may become the state if the contact's email is found to be unreachable." ], -"readOnly": true, "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json index 265131941ea..a7802ac399b 100644 --- a/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/factchecktools.v1alpha1.json @@ -352,7 +352,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://factchecktools.googleapis.com/", "schemas": { "GoogleFactcheckingFactchecktoolsV1alpha1Claim": { diff --git a/googleapiclient/discovery_cache/documents/fcm.v1.json b/googleapiclient/discovery_cache/documents/fcm.v1.json index cce75281e4d..f92fe97dba6 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240708", +"revision": "20240703", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json index 97bea42a6ee..dac096ac374 100644 --- a/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/fcmdata.v1beta1.json @@ -154,7 +154,7 @@ } } }, -"revision": "20240711", +"revision": "20240707", "rootUrl": "https://fcmdata.googleapis.com/", "schemas": { "GoogleFirebaseFcmDataV1beta1AndroidDeliveryData": { diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json index 6cfade0add3..e60e96ffcce 100644 --- a/googleapiclient/discovery_cache/documents/file.v1.json +++ b/googleapiclient/discovery_cache/documents/file.v1.json @@ -902,7 +902,7 @@ } } }, -"revision": "20240704", +"revision": "20240626", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json index 4641a75596c..abd228bcf76 100644 --- a/googleapiclient/discovery_cache/documents/file.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json @@ -1069,7 +1069,7 @@ } } }, -"revision": "20240704", +"revision": "20240626", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1098,21 +1098,6 @@ "readOnly": true, "type": "string" }, -"fileSystemProtocol": { -"description": "Output only. The file system protocol of the source Filestore instance that this backup is created from.", -"enum": [ -"FILE_PROTOCOL_UNSPECIFIED", -"NFS_V3", -"NFS_V4_1" -], -"enumDescriptions": [ -"FILE_PROTOCOL_UNSPECIFIED serves a \"not set\" default value when a FileProtocol is a separate field in a message.", -"NFS 3.0.", -"NFS 4.1." -], -"readOnly": true, -"type": "string" -}, "kmsKeyName": { "description": "Immutable. KMS key name used for data encryption.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json index e674bd0abef..795c9cd50b5 100644 --- a/googleapiclient/discovery_cache/documents/firebase.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebase.v1beta1.json @@ -1324,7 +1324,7 @@ } } }, -"revision": "20240711", +"revision": "20240705", "rootUrl": "https://firebase.googleapis.com/", "schemas": { "AddFirebaseRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json index 4b18e98f6bf..03203cc9816 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1.json @@ -941,7 +941,7 @@ } } }, -"revision": "20240712", +"revision": "20240708", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GdataBlobstore2Info": { diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 6493c6e67b4..5f6c252fb30 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -585,7 +585,7 @@ } } }, -"revision": "20240712", +"revision": "20240708", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GoogleFirebaseAppdistroV1Release": { @@ -708,16 +708,16 @@ "steps": { "description": "Required. Steps to be accomplished by the AI", "items": { -"$ref": "GoogleFirebaseAppdistroV1alphaAiStep" +"$ref": "GoogleFirebaseAppdistroV1alphaAiInstructionsStep" }, "type": "array" } }, "type": "object" }, -"GoogleFirebaseAppdistroV1alphaAiStep": { +"GoogleFirebaseAppdistroV1alphaAiInstructionsStep": { "description": "A step to be accomplished by the AI", -"id": "GoogleFirebaseAppdistroV1alphaAiStep", +"id": "GoogleFirebaseAppdistroV1alphaAiInstructionsStep", "properties": { "assertion": { "description": "An assertion to be checked by the AI", @@ -730,34 +730,6 @@ }, "type": "object" }, -"GoogleFirebaseAppdistroV1alphaAiStepResult": { -"description": "Captures the results of an AiStep", -"id": "GoogleFirebaseAppdistroV1alphaAiStepResult", -"properties": { -"state": { -"description": "Output only. The current state of the step", -"enum": [ -"STEP_STATE_UNSPECIFIED", -"IN_PROGRESS", -"PASSED", -"FAILED" -], -"enumDescriptions": [ -"Step state unspecified", -"The step is in progress", -"The step has completed successfully", -"The step has failed" -], -"readOnly": true, -"type": "string" -}, -"step": { -"$ref": "GoogleFirebaseAppdistroV1alphaAiStep", -"description": "Required. The step performed by the AI" -} -}, -"type": "object" -}, "GoogleFirebaseAppdistroV1alphaApp": { "id": "GoogleFirebaseAppdistroV1alphaApp", "properties": { @@ -846,14 +818,6 @@ "description": "The results of running an automated test on a particular device.", "id": "GoogleFirebaseAppdistroV1alphaDeviceExecution", "properties": { -"aiStepResults": { -"description": "Output only. Results of the AI steps if passed in", -"items": { -"$ref": "GoogleFirebaseAppdistroV1alphaAiStepResult" -}, -"readOnly": true, -"type": "array" -}, "appCrash": { "$ref": "GoogleFirebaseAppdistroV1alphaAppCrash", "description": "Output only. An app crash, if any occurred during the test.", diff --git a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json index 2756069b725..23b95ab4cbc 100644 --- a/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json +++ b/googleapiclient/discovery_cache/documents/firebasedatabase.v1beta.json @@ -351,7 +351,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://firebasedatabase.googleapis.com/", "schemas": { "DatabaseInstance": { diff --git a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json index 81ba23d3a7b..83d505dea0f 100644 --- a/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasedynamiclinks.v1.json @@ -224,7 +224,7 @@ } } }, -"revision": "20240712", +"revision": "20240701", "rootUrl": "https://firebasedynamiclinks.googleapis.com/", "schemas": { "AnalyticsInfo": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json index ddad9f0c6d9..09500c618da 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1.json @@ -269,7 +269,7 @@ } } }, -"revision": "20240710", +"revision": "20240707", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json index d86d1bc2491..200bbce0dab 100644 --- a/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firebasehosting.v1beta1.json @@ -2422,7 +2422,7 @@ } } }, -"revision": "20240710", +"revision": "20240707", "rootUrl": "https://firebasehosting.googleapis.com/", "schemas": { "ActingUser": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1.json b/googleapiclient/discovery_cache/documents/firebaseml.v1.json index 0555e8e3afc..7c11ea4c1e2 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1.json @@ -204,7 +204,7 @@ } } }, -"revision": "20240711", +"revision": "20240705", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json index b4fca6884fa..d60e8c3f18b 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v1beta2.json @@ -318,7 +318,7 @@ } } }, -"revision": "20240711", +"revision": "20240705", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "DownloadModelResponse": { diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index 8bf12daa3f0..ac3e4905bd6 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20240711", +"revision": "20240705", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { diff --git a/googleapiclient/discovery_cache/documents/firebaserules.v1.json b/googleapiclient/discovery_cache/documents/firebaserules.v1.json index 9d0ab5a92bf..9acc0ac57d7 100644 --- a/googleapiclient/discovery_cache/documents/firebaserules.v1.json +++ b/googleapiclient/discovery_cache/documents/firebaserules.v1.json @@ -477,7 +477,7 @@ } } }, -"revision": "20240701", +"revision": "20240623", "rootUrl": "https://firebaserules.googleapis.com/", "schemas": { "Arg": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 26f47eed32b..6350b16cff7 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -1706,7 +1706,7 @@ } } }, -"revision": "20240630", +"revision": "20240626", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2499,7 +2499,7 @@ "type": "string" }, "retention": { -"description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks.", +"description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.", "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index 35f530c56a0..2d521e4c573 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -950,7 +950,7 @@ } } }, -"revision": "20240630", +"revision": "20240626", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json index 3ff51f95b78..1a06dd529b0 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta2.json @@ -415,7 +415,7 @@ } } }, -"revision": "20240630", +"revision": "20240626", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/fitness.v1.json b/googleapiclient/discovery_cache/documents/fitness.v1.json index 9e23a8299ec..4304644f072 100644 --- a/googleapiclient/discovery_cache/documents/fitness.v1.json +++ b/googleapiclient/discovery_cache/documents/fitness.v1.json @@ -832,7 +832,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://fitness.googleapis.com/", "schemas": { "AggregateBucket": { diff --git a/googleapiclient/discovery_cache/documents/forms.v1.json b/googleapiclient/discovery_cache/documents/forms.v1.json index d26f38e1ca3..4811c546de0 100644 --- a/googleapiclient/discovery_cache/documents/forms.v1.json +++ b/googleapiclient/discovery_cache/documents/forms.v1.json @@ -423,7 +423,7 @@ } } }, -"revision": "20240702", +"revision": "20240625", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/gkebackup.v1.json b/googleapiclient/discovery_cache/documents/gkebackup.v1.json index 8eaffbc74c9..314e38bdc12 100644 --- a/googleapiclient/discovery_cache/documents/gkebackup.v1.json +++ b/googleapiclient/discovery_cache/documents/gkebackup.v1.json @@ -1713,7 +1713,7 @@ } } }, -"revision": "20240701", +"revision": "20240626", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 46ac9e34f77..22ce49c03b6 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -1146,122 +1146,6 @@ }, "rbacrolebindings": { "methods": { -"create": { -"description": "Creates a Membership RBACRoleBinding.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings", -"httpMethod": "POST", -"id": "gkehub.projects.locations.memberships.rbacrolebindings.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", -"required": true, -"type": "string" -}, -"rbacrolebindingId": { -"description": "Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+parent}/rbacrolebindings", -"request": { -"$ref": "RBACRoleBinding" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"delete": { -"description": "Deletes a Membership RBACRoleBinding.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", -"httpMethod": "DELETE", -"id": "gkehub.projects.locations.memberships.rbacrolebindings.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"generateMembershipRBACRoleBindingYAML": { -"description": "Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings:generateMembershipRBACRoleBindingYAML", -"httpMethod": "POST", -"id": "gkehub.projects.locations.memberships.rbacrolebindings.generateMembershipRBACRoleBindingYAML", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", -"required": true, -"type": "string" -}, -"rbacrolebindingId": { -"description": "Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+parent}/rbacrolebindings:generateMembershipRBACRoleBindingYAML", -"request": { -"$ref": "RBACRoleBinding" -}, -"response": { -"$ref": "GenerateMembershipRBACRoleBindingYAMLResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"get": { -"description": "Returns the details of a Membership RBACRoleBinding.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", -"httpMethod": "GET", -"id": "gkehub.projects.locations.memberships.rbacrolebindings.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "RBACRoleBinding" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Lists all Membership RBACRoleBindings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings", @@ -1297,40 +1181,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"patch": { -"description": "Updates a Membership RBACRoleBinding.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", -"httpMethod": "PATCH", -"id": "gkehub.projects.locations.memberships.rbacrolebindings.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. The fields to be updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "RBACRoleBinding" -}, -"response": { -"$ref": "Operation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } } } @@ -2101,7 +1951,7 @@ } } }, -"revision": "20240706", +"revision": "20240623", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2695,24 +2545,6 @@ ], "type": "string" }, -"otelCollector": { -"description": "Deployment state of otel-collector", -"enum": [ -"DEPLOYMENT_STATE_UNSPECIFIED", -"NOT_INSTALLED", -"INSTALLED", -"ERROR", -"PENDING" -], -"enumDescriptions": [ -"Deployment's state cannot be determined", -"Deployment is not installed", -"Deployment is installed", -"Deployment was attempted to be installed, but has errors", -"Deployment is installing or terminating" -], -"type": "string" -}, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2731,24 +2563,6 @@ ], "type": "string" }, -"resourceGroupControllerManager": { -"description": "Deployment state of resource-group-controller-manager", -"enum": [ -"DEPLOYMENT_STATE_UNSPECIFIED", -"NOT_INSTALLED", -"INSTALLED", -"ERROR", -"PENDING" -], -"enumDescriptions": [ -"Deployment's state cannot be determined", -"Deployment is not installed", -"Deployment is installed", -"Deployment was attempted to be installed, but has errors", -"Deployment is installing or terminating" -], -"type": "string" -}, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -2884,7 +2698,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { -"description": "Version of the deployed admission-webhook pod", +"description": "Version of the deployed admission_webhook pod", "type": "string" }, "gitSync": { @@ -2899,18 +2713,10 @@ "description": "Version of the deployed monitor pod", "type": "string" }, -"otelCollector": { -"description": "Version of the deployed otel-collector pod", -"type": "string" -}, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, -"resourceGroupControllerManager": { -"description": "Version of the deployed resource-group-controller-manager pod", -"type": "string" -}, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -3978,17 +3784,6 @@ }, "type": "object" }, -"GenerateMembershipRBACRoleBindingYAMLResponse": { -"description": "Response for GenerateRBACRoleBindingYAML.", -"id": "GenerateMembershipRBACRoleBindingYAMLResponse", -"properties": { -"roleBindingsYaml": { -"description": "a yaml text blob including the RBAC policies.", -"type": "string" -} -}, -"type": "object" -}, "GkeCluster": { "description": "GkeCluster contains information specific to GKE clusters.", "id": "GkeCluster", @@ -6211,7 +6006,7 @@ "type": "string" }, "management": { -"description": "Optional. Enables automatic Service Mesh management.", +"description": "Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index d7ea8f58c7d..2a72c1924a8 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2175,7 +2175,7 @@ } } }, -"revision": "20240706", +"revision": "20240623", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2970,24 +2970,6 @@ ], "type": "string" }, -"otelCollector": { -"description": "Deployment state of otel-collector", -"enum": [ -"DEPLOYMENT_STATE_UNSPECIFIED", -"NOT_INSTALLED", -"INSTALLED", -"ERROR", -"PENDING" -], -"enumDescriptions": [ -"Deployment's state cannot be determined", -"Deployment is not installed", -"Deployment is installed", -"Deployment was attempted to be installed, but has errors", -"Deployment is installing or terminating" -], -"type": "string" -}, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -3006,24 +2988,6 @@ ], "type": "string" }, -"resourceGroupControllerManager": { -"description": "Deployment state of resource-group-controller-manager", -"enum": [ -"DEPLOYMENT_STATE_UNSPECIFIED", -"NOT_INSTALLED", -"INSTALLED", -"ERROR", -"PENDING" -], -"enumDescriptions": [ -"Deployment's state cannot be determined", -"Deployment is not installed", -"Deployment is installed", -"Deployment was attempted to be installed, but has errors", -"Deployment is installing or terminating" -], -"type": "string" -}, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -3159,7 +3123,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { -"description": "Version of the deployed admission-webhook pod", +"description": "Version of the deployed admission_webhook pod", "type": "string" }, "gitSync": { @@ -3174,18 +3138,10 @@ "description": "Version of the deployed monitor pod", "type": "string" }, -"otelCollector": { -"description": "Version of the deployed otel-collector pod", -"type": "string" -}, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, -"resourceGroupControllerManager": { -"description": "Version of the deployed resource-group-controller-manager pod", -"type": "string" -}, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -6734,20 +6690,6 @@ "description": "**Service Mesh**: Spec for a single Membership for the servicemesh feature", "id": "ServiceMeshMembershipSpec", "properties": { -"configApi": { -"description": "Optional. Specifies the API that will be used for configuring the mesh workloads.", -"enum": [ -"CONFIG_API_UNSPECIFIED", -"CONFIG_API_ISTIO", -"CONFIG_API_GATEWAY" -], -"enumDescriptions": [ -"Unspecified", -"Use the Istio API for configuration.", -"Use the K8s Gateway API for configuration." -], -"type": "string" -}, "controlPlane": { "deprecated": true, "description": "Deprecated: use `management` instead Enables automatic control plane management.", @@ -6764,7 +6706,6 @@ "type": "string" }, "defaultChannel": { -"deprecated": true, "description": "Determines which release channel to use for default injection and service mesh APIs.", "enum": [ "CHANNEL_UNSPECIFIED", @@ -6781,7 +6722,7 @@ "type": "string" }, "management": { -"description": "Optional. Enables automatic Service Mesh management.", +"description": "Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index c85ec8a75a0..9c5e76f826f 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2101,7 +2101,7 @@ } } }, -"revision": "20240706", +"revision": "20240623", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2780,24 +2780,6 @@ ], "type": "string" }, -"otelCollector": { -"description": "Deployment state of otel-collector", -"enum": [ -"DEPLOYMENT_STATE_UNSPECIFIED", -"NOT_INSTALLED", -"INSTALLED", -"ERROR", -"PENDING" -], -"enumDescriptions": [ -"Deployment's state cannot be determined", -"Deployment is not installed", -"Deployment is installed", -"Deployment was attempted to be installed, but has errors", -"Deployment is installing or terminating" -], -"type": "string" -}, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2816,24 +2798,6 @@ ], "type": "string" }, -"resourceGroupControllerManager": { -"description": "Deployment state of resource-group-controller-manager", -"enum": [ -"DEPLOYMENT_STATE_UNSPECIFIED", -"NOT_INSTALLED", -"INSTALLED", -"ERROR", -"PENDING" -], -"enumDescriptions": [ -"Deployment's state cannot be determined", -"Deployment is not installed", -"Deployment is installed", -"Deployment was attempted to be installed, but has errors", -"Deployment is installing or terminating" -], -"type": "string" -}, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -2969,7 +2933,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { -"description": "Version of the deployed admission-webhook pod", +"description": "Version of the deployed admission_webhook pod", "type": "string" }, "gitSync": { @@ -2984,18 +2948,10 @@ "description": "Version of the deployed monitor pod", "type": "string" }, -"otelCollector": { -"description": "Version of the deployed otel-collector pod", -"type": "string" -}, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, -"resourceGroupControllerManager": { -"description": "Version of the deployed resource-group-controller-manager pod", -"type": "string" -}, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -6374,7 +6330,7 @@ "type": "string" }, "management": { -"description": "Optional. Enables automatic Service Mesh management.", +"description": "Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json index 2cd819642ce..c74f7213e6c 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta1.json @@ -712,7 +712,7 @@ } } }, -"revision": "20240706", +"revision": "20240623", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "ApplianceCluster": { diff --git a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json index c98f4c31b47..91219b63ec2 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v2alpha.json @@ -280,7 +280,7 @@ } } }, -"revision": "20240706", +"revision": "20240623", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index f629d8a1d7a..5e59feb4f3b 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -3077,7 +3077,7 @@ } } }, -"revision": "20240708", +"revision": "20240701", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json index 1534d44cd70..60efb0d4522 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1.json @@ -265,7 +265,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json index d6e55647767..d842d4f6273 100644 --- a/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/gmailpostmastertools.v1beta1.json @@ -265,7 +265,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://gmailpostmastertools.googleapis.com/", "schemas": { "DeliveryError": { diff --git a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json index 8c13aedb472..b37910d5831 100644 --- a/googleapiclient/discovery_cache/documents/groupsmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/groupsmigration.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240708", +"revision": "20240701", "rootUrl": "https://groupsmigration.googleapis.com/", "schemas": { "Groups": { diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index 887325f430a..f2224a0a9c9 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -3056,6 +3056,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"patch": { +"description": "Patches a ServiceAccountKey.", +"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:patch", +"httpMethod": "POST", +"id": "iam.projects.serviceAccounts.keys.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.", +"location": "path", +"pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:patch", +"request": { +"$ref": "PatchServiceAccountKeyRequest" +}, +"response": { +"$ref": "ServiceAccountKey" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "upload": { "description": "Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys:upload", @@ -3188,7 +3216,7 @@ } } }, -"revision": "20240711", +"revision": "20240703", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4243,6 +4271,22 @@ }, "type": "object" }, +"PatchServiceAccountKeyRequest": { +"description": "The service account key patch request.", +"id": "PatchServiceAccountKeyRequest", +"properties": { +"serviceAccountKey": { +"$ref": "ServiceAccountKey", +"description": "Required. The service account key to update." +}, +"updateMask": { +"description": "Required. The update mask to apply to the service account key. Only the following fields are eligible for patching: - contact - description", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, "PatchServiceAccountRequest": { "description": "The service account patch request. You can patch only the `display_name` and `description` fields. You must use the `update_mask` field to specify which of these fields you want to patch. Only the fields specified in the request are guaranteed to be returned in the response. Other fields may be empty in the response.", "id": "PatchServiceAccountRequest", @@ -4647,6 +4691,19 @@ false "description": "Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.", "id": "ServiceAccountKey", "properties": { +"contact": { +"description": "Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.", +"type": "string" +}, +"creator": { +"description": "Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Optional. A user provided description of this service account key.", +"type": "string" +}, "disableReason": { "description": "Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/iam.v2.json b/googleapiclient/discovery_cache/documents/iam.v2.json index 68cad3e3680..5d948ea002a 100644 --- a/googleapiclient/discovery_cache/documents/iam.v2.json +++ b/googleapiclient/discovery_cache/documents/iam.v2.json @@ -293,7 +293,7 @@ } } }, -"revision": "20240711", +"revision": "20240703", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/iam.v2beta.json b/googleapiclient/discovery_cache/documents/iam.v2beta.json index 107b4adaa8e..097484ad39c 100644 --- a/googleapiclient/discovery_cache/documents/iam.v2beta.json +++ b/googleapiclient/discovery_cache/documents/iam.v2beta.json @@ -293,7 +293,7 @@ } } }, -"revision": "20240711", +"revision": "20240703", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { diff --git a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json index 43df9abedb7..b62e5323987 100644 --- a/googleapiclient/discovery_cache/documents/iamcredentials.v1.json +++ b/googleapiclient/discovery_cache/documents/iamcredentials.v1.json @@ -226,7 +226,7 @@ } } }, -"revision": "20240701", +"revision": "20240624", "rootUrl": "https://iamcredentials.googleapis.com/", "schemas": { "GenerateAccessTokenRequest": { diff --git a/googleapiclient/discovery_cache/documents/iap.v1.json b/googleapiclient/discovery_cache/documents/iap.v1.json index ca96b9ea1dc..8c09f4fc4ed 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1.json @@ -682,7 +682,7 @@ } } }, -"revision": "20240708", +"revision": "20240701", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { diff --git a/googleapiclient/discovery_cache/documents/iap.v1beta1.json b/googleapiclient/discovery_cache/documents/iap.v1beta1.json index e7f06deb581..44cd435ad6c 100644 --- a/googleapiclient/discovery_cache/documents/iap.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/iap.v1beta1.json @@ -194,7 +194,7 @@ } } }, -"revision": "20240708", +"revision": "20240701", "rootUrl": "https://iap.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json index 4705d8fe7d0..948b1242b2c 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v1.json @@ -1239,7 +1239,7 @@ } } }, -"revision": "20240703", +"revision": "20240621", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitV1Argon2Parameters": { diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json index 45d1707e0f3..4b4e557e34a 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v2.json @@ -1655,7 +1655,7 @@ } } }, -"revision": "20240703", +"revision": "20240621", "rootUrl": "https://identitytoolkit.googleapis.com/", "schemas": { "GoogleCloudIdentitytoolkitAdminV2AllowByDefault": { diff --git a/googleapiclient/discovery_cache/documents/indexing.v3.json b/googleapiclient/discovery_cache/documents/indexing.v3.json index a5c07d80456..5b3fda7e6d3 100644 --- a/googleapiclient/discovery_cache/documents/indexing.v3.json +++ b/googleapiclient/discovery_cache/documents/indexing.v3.json @@ -149,7 +149,7 @@ } } }, -"revision": "20240709", +"revision": "20240702", "rootUrl": "https://indexing.googleapis.com/", "schemas": { "PublishUrlNotificationResponse": { diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json index c78156aaa25..b3659d17e3e 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1.json @@ -4140,7 +4140,7 @@ } } }, -"revision": "20240715", +"revision": "20240701", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -11100,20 +11100,16 @@ false "description": "Request to Import template", "id": "GoogleCloudIntegrationsV1alphaImportTemplateRequest", "properties": { +"configParameters": { +"description": "Optional. Config parameters which would be used to configure template bundles.", +"items": { +"$ref": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter" +}, +"type": "array" +}, "integration": { "description": "Required. Name of the integration where template needs to be imported.", "type": "string" -}, -"integrationRegion": { -"description": "Required. The region of the Integration to be created.", -"type": "string" -}, -"subIntegrations": { -"additionalProperties": { -"$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails" -}, -"description": "Optional. Sub Integration which would be created via templates.", -"type": "object" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/keep.v1.json b/googleapiclient/discovery_cache/documents/keep.v1.json index 181542b5671..edc6de62f56 100644 --- a/googleapiclient/discovery_cache/documents/keep.v1.json +++ b/googleapiclient/discovery_cache/documents/keep.v1.json @@ -314,7 +314,7 @@ } } }, -"revision": "20240711", +"revision": "20240702", "rootUrl": "https://keep.googleapis.com/", "schemas": { "Attachment": { diff --git a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json index 0db2ca3b09f..54034e64bc7 100644 --- a/googleapiclient/discovery_cache/documents/kmsinventory.v1.json +++ b/googleapiclient/discovery_cache/documents/kmsinventory.v1.json @@ -242,7 +242,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://kmsinventory.googleapis.com/", "schemas": { "GoogleCloudKmsInventoryV1ListCryptoKeysResponse": { diff --git a/googleapiclient/discovery_cache/documents/language.v1.json b/googleapiclient/discovery_cache/documents/language.v1.json index e288f7b668c..fa7212842f2 100644 --- a/googleapiclient/discovery_cache/documents/language.v1.json +++ b/googleapiclient/discovery_cache/documents/language.v1.json @@ -246,7 +246,7 @@ } } }, -"revision": "20240713", +"revision": "20240623", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -757,7 +757,6 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", -"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1043,7 +1042,6 @@ "", "", "", -"", "" ], "type": "string" @@ -1476,7 +1474,6 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", -"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1762,7 +1759,6 @@ "", "", "", -"", "" ], "type": "string" @@ -2154,7 +2150,6 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", -"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2440,7 +2435,6 @@ "", "", "", -"", "" ], "type": "string" @@ -3622,7 +3616,6 @@ false "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", -"NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3639,7 +3632,6 @@ false "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", -"Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/googleapiclient/discovery_cache/documents/language.v1beta2.json b/googleapiclient/discovery_cache/documents/language.v1beta2.json index 1378c3c1013..deff06dd8df 100644 --- a/googleapiclient/discovery_cache/documents/language.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/language.v1beta2.json @@ -246,7 +246,7 @@ } } }, -"revision": "20240713", +"revision": "20240623", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -757,7 +757,6 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", -"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1043,7 +1042,6 @@ "", "", "", -"", "" ], "type": "string" @@ -1494,7 +1492,6 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", -"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1780,7 +1777,6 @@ "", "", "", -"", "" ], "type": "string" @@ -2172,7 +2168,6 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", -"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -2458,7 +2453,6 @@ "", "", "", -"", "" ], "type": "string" @@ -3640,7 +3634,6 @@ false "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", -"NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -3657,7 +3650,6 @@ false "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", -"Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/googleapiclient/discovery_cache/documents/language.v2.json b/googleapiclient/discovery_cache/documents/language.v2.json index a4cec0fd65b..953f6354d5c 100644 --- a/googleapiclient/discovery_cache/documents/language.v2.json +++ b/googleapiclient/discovery_cache/documents/language.v2.json @@ -208,7 +208,7 @@ } } }, -"revision": "20240713", +"revision": "20240623", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -577,7 +577,6 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", -"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -863,7 +862,6 @@ "", "", "", -"", "" ], "type": "string" @@ -1110,7 +1108,6 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", -"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1396,7 +1393,6 @@ "", "", "", -"", "" ], "type": "string" @@ -1529,7 +1525,6 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", -"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1815,7 +1810,6 @@ "", "", "", -"", "" ], "type": "string" @@ -2974,7 +2968,6 @@ false "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", -"NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -2991,7 +2984,6 @@ false "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", -"Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/googleapiclient/discovery_cache/documents/libraryagent.v1.json b/googleapiclient/discovery_cache/documents/libraryagent.v1.json index d91d7ba864a..78548039b50 100644 --- a/googleapiclient/discovery_cache/documents/libraryagent.v1.json +++ b/googleapiclient/discovery_cache/documents/libraryagent.v1.json @@ -279,7 +279,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://libraryagent.googleapis.com/", "schemas": { "GoogleExampleLibraryagentV1Book": { diff --git a/googleapiclient/discovery_cache/documents/licensing.v1.json b/googleapiclient/discovery_cache/documents/licensing.v1.json index 5f63e318a31..37960c515fc 100644 --- a/googleapiclient/discovery_cache/documents/licensing.v1.json +++ b/googleapiclient/discovery_cache/documents/licensing.v1.json @@ -400,7 +400,7 @@ } } }, -"revision": "20240713", +"revision": "20240706", "rootUrl": "https://licensing.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json b/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json index faa66dd12c2..c09dd0ac73a 100644 --- a/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json +++ b/googleapiclient/discovery_cache/documents/lifesciences.v2beta.json @@ -312,7 +312,7 @@ } } }, -"revision": "20240705", +"revision": "20240614", "rootUrl": "https://lifesciences.googleapis.com/", "schemas": { "Accelerator": { diff --git a/googleapiclient/discovery_cache/documents/localservices.v1.json b/googleapiclient/discovery_cache/documents/localservices.v1.json index d50c22f505a..32ed3913b1c 100644 --- a/googleapiclient/discovery_cache/documents/localservices.v1.json +++ b/googleapiclient/discovery_cache/documents/localservices.v1.json @@ -250,7 +250,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://localservices.googleapis.com/", "schemas": { "GoogleAdsHomeservicesLocalservicesV1AccountReport": { diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index 9dde22f0993..55088895965 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -1362,11 +1362,6 @@ "parent" ], "parameters": { -"filter": { -"description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", -"location": "query", -"type": "string" -}, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -2058,7 +2053,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", +"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -3279,11 +3274,6 @@ "parent" ], "parameters": { -"filter": { -"description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", -"location": "query", -"type": "string" -}, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -4710,7 +4700,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", +"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -5931,11 +5921,6 @@ "parent" ], "parameters": { -"filter": { -"description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", -"location": "query", -"type": "string" -}, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -7567,11 +7552,6 @@ "parent" ], "parameters": { -"filter": { -"description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", -"location": "query", -"type": "string" -}, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -8396,7 +8376,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", +"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true, @@ -8424,7 +8404,7 @@ } } }, -"revision": "20240705", +"revision": "20240620", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json index f974c10b5dd..4b7cb8fc405 100644 --- a/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/marketingplatformadmin.v1alpha.json @@ -263,7 +263,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://marketingplatformadmin.googleapis.com/", "schemas": { "AnalyticsAccountLink": { diff --git a/googleapiclient/discovery_cache/documents/meet.v2.json b/googleapiclient/discovery_cache/documents/meet.v2.json index 208aa0e058c..26c8d3453b4 100644 --- a/googleapiclient/discovery_cache/documents/meet.v2.json +++ b/googleapiclient/discovery_cache/documents/meet.v2.json @@ -543,7 +543,7 @@ ] }, "endActiveConference": { -"description": "Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).", +"description": "Ends an active conference (if there's one).", "flatPath": "v2/spaces/{spacesId}:endActiveConference", "httpMethod": "POST", "id": "meet.spaces.endActiveConference", @@ -552,7 +552,7 @@ ], "parameters": { "name": { -"description": "Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", +"description": "Required. Resource name of the space.", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -571,7 +571,7 @@ ] }, "get": { -"description": "Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).", +"description": "Gets a space by `space_id` or `meeting_code`.", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "GET", "id": "meet.spaces.get", @@ -580,7 +580,7 @@ ], "parameters": { "name": { -"description": "Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", +"description": "Required. Resource name of the space.", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -597,7 +597,7 @@ ] }, "patch": { -"description": "Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).", +"description": "Updates a space.", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "PATCH", "id": "meet.spaces.patch", @@ -606,7 +606,7 @@ ], "parameters": { "name": { -"description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", +"description": "Immutable. Resource name of the space. Format: `spaces/{space}`", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -633,7 +633,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://meet.googleapis.com/", "schemas": { "ActiveConference": { @@ -1000,17 +1000,17 @@ "description": "Configuration pertaining to the meeting space." }, "meetingCode": { -"description": "Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space.", +"description": "Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space.", "readOnly": true, "type": "string" }, "meetingUri": { -"description": "Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`.", +"description": "Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`.", "readOnly": true, "type": "string" }, "name": { -"description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", +"description": "Immutable. Resource name of the space. Format: `spaces/{space}`", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/memcache.v1.json b/googleapiclient/discovery_cache/documents/memcache.v1.json index ee516d00584..2a9b2c33f3d 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1.json @@ -584,7 +584,7 @@ } } }, -"revision": "20240702", +"revision": "20240614", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { diff --git a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json index 30d1cacfcda..263a4f12ffa 100644 --- a/googleapiclient/discovery_cache/documents/memcache.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/memcache.v1beta2.json @@ -612,7 +612,7 @@ } } }, -"revision": "20240702", +"revision": "20240614", "rootUrl": "https://memcache.googleapis.com/", "schemas": { "ApplyParametersRequest": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 8de712359b8..6b6fc265255 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -175,191 +175,192 @@ "https://www.googleapis.com/auth/content" ] }, -"list": { -"description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.", -"flatPath": "accounts/v1beta/accounts", +"getBusinessIdentity": { +"description": "Retrieves the business identity of an account.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", "httpMethod": "GET", -"id": "merchantapi.accounts.list", -"parameterOrder": [], +"id": "merchantapi.accounts.getBusinessIdentity", +"parameterOrder": [ +"name" +], "parameters": { -"filter": { -"description": "Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", -"location": "query", +"name": { +"description": "Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", +"location": "path", +"pattern": "^accounts/[^/]+/businessIdentity$", +"required": true, "type": "string" } }, -"path": "accounts/v1beta/accounts", +"path": "accounts/v1beta/{+name}", "response": { -"$ref": "ListAccountsResponse" +"$ref": "BusinessIdentity" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, -"listSubaccounts": { -"description": "List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type=\"ACCOUNT_AGGREGATION\"))`", -"flatPath": "accounts/v1beta/accounts/{accountsId}:listSubaccounts", +"getBusinessInfo": { +"description": "Retrieves the business info of an account.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", "httpMethod": "GET", -"id": "merchantapi.accounts.listSubaccounts", +"id": "merchantapi.accounts.getBusinessInfo", "parameterOrder": [ -"provider" +"name" ], "parameters": { -"pageSize": { -"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"provider": { -"description": "Required. The parent account. Format: `accounts/{account}`", +"name": { +"description": "Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`", "location": "path", -"pattern": "^accounts/[^/]+$", +"pattern": "^accounts/[^/]+/businessInfo$", "required": true, "type": "string" } }, -"path": "accounts/v1beta/{+provider}:listSubaccounts", +"path": "accounts/v1beta/{+name}", "response": { -"$ref": "ListSubAccountsResponse" +"$ref": "BusinessInfo" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, -"patch": { -"description": "Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.", -"flatPath": "accounts/v1beta/accounts/{accountsId}", -"httpMethod": "PATCH", -"id": "merchantapi.accounts.patch", +"getHomepage": { +"description": "Retrieves a store's homepage.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", +"httpMethod": "GET", +"id": "merchantapi.accounts.getHomepage", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name of the account. Format: `accounts/{account}`", +"description": "Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`", "location": "path", -"pattern": "^accounts/[^/]+$", +"pattern": "^accounts/[^/]+/homepage$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. List of fields being updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "accounts/v1beta/{+name}", -"request": { -"$ref": "Account" -}, "response": { -"$ref": "Account" +"$ref": "Homepage" }, "scopes": [ "https://www.googleapis.com/auth/content" ] -} }, -"resources": { -"accounttax": { -"methods": { -"get": { -"description": "Returns the tax rules that match the conditions of GetAccountTaxRequest", -"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", +"getShippingSettings": { +"description": "Retrieve shipping setting information.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings", "httpMethod": "GET", -"id": "merchantapi.accounts.accounttax.get", +"id": "merchantapi.accounts.getShippingSettings", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name from which tax settings will be retrieved", +"description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`", "location": "path", -"pattern": "^accounts/[^/]+/accounttax/[^/]+$", +"pattern": "^accounts/[^/]+/shippingSettings$", "required": true, "type": "string" } }, "path": "accounts/v1beta/{+name}", "response": { -"$ref": "AccountTax" +"$ref": "ShippingSettings" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, "list": { -"description": "Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax", +"description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.", +"flatPath": "accounts/v1beta/accounts", "httpMethod": "GET", -"id": "merchantapi.accounts.accounttax.list", +"id": "merchantapi.accounts.list", +"parameterOrder": [], +"parameters": { +"filter": { +"description": "Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", +"location": "query", +"type": "string" +} +}, +"path": "accounts/v1beta/accounts", +"response": { +"$ref": "ListAccountsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"listSubaccounts": { +"description": "List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type=\"ACCOUNT_AGGREGATION\"))`", +"flatPath": "accounts/v1beta/accounts/{accountsId}:listSubaccounts", +"httpMethod": "GET", +"id": "merchantapi.accounts.listSubaccounts", "parameterOrder": [ -"parent" +"provider" ], "parameters": { "pageSize": { -"description": "The maximum number of tax settings to return in the response, used for paging.", +"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The token returned by the previous request.", +"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", "location": "query", "type": "string" }, -"parent": { -"description": "Required. The parent, which owns this collection of account tax. Format: accounts/{account}", +"provider": { +"description": "Required. The parent account. Format: `accounts/{account}`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, "type": "string" } }, -"path": "accounts/v1beta/{+parent}/accounttax", +"path": "accounts/v1beta/{+provider}:listSubaccounts", "response": { -"$ref": "ListAccountTaxResponse" +"$ref": "ListSubAccountsResponse" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, "patch": { -"description": "Updates the tax settings of the account.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", +"description": "Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.", +"flatPath": "accounts/v1beta/accounts/{accountsId}", "httpMethod": "PATCH", -"id": "merchantapi.accounts.accounttax.patch", +"id": "merchantapi.accounts.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The name of the tax setting. Format: \"{account_tax.name=accounts/{account}}\"", +"description": "Identifier. The resource name of the account. Format: `accounts/{account}`", "location": "path", -"pattern": "^accounts/[^/]+/accounttax/[^/]+$", +"pattern": "^accounts/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated", +"description": "Required. List of fields being updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -367,39 +368,10 @@ }, "path": "accounts/v1beta/{+name}", "request": { -"$ref": "AccountTax" -}, -"response": { -"$ref": "AccountTax" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -} -} -}, -"businessIdentity": { -"methods": { -"getBusinessIdentity": { -"description": "Retrieves the business identity of an account.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", -"httpMethod": "GET", -"id": "merchantapi.accounts.businessIdentity.getBusinessIdentity", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", -"location": "path", -"pattern": "^accounts/[^/]+/businessIdentity$", -"required": true, -"type": "string" -} +"$ref": "Account" }, -"path": "accounts/v1beta/{+name}", "response": { -"$ref": "BusinessIdentity" +"$ref": "Account" }, "scopes": [ "https://www.googleapis.com/auth/content" @@ -409,7 +381,7 @@ "description": "Updates the business identity of an account. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", "httpMethod": "PATCH", -"id": "merchantapi.accounts.businessIdentity.updateBusinessIdentity", +"id": "merchantapi.accounts.updateBusinessIdentity", "parameterOrder": [ "name" ], @@ -438,29 +410,34 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] -} -} }, -"businessInfo": { -"methods": { -"getBusinessInfo": { -"description": "Retrieves the business info of an account.", +"updateBusinessInfo": { +"description": "Updates the business info of an account. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", -"httpMethod": "GET", -"id": "merchantapi.accounts.businessInfo.getBusinessInfo", +"httpMethod": "PATCH", +"id": "merchantapi.accounts.updateBusinessInfo", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`", +"description": "Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`", "location": "path", "pattern": "^accounts/[^/]+/businessInfo$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Required. List of fields being updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "accounts/v1beta/{+name}", +"request": { +"$ref": "BusinessInfo" +}, "response": { "$ref": "BusinessInfo" }, @@ -468,19 +445,19 @@ "https://www.googleapis.com/auth/content" ] }, -"updateBusinessInfo": { -"description": "Updates the business info of an account. Executing this method requires admin access.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", +"updateHomepage": { +"description": "Updates a store's homepage. Executing this method requires admin access.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", "httpMethod": "PATCH", -"id": "merchantapi.accounts.businessInfo.updateBusinessInfo", +"id": "merchantapi.accounts.updateHomepage", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`", +"description": "Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`", "location": "path", -"pattern": "^accounts/[^/]+/businessInfo$", +"pattern": "^accounts/[^/]+/homepage$", "required": true, "type": "string" }, @@ -493,62 +470,98 @@ }, "path": "accounts/v1beta/{+name}", "request": { -"$ref": "BusinessInfo" +"$ref": "Homepage" }, "response": { -"$ref": "BusinessInfo" +"$ref": "Homepage" }, "scopes": [ "https://www.googleapis.com/auth/content" ] } -} }, -"emailpreferences": { +"resources": { +"accounttax": { "methods": { -"getEmailPreferences": { -"description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", +"get": { +"description": "Returns the tax rules that match the conditions of GetAccountTaxRequest", +"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", "httpMethod": "GET", -"id": "merchantapi.accounts.emailpreferences.getEmailPreferences", +"id": "merchantapi.accounts.accounttax.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`", +"description": "Required. The name from which tax settings will be retrieved", "location": "path", -"pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", +"pattern": "^accounts/[^/]+/accounttax/[^/]+$", "required": true, "type": "string" } }, "path": "accounts/v1beta/{+name}", "response": { -"$ref": "EmailPreferences" +"$ref": "AccountTax" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, -"updateEmailPreferences": { -"description": "Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", +"list": { +"description": "Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax", +"httpMethod": "GET", +"id": "merchantapi.accounts.accounttax.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of tax settings to return in the response, used for paging.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The token returned by the previous request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of account tax. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "accounts/v1beta/{+parent}/accounttax", +"response": { +"$ref": "ListAccountTaxResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"patch": { +"description": "Updates the tax settings of the account.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", "httpMethod": "PATCH", -"id": "merchantapi.accounts.emailpreferences.updateEmailPreferences", +"id": "merchantapi.accounts.accounttax.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.", +"description": "Identifier. The name of the tax setting. Format: \"{account_tax.name=accounts/{account}}\"", "location": "path", -"pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", +"pattern": "^accounts/[^/]+/accounttax/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "The list of fields to be updated", "format": "google-fieldmask", "location": "query", "type": "string" @@ -556,10 +569,10 @@ }, "path": "accounts/v1beta/{+name}", "request": { -"$ref": "EmailPreferences" +"$ref": "AccountTax" }, "response": { -"$ref": "EmailPreferences" +"$ref": "AccountTax" }, "scopes": [ "https://www.googleapis.com/auth/content" @@ -597,31 +610,6 @@ "https://www.googleapis.com/auth/content" ] }, -"getHomepage": { -"description": "Retrieves a store's homepage.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", -"httpMethod": "GET", -"id": "merchantapi.accounts.homepage.getHomepage", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`", -"location": "path", -"pattern": "^accounts/[^/]+/homepage$", -"required": true, -"type": "string" -} -}, -"path": "accounts/v1beta/{+name}", -"response": { -"$ref": "Homepage" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, "unclaim": { "description": "Unclaims a store's homepage. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage:unclaim", @@ -649,40 +637,6 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] -}, -"updateHomepage": { -"description": "Updates a store's homepage. Executing this method requires admin access.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", -"httpMethod": "PATCH", -"id": "merchantapi.accounts.homepage.updateHomepage", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`", -"location": "path", -"pattern": "^accounts/[^/]+/homepage$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. List of fields being updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "accounts/v1beta/{+name}", -"request": { -"$ref": "Homepage" -}, -"response": { -"$ref": "Homepage" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] } } }, @@ -1086,31 +1040,6 @@ }, "shippingSettings": { "methods": { -"getShippingSettings": { -"description": "Retrieve shipping setting information.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings", -"httpMethod": "GET", -"id": "merchantapi.accounts.shippingSettings.getShippingSettings", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`", -"location": "path", -"pattern": "^accounts/[^/]+/shippingSettings$", -"required": true, -"type": "string" -} -}, -"path": "accounts/v1beta/{+name}", -"response": { -"$ref": "ShippingSettings" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, "insert": { "description": "Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings:insert", @@ -1153,7 +1082,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}`", +"description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", "location": "path", "pattern": "^accounts/[^/]+/termsOfServiceAgreementStates/[^/]+$", "required": true, @@ -1280,6 +1209,31 @@ "https://www.googleapis.com/auth/content" ] }, +"getEmailPreferences": { +"description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", +"httpMethod": "GET", +"id": "merchantapi.accounts.users.getEmailPreferences", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`", +"location": "path", +"pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", +"required": true, +"type": "string" +} +}, +"path": "accounts/v1beta/{+name}", +"response": { +"$ref": "EmailPreferences" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, "list": { "description": "Lists all users of a Merchant Center account.", "flatPath": "accounts/v1beta/accounts/{accountsId}/users", @@ -1349,6 +1303,40 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] +}, +"updateEmailPreferences": { +"description": "Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", +"httpMethod": "PATCH", +"id": "merchantapi.accounts.users.updateEmailPreferences", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.", +"location": "path", +"pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. List of fields being updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "accounts/v1beta/{+name}", +"request": { +"$ref": "EmailPreferences" +}, +"response": { +"$ref": "EmailPreferences" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] } } } @@ -1453,7 +1441,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfService": { @@ -3358,7 +3346,7 @@ false "description": "The accepted terms of service of this kind and for the associated region_code" }, "name": { -"description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US`", +"description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", "type": "string" }, "regionCode": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json index 7488ad138d2..e2a84102000 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.conversions_v1beta.json @@ -295,7 +295,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AttributionSettings": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json index 92b9e00a20e..27cad1e815b 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json @@ -290,7 +290,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json index e0018c50c9c..46cdcd1beab 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.inventories_v1beta.json @@ -300,7 +300,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "CustomAttribute": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json index 912ec5199d8..f4f4dad416d 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.lfp_v1beta.json @@ -298,7 +298,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json index 3a9616081bc..9d09df492f6 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.notifications_v1beta.json @@ -262,7 +262,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index 62b3f59afbd..d0044bb752d 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -242,7 +242,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json index 82e5bf51e34..4ca4608eb9f 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.promotions_v1beta.json @@ -203,7 +203,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json index eeb606fdd8c..91012bc8d5e 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.quota_v1beta.json @@ -150,7 +150,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "ListQuotaGroupsResponse": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json index 3b61bd8a797..3ce5185fb3d 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.reports_v1beta.json @@ -142,7 +142,7 @@ } } }, -"revision": "20240712", +"revision": "20240614", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "BestSellersBrandView": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1.json b/googleapiclient/discovery_cache/documents/metastore.v1.json index 5dfec98dd7c..82e220ab775 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1.json @@ -1684,7 +1684,7 @@ } } }, -"revision": "20240709", +"revision": "20240627", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2060,31 +2060,6 @@ }, "type": "object" }, -"CustomRegionMetadata": { -"description": "Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", -"id": "CustomRegionMetadata", -"properties": { -"optionalReadOnlyRegions": { -"description": "The read-only regions for this custom region.", -"items": { -"type": "string" -}, -"type": "array" -}, -"requiredReadWriteRegions": { -"description": "The read-write regions for this custom region.", -"items": { -"type": "string" -}, -"type": "array" -}, -"witnessRegion": { -"description": "The Spanner witness region for this custom region.", -"type": "string" -} -}, -"type": "object" -}, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2633,13 +2608,6 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { -"customRegionMetadata": { -"description": "Possible configurations supported if the current region is a custom region.", -"items": { -"$ref": "CustomRegionMetadata" -}, -"type": "array" -}, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3395,7 +3363,6 @@ "UPDATING", "DELETING", "ERROR", -"AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3407,7 +3374,6 @@ "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", -"The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index 63079b507c7..49ed2613674 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -1796,7 +1796,7 @@ } } }, -"revision": "20240709", +"revision": "20240627", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2196,52 +2196,6 @@ }, "type": "object" }, -"CustomRegionConfig": { -"description": "Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.", -"id": "CustomRegionConfig", -"properties": { -"readOnlyRegions": { -"description": "Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", -"items": { -"type": "string" -}, -"type": "array" -}, -"readWriteRegions": { -"description": "Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"CustomRegionMetadata": { -"description": "Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", -"id": "CustomRegionMetadata", -"properties": { -"optionalReadOnlyRegions": { -"description": "The read-only regions for this custom region.", -"items": { -"type": "string" -}, -"type": "array" -}, -"requiredReadWriteRegions": { -"description": "The read-write regions for this custom region.", -"items": { -"type": "string" -}, -"type": "array" -}, -"witnessRegion": { -"description": "The Spanner witness region for this custom region.", -"type": "string" -} -}, -"type": "object" -}, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2815,13 +2769,6 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { -"customRegionMetadata": { -"description": "Possible configurations supported if the current region is a custom region.", -"items": { -"$ref": "CustomRegionMetadata" -}, -"type": "array" -}, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3124,25 +3071,6 @@ "properties": {}, "type": "object" }, -"MultiRegionConfig": { -"description": "The multi-region config for the Dataproc Metastore service.", -"id": "MultiRegionConfig", -"properties": { -"certificates": { -"deprecated": true, -"description": "Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.", -"items": { -"$ref": "RootCACertificate" -}, -"readOnly": true, -"type": "array" -}, -"customRegionConfig": { -"$ref": "CustomRegionConfig" -} -}, -"type": "object" -}, "MultiRegionMetadata": { "description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty.", "id": "MultiRegionMetadata", @@ -3429,25 +3357,6 @@ }, "type": "object" }, -"RootCACertificate": { -"deprecated": true, -"description": "A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.", -"id": "RootCACertificate", -"properties": { -"certificate": { -"deprecated": true, -"description": "The root CA certificate in PEM format. The maximum length is 65536 bytes.", -"type": "string" -}, -"expirationTime": { -"deprecated": true, -"description": "The certificate expiration time in timestamp format.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, "ScalingConfig": { "description": "Represents the scaling configuration of a metastore service.", "id": "ScalingConfig", @@ -3595,10 +3504,6 @@ "description": "Output only. The metadata management activities of the metastore service.", "readOnly": true }, -"multiRegionConfig": { -"$ref": "MultiRegionConfig", -"description": "Optional. Specifies the multi-region configuration information for the Hive metastore service." -}, "name": { "description": "Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string" @@ -3649,7 +3554,6 @@ "UPDATING", "DELETING", "ERROR", -"AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3661,7 +3565,6 @@ "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", -"The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json index e1c3813edb4..901074b74a1 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json @@ -1796,7 +1796,7 @@ } } }, -"revision": "20240709", +"revision": "20240627", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2196,52 +2196,6 @@ }, "type": "object" }, -"CustomRegionConfig": { -"description": "Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.", -"id": "CustomRegionConfig", -"properties": { -"readOnlyRegions": { -"description": "Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", -"items": { -"type": "string" -}, -"type": "array" -}, -"readWriteRegions": { -"description": "Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"CustomRegionMetadata": { -"description": "Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", -"id": "CustomRegionMetadata", -"properties": { -"optionalReadOnlyRegions": { -"description": "The read-only regions for this custom region.", -"items": { -"type": "string" -}, -"type": "array" -}, -"requiredReadWriteRegions": { -"description": "The read-write regions for this custom region.", -"items": { -"type": "string" -}, -"type": "array" -}, -"witnessRegion": { -"description": "The Spanner witness region for this custom region.", -"type": "string" -} -}, -"type": "object" -}, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2815,13 +2769,6 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { -"customRegionMetadata": { -"description": "Possible configurations supported if the current region is a custom region.", -"items": { -"$ref": "CustomRegionMetadata" -}, -"type": "array" -}, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3124,25 +3071,6 @@ "properties": {}, "type": "object" }, -"MultiRegionConfig": { -"description": "The multi-region config for the Dataproc Metastore service.", -"id": "MultiRegionConfig", -"properties": { -"certificates": { -"deprecated": true, -"description": "Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.", -"items": { -"$ref": "RootCACertificate" -}, -"readOnly": true, -"type": "array" -}, -"customRegionConfig": { -"$ref": "CustomRegionConfig" -} -}, -"type": "object" -}, "MultiRegionMetadata": { "description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty.", "id": "MultiRegionMetadata", @@ -3429,25 +3357,6 @@ }, "type": "object" }, -"RootCACertificate": { -"deprecated": true, -"description": "A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.", -"id": "RootCACertificate", -"properties": { -"certificate": { -"deprecated": true, -"description": "The root CA certificate in PEM format. The maximum length is 65536 bytes.", -"type": "string" -}, -"expirationTime": { -"deprecated": true, -"description": "The certificate expiration time in timestamp format.", -"format": "google-datetime", -"type": "string" -} -}, -"type": "object" -}, "ScalingConfig": { "description": "Represents the scaling configuration of a metastore service.", "id": "ScalingConfig", @@ -3595,10 +3504,6 @@ "description": "Output only. The metadata management activities of the metastore service.", "readOnly": true }, -"multiRegionConfig": { -"$ref": "MultiRegionConfig", -"description": "Optional. Specifies the multi-region configuration information for the Hive metastore service." -}, "name": { "description": "Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string" @@ -3649,7 +3554,6 @@ "UPDATING", "DELETING", "ERROR", -"AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3661,7 +3565,6 @@ "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", -"The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json index 866919c6f43..6fc768ecff9 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1.json @@ -2309,7 +2309,7 @@ } } }, -"revision": "20240704", +"revision": "20240625", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index b1f9a6e5b5e..f2608477091 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2473,7 +2473,7 @@ } } }, -"revision": "20240704", +"revision": "20240625", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3443,7 +3443,7 @@ "enumDescriptions": [ "Unspecified (default value).", "Default Google Cloud licensing plan. Licensing is charged per usage. This a good value to start with.", -"Bring-your-own-license (BYOL) plan. User provides the license." +"Bring-your-own-license (BYOL) plan. User provides the OS license." ], "type": "string" }, @@ -6255,7 +6255,7 @@ false "type": "string" }, "licenseType": { -"description": "Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).", +"description": "Optional. License type of the OS image.", "enum": [ "LICENSE_TYPE_UNSPECIFIED", "LICENSE_TYPE_DEFAULT", @@ -6264,7 +6264,7 @@ false "enumDescriptions": [ "Unspecified (default value).", "Default Google Cloud licensing plan. Licensing is charged per usage. This a good value to start with.", -"Bring-your-own-license (BYOL) plan. User provides the license." +"Bring-your-own-license (BYOL) plan. User provides the OS license." ], "type": "string" } @@ -8296,9 +8296,7 @@ false "COMMITMENT_1_YEAR_MONTHLY_PAYMENTS", "COMMITMENT_3_YEAR_MONTHLY_PAYMENTS", "COMMITMENT_1_YEAR_UPFRONT_PAYMENT", -"COMMITMENT_3_YEAR_UPFRONT_PAYMENT", -"COMMITMENT_FLEXIBLE_3_YEAR_MONTHLY_PAYMENTS", -"COMMITMENT_FLEXIBLE_3_YEAR_UPFRONT_PAYMENT" +"COMMITMENT_3_YEAR_UPFRONT_PAYMENT" ], "enumDescriptions": [ "Unspecified commitment plan.", @@ -8306,9 +8304,7 @@ false "1 year commitment (monthly payments).", "3 year commitment (monthly payments).", "1 year commitment (upfront payment).", -"3 years commitment (upfront payment).", -"3-year flexible commitment (monthly payments). While not supported in the v1 API, this value is converted to UNSPECIFIED in conversions to the v1 API.", -"3-year flexible commitment (upfront payment). While not supported in the v1 API, this value is converted to UNSPECIFIED in conversions to the v1 API." +"3 years commitment (upfront payment)." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index 8d5237871ee..e1899b35c05 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -753,7 +753,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1356,9 +1356,7 @@ "CLOUD_SQL_FAILOVER", "CLOUD_SQL_START_STOP", "CLOUD_SQL_STORAGE", -"UPTIME_CHECK_FAILURE", -"CLOUD_ALERTING_ALERT", -"SERVICE_HEALTH_INCIDENT" +"UPTIME_CHECK_FAILURE" ], "enumDescriptions": [ "No event type specified.", @@ -1380,9 +1378,7 @@ "Failover of a Cloud SQL instance.", "Start/stop of a Cloud SQL instance.", "Storage event for a Cloud SQL instance.", -"Failure of a Cloud Monitoring uptime check.", -"Alerts from Cloud Alerting", -"Incidents from Service Health" +"Failure of a Cloud Monitoring uptime check." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index 8861b3e8d72..c6fa3c6e576 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -2714,7 +2714,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json index 3a6d27915a4..1da0081c65e 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessaccountmanagement.v1.json @@ -530,7 +530,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://mybusinessaccountmanagement.googleapis.com/", "schemas": { "AcceptInvitationRequest": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json index a71627d296b..ce212883df7 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessbusinessinformation.v1.json @@ -612,7 +612,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://mybusinessbusinessinformation.googleapis.com/", "schemas": { "AdWordsLocationExtensions": { diff --git a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json index 60ac0ac3d4b..c6cfe84267e 100644 --- a/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinesslodging.v1.json @@ -194,7 +194,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://mybusinesslodging.googleapis.com/", "schemas": { "Accessibility": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json index b24ca1fe235..cb516fe8dca 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessnotifications.v1.json @@ -154,7 +154,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://mybusinessnotifications.googleapis.com/", "schemas": { "NotificationSetting": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json index c66551e8a54..c47e0f5885f 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessplaceactions.v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://mybusinessplaceactions.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json index 98326550e66..71630815f27 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessqanda.v1.json @@ -323,7 +323,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://mybusinessqanda.googleapis.com/", "schemas": { "Answer": { diff --git a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json index 6d30ae4ef3c..2ebf6ae0454 100644 --- a/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json +++ b/googleapiclient/discovery_cache/documents/mybusinessverifications.v1.json @@ -237,7 +237,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://mybusinessverifications.googleapis.com/", "schemas": { "AddressVerificationData": { diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index 7c6c008aa17..55b833c8a4d 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -2812,7 +2812,7 @@ } } }, -"revision": "20240707", +"revision": "20240624", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json index f3513d5cc2d..25b7081eef2 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json @@ -1116,7 +1116,7 @@ } } }, -"revision": "20240707", +"revision": "20240624", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 395d27e1c96..931c618bf10 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -535,6 +535,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:getIamPolicy", +"httpMethod": "GET", +"id": "networkservices.projects.locations.endpointPolicies.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists EndpointPolicies in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", @@ -604,6 +635,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:setIamPolicy", +"httpMethod": "POST", +"id": "networkservices.projects.locations.endpointPolicies.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:testIamPermissions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.endpointPolicies.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -692,6 +779,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy", +"httpMethod": "GET", +"id": "networkservices.projects.locations.gateways.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists Gateways in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways", @@ -761,6 +879,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy", +"httpMethod": "POST", +"id": "networkservices.projects.locations.gateways.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.gateways.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -1527,6 +1701,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy", +"httpMethod": "GET", +"id": "networkservices.projects.locations.meshes.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists Meshes in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes", @@ -1596,6 +1801,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy", +"httpMethod": "POST", +"id": "networkservices.projects.locations.meshes.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.meshes.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -1807,6 +2068,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy", +"httpMethod": "GET", +"id": "networkservices.projects.locations.serviceBindings.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists ServiceBinding in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings", @@ -1842,6 +2134,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy", +"httpMethod": "POST", +"id": "networkservices.projects.locations.serviceBindings.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.serviceBindings.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -2408,7 +2756,7 @@ } } }, -"revision": "20240707", +"revision": "20240626", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index 806e9ded696..d43cffcc44c 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -262,6 +262,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:getIamPolicy", +"httpMethod": "GET", +"id": "networkservices.projects.locations.endpointPolicies.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists EndpointPolicies in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", @@ -331,6 +362,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:setIamPolicy", +"httpMethod": "POST", +"id": "networkservices.projects.locations.endpointPolicies.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:testIamPermissions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.endpointPolicies.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -419,6 +506,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy", +"httpMethod": "GET", +"id": "networkservices.projects.locations.gateways.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists Gateways in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways", @@ -488,6 +606,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy", +"httpMethod": "POST", +"id": "networkservices.projects.locations.gateways.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.gateways.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -1254,6 +1428,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy", +"httpMethod": "GET", +"id": "networkservices.projects.locations.meshes.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists Meshes in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes", @@ -1323,6 +1528,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy", +"httpMethod": "POST", +"id": "networkservices.projects.locations.meshes.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.meshes.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -1534,6 +1795,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy", +"httpMethod": "GET", +"id": "networkservices.projects.locations.serviceBindings.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists ServiceBinding in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings", @@ -1569,6 +1861,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy", +"httpMethod": "POST", +"id": "networkservices.projects.locations.serviceBindings.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions", +"httpMethod": "POST", +"id": "networkservices.projects.locations.serviceBindings.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } }, @@ -2135,7 +2483,7 @@ } } }, -"revision": "20240707", +"revision": "20240626", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v1.json b/googleapiclient/discovery_cache/documents/notebooks.v1.json index 4badac97d95..9db18ee9a05 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v1.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v1.json @@ -2008,7 +2008,7 @@ } } }, -"revision": "20240626", +"revision": "20240613", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/notebooks.v2.json b/googleapiclient/discovery_cache/documents/notebooks.v2.json index d4c6f549b48..227ed7c4fea 100644 --- a/googleapiclient/discovery_cache/documents/notebooks.v2.json +++ b/googleapiclient/discovery_cache/documents/notebooks.v2.json @@ -876,7 +876,7 @@ } } }, -"revision": "20240626", +"revision": "20240613", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index b2c0393fb28..58952eb054e 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240709", +"revision": "20240624", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1110,6 +1110,10 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." +}, +"vulnerabilityAttestation": { +"$ref": "VulnerabilityAttestation", +"description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -2842,6 +2846,36 @@ }, "type": "object" }, +"VulnerabilityAttestation": { +"description": "The status of an vulnerability attestation generation.", +"id": "VulnerabilityAttestation", +"properties": { +"error": { +"description": "If failure, the error reason for why the attestation generation failed.", +"type": "string" +}, +"lastAttemptTime": { +"description": "The last time we attempted to generate an attestation.", +"format": "google-datetime", +"type": "string" +}, +"state": { +"description": "The success/failure state of the latest attestation attempt.", +"enum": [ +"VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", +"SUCCESS", +"FAILURE" +], +"enumDescriptions": [ +"Default unknown state.", +"Attestation was successfully generated and stored.", +"Attestation was unsuccessfully generated and stored." +], +"type": "string" +} +}, +"type": "object" +}, "VulnerabilityOccurrence": { "description": "An occurrence of a severity vulnerability on a resource.", "id": "VulnerabilityOccurrence", diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 2df09cd2fdb..f4e32a89306 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240709", +"revision": "20240624", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1105,6 +1105,10 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." +}, +"vulnerabilityAttestation": { +"$ref": "VulnerabilityAttestation", +"description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -2837,6 +2841,36 @@ }, "type": "object" }, +"VulnerabilityAttestation": { +"description": "The status of an vulnerability attestation generation.", +"id": "VulnerabilityAttestation", +"properties": { +"error": { +"description": "If failure, the error reason for why the attestation generation failed.", +"type": "string" +}, +"lastAttemptTime": { +"description": "The last time we attempted to generate an attestation.", +"format": "google-datetime", +"type": "string" +}, +"state": { +"description": "The success/failure state of the latest attestation attempt.", +"enum": [ +"VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", +"SUCCESS", +"FAILURE" +], +"enumDescriptions": [ +"Default unknown state.", +"Attestation was successfully generated and stored.", +"Attestation was unsuccessfully generated and stored." +], +"type": "string" +} +}, +"type": "object" +}, "VulnerabilityOccurrence": { "description": "An occurrence of a severity vulnerability on a resource.", "id": "VulnerabilityOccurrence", diff --git a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json index 6ee08e5f11e..e13911926fd 100644 --- a/googleapiclient/discovery_cache/documents/orgpolicy.v2.json +++ b/googleapiclient/discovery_cache/documents/orgpolicy.v2.json @@ -930,7 +930,7 @@ } } }, -"revision": "20240705", +"revision": "20240621", "rootUrl": "https://orgpolicy.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1.json b/googleapiclient/discovery_cache/documents/osconfig.v1.json index 3a6abb179ab..ad1e8b959a3 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1.json @@ -1083,7 +1083,7 @@ } } }, -"revision": "20240708", +"revision": "20240630", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptSettings": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json index 8e7cabdf5df..eb91eb5734a 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1alpha.json @@ -707,7 +707,7 @@ } } }, -"revision": "20240708", +"revision": "20240630", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "CVSSv3": { diff --git a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json index 5acb37959b4..94f8cda6632 100644 --- a/googleapiclient/discovery_cache/documents/osconfig.v1beta.json +++ b/googleapiclient/discovery_cache/documents/osconfig.v1beta.json @@ -689,7 +689,7 @@ } } }, -"revision": "20240708", +"revision": "20240630", "rootUrl": "https://osconfig.googleapis.com/", "schemas": { "AptRepository": { diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1.json b/googleapiclient/discovery_cache/documents/oslogin.v1.json index 223cc2a17e0..5fa18954f23 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1.json @@ -349,7 +349,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json b/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json index 22c3d36f03b..02b3ee363d7 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1alpha.json @@ -477,7 +477,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/oslogin.v1beta.json b/googleapiclient/discovery_cache/documents/oslogin.v1beta.json index 9bca24283d0..3b48baf89ae 100644 --- a/googleapiclient/discovery_cache/documents/oslogin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/oslogin.v1beta.json @@ -447,7 +447,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json index adab8a1d1f5..0e6a6c85707 100644 --- a/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json +++ b/googleapiclient/discovery_cache/documents/pagespeedonline.v5.json @@ -201,7 +201,7 @@ false } } }, -"revision": "20240712", +"revision": "20240627", "rootUrl": "https://pagespeedonline.googleapis.com/", "schemas": { "AuditRefs": { diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index bece37775df..5d35a404163 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -435,7 +435,7 @@ } } }, -"revision": "20240714", +"revision": "20240707", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "GoogleCloudPaymentsResellerSubscriptionV1Amount": { diff --git a/googleapiclient/discovery_cache/documents/people.v1.json b/googleapiclient/discovery_cache/documents/people.v1.json index b3d8d344dbc..fd116f35206 100644 --- a/googleapiclient/discovery_cache/documents/people.v1.json +++ b/googleapiclient/discovery_cache/documents/people.v1.json @@ -1190,7 +1190,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://people.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/places.v1.json b/googleapiclient/discovery_cache/documents/places.v1.json index 957e5763bf2..29c71b07624 100644 --- a/googleapiclient/discovery_cache/documents/places.v1.json +++ b/googleapiclient/discovery_cache/documents/places.v1.json @@ -276,7 +276,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { diff --git a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json index ce85f647ddc..89ac7fe5773 100644 --- a/googleapiclient/discovery_cache/documents/playcustomapp.v1.json +++ b/googleapiclient/discovery_cache/documents/playcustomapp.v1.json @@ -158,7 +158,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://playcustomapp.googleapis.com/", "schemas": { "CustomApp": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json index af7d74ff1f8..ce369bb8f86 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1alpha1.json @@ -947,7 +947,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1alpha1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json index 8b92131e65c..ea5855edaa0 100644 --- a/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/playdeveloperreporting.v1beta1.json @@ -947,7 +947,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://playdeveloperreporting.googleapis.com/", "schemas": { "GooglePlayDeveloperReportingV1beta1Anomaly": { diff --git a/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json b/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json index c1913e5b153..20a5bb1b513 100644 --- a/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/playgrouping.v1alpha1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://playgrouping.googleapis.com/", "schemas": { "CreateOrUpdateTagsRequest": { diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index 6bb14101c06..a30bbf55d9a 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -105,38 +105,6 @@ }, "protocol": "rest", "resources": { -"deviceRecall": { -"methods": { -"write": { -"description": "Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP).", -"flatPath": "v1/{v1Id}/deviceRecall:write", -"httpMethod": "POST", -"id": "playintegrity.deviceRecall.write", -"parameterOrder": [ -"packageName" -], -"parameters": { -"packageName": { -"description": "Required. Package name of the app the attached integrity token belongs to.", -"location": "path", -"pattern": "^[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+packageName}/deviceRecall:write", -"request": { -"$ref": "WriteDeviceRecallRequest" -}, -"response": { -"$ref": "WriteDeviceRecallResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/playintegrity" -] -} -} -}, "v1": { "methods": { "decodeIntegrityToken": { @@ -170,7 +138,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -523,46 +491,6 @@ } }, "type": "object" -}, -"Values": { -"description": "Contains the recall bits values.", -"id": "Values", -"properties": { -"bitFirst": { -"description": "Required. First recall bit value.", -"type": "boolean" -}, -"bitSecond": { -"description": "Required. Second recall bit value.", -"type": "boolean" -}, -"bitThird": { -"description": "Required. Third recall bit value.", -"type": "boolean" -} -}, -"type": "object" -}, -"WriteDeviceRecallRequest": { -"description": "Request to write device recall bits.", -"id": "WriteDeviceRecallRequest", -"properties": { -"integrityToken": { -"description": "Required. Integrity token obtained from calling Play Integrity API. Note that the integrity token contains the existing device recall bits. The write will only succeed if those bits in the integrity token are up to date.", -"type": "string" -}, -"newValues": { -"$ref": "Values", -"description": "Required. The new values for the device recall bits to be written." -} -}, -"type": "object" -}, -"WriteDeviceRecallResponse": { -"description": "Response for the Write Device Recall action. Currently empty.", -"id": "WriteDeviceRecallResponse", -"properties": {}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json index 49823769c0b..dbdb630587e 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1.json @@ -277,7 +277,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json index 013c8b8afc9..4872c66c22e 100644 --- a/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/policyanalyzer.v1beta1.json @@ -277,7 +277,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://policyanalyzer.googleapis.com/", "schemas": { "GoogleCloudPolicyanalyzerV1beta1Activity": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1.json b/googleapiclient/discovery_cache/documents/policysimulator.v1.json index 25a7a1ec8c7..61e47c4c7bb 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1.json @@ -806,7 +806,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json index 662065e1649..b2898a52250 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1alpha.json @@ -1078,7 +1078,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json index 51e646fa9bf..48146cdfacf 100644 --- a/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policysimulator.v1beta.json @@ -1078,7 +1078,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://policysimulator.googleapis.com/", "schemas": { "GoogleCloudOrgpolicyV2AlternatePolicySpec": { diff --git a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json index 83b51393f09..2cb442db7bc 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240709", +"revision": "20240707", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1AccessTuple": { diff --git a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json index 02eea3e48d5..7ef252cc23f 100644 --- a/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json +++ b/googleapiclient/discovery_cache/documents/policytroubleshooter.v1beta.json @@ -128,7 +128,7 @@ } } }, -"revision": "20240709", +"revision": "20240707", "rootUrl": "https://policytroubleshooter.googleapis.com/", "schemas": { "GoogleCloudPolicytroubleshooterV1betaAccessTuple": { diff --git a/googleapiclient/discovery_cache/documents/pollen.v1.json b/googleapiclient/discovery_cache/documents/pollen.v1.json index 3efc4077484..6c61b097e0e 100644 --- a/googleapiclient/discovery_cache/documents/pollen.v1.json +++ b/googleapiclient/discovery_cache/documents/pollen.v1.json @@ -233,7 +233,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://pollen.googleapis.com/", "schemas": { "Color": { diff --git a/googleapiclient/discovery_cache/documents/privateca.v1.json b/googleapiclient/discovery_cache/documents/privateca.v1.json index 0f25f2e7d20..b426c8b957a 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1.json @@ -1605,7 +1605,7 @@ } } }, -"revision": "20240701", +"revision": "20240626", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AccessUrls": { diff --git a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json index 73e7b4359f8..de4176f4c6f 100644 --- a/googleapiclient/discovery_cache/documents/privateca.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/privateca.v1beta1.json @@ -580,7 +580,7 @@ } } }, -"revision": "20240701", +"revision": "20240626", "rootUrl": "https://privateca.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/publicca.v1.json b/googleapiclient/discovery_cache/documents/publicca.v1.json index 83daadbfe23..82c028545dc 100644 --- a/googleapiclient/discovery_cache/documents/publicca.v1.json +++ b/googleapiclient/discovery_cache/documents/publicca.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240715", +"revision": "20240702", "rootUrl": "https://publicca.googleapis.com/", "schemas": { "ExternalAccountKey": { diff --git a/googleapiclient/discovery_cache/documents/publicca.v1alpha1.json b/googleapiclient/discovery_cache/documents/publicca.v1alpha1.json index b8f14242df5..331cfba2d41 100644 --- a/googleapiclient/discovery_cache/documents/publicca.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/publicca.v1alpha1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240715", +"revision": "20240702", "rootUrl": "https://publicca.googleapis.com/", "schemas": { "ExternalAccountKey": { diff --git a/googleapiclient/discovery_cache/documents/publicca.v1beta1.json b/googleapiclient/discovery_cache/documents/publicca.v1beta1.json index 92f2f425eaa..5133bf5d505 100644 --- a/googleapiclient/discovery_cache/documents/publicca.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/publicca.v1beta1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240715", +"revision": "20240702", "rootUrl": "https://publicca.googleapis.com/", "schemas": { "ExternalAccountKey": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index d9da5870bab..48ec32991bb 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1583,7 +1583,7 @@ } } }, -"revision": "20240711", +"revision": "20240702", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json index db1bca1a1b5..8b1430ec0f1 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta1a.json @@ -474,7 +474,7 @@ } } }, -"revision": "20240711", +"revision": "20240702", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json index 7cc5dc3d025..f4042ea89ca 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1beta2.json @@ -741,7 +741,7 @@ } } }, -"revision": "20240711", +"revision": "20240702", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/googleapiclient/discovery_cache/documents/pubsublite.v1.json b/googleapiclient/discovery_cache/documents/pubsublite.v1.json index e214158173f..88754f01e5b 100644 --- a/googleapiclient/discovery_cache/documents/pubsublite.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsublite.v1.json @@ -1040,7 +1040,7 @@ } } }, -"revision": "20240705", +"revision": "20240621", "rootUrl": "https://pubsublite.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json index e1ccb6ad64e..a0847b8496a 100644 --- a/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json +++ b/googleapiclient/discovery_cache/documents/readerrevenuesubscriptionlinking.v1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://readerrevenuesubscriptionlinking.googleapis.com/", "schemas": { "DeleteReaderResponse": { diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 7dd91e4a1c9..43461edc661 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1305,7 +1305,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index f69cfab59b8..5a41fbb0731 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -694,7 +694,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1.json b/googleapiclient/discovery_cache/documents/recommender.v1.json index 4a7ebea3270..65cb8b923aa 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1.json @@ -1686,7 +1686,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudRecommenderV1CostProjection": { diff --git a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json index 0124eb7608b..c89b1395ff4 100644 --- a/googleapiclient/discovery_cache/documents/recommender.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/recommender.v1beta1.json @@ -1920,7 +1920,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://recommender.googleapis.com/", "schemas": { "GoogleCloudLocationListLocationsResponse": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index e33b1fe4cab..47cbe760491 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240702", +"revision": "20240627", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index 197f76e5170..e8cfdc05c00 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240702", +"revision": "20240627", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { diff --git a/googleapiclient/discovery_cache/documents/reseller.v1.json b/googleapiclient/discovery_cache/documents/reseller.v1.json index 51c84cab695..ddb2c81ebbe 100644 --- a/googleapiclient/discovery_cache/documents/reseller.v1.json +++ b/googleapiclient/discovery_cache/documents/reseller.v1.json @@ -651,7 +651,7 @@ } } }, -"revision": "20240709", +"revision": "20240702", "rootUrl": "https://reseller.googleapis.com/", "schemas": { "Address": { diff --git a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json index 2ac492d4cc5..1c9d367ab9c 100644 --- a/googleapiclient/discovery_cache/documents/resourcesettings.v1.json +++ b/googleapiclient/discovery_cache/documents/resourcesettings.v1.json @@ -511,7 +511,7 @@ } } }, -"revision": "20240713", +"revision": "20240708", "rootUrl": "https://resourcesettings.googleapis.com/", "schemas": { "GoogleCloudResourcesettingsV1ListSettingsResponse": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index 44d55fc454f..63568a8caf2 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -2092,7 +2092,7 @@ } } }, -"revision": "20240704", +"revision": "20240614", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2637,6 +2637,14 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" +}, +"mergedFacetValues": { +"deprecated": true, +"description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", +"items": { +"$ref": "GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue" +}, +"type": "array" } }, "type": "object" @@ -2744,7 +2752,7 @@ }, "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult": { "deprecated": true, -"description": "Deprecated: Recent search of this user.", +"description": "Recent search of this user.", "id": "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index fae77710ff1..c64739109ce 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2557,7 +2557,7 @@ } } }, -"revision": "20240704", +"revision": "20240614", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3610,6 +3610,16 @@ "readOnly": true, "type": "array" }, +"productCounts": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"deprecated": true, +"description": "Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * \"primary-in-stock\", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * \"primary-out-of-stock\", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * \"primary-preorder\", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * \"primary-backorder\", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * \"variant-in-stock\", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * \"variant-out-of-stock\", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * \"variant-preorder\", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * \"variant-backorder\", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * \"price-discounted\", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view.", +"readOnly": true, +"type": "object" +}, "qualityMetrics": { "description": "Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in BranchView.BASIC view.", "items": { @@ -3892,6 +3902,14 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" +}, +"mergedFacetValues": { +"deprecated": true, +"description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", +"items": { +"$ref": "GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue" +}, +"type": "array" } }, "type": "object" @@ -4032,7 +4050,7 @@ }, "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult": { "deprecated": true, -"description": "Deprecated: Recent search of this user.", +"description": "Recent search of this user.", "id": "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 2b1a4066e18..e89f5dec6cd 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -2120,7 +2120,7 @@ } } }, -"revision": "20240704", +"revision": "20240614", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4113,6 +4113,14 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" +}, +"mergedFacetValues": { +"deprecated": true, +"description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", +"items": { +"$ref": "GoogleCloudRetailV2betaCatalogAttributeFacetConfigMergedFacetValue" +}, +"type": "array" } }, "type": "object" @@ -4220,7 +4228,7 @@ }, "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult": { "deprecated": true, -"description": "Deprecated: Recent search of this user.", +"description": "Recent search of this user.", "id": "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index dc86a4f86ad..7f7b6a8b342 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2614,7 +2614,7 @@ } } }, -"revision": "20240705", +"revision": "20240628", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4260,7 +4260,7 @@ false "id": "GoogleDevtoolsCloudbuildV1HttpConfig", "properties": { "proxySecretVersionName": { -"description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", +"description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have secretmanager.versions.access permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port].", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index c1fe43f5267..7133b466bd1 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1494,7 +1494,7 @@ } } }, -"revision": "20240712", +"revision": "20240705", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2979,7 +2979,7 @@ "type": "object" }, "maxInstanceRequestConcurrency": { -"description": "Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.", +"description": "Optional. Sets the maximum number of requests that each serving instance can receive.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json index 42f72f2a0f1..1416935afac 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v4.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v4.json @@ -261,7 +261,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleProtobufEmpty": { diff --git a/googleapiclient/discovery_cache/documents/safebrowsing.v5.json b/googleapiclient/discovery_cache/documents/safebrowsing.v5.json index 5b2730deae6..4a0a534447b 100644 --- a/googleapiclient/discovery_cache/documents/safebrowsing.v5.json +++ b/googleapiclient/discovery_cache/documents/safebrowsing.v5.json @@ -121,7 +121,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://safebrowsing.googleapis.com/", "schemas": { "GoogleSecuritySafebrowsingV5FullHash": { diff --git a/googleapiclient/discovery_cache/documents/script.v1.json b/googleapiclient/discovery_cache/documents/script.v1.json index 91d6bf2131c..7eeb96ddd6d 100644 --- a/googleapiclient/discovery_cache/documents/script.v1.json +++ b/googleapiclient/discovery_cache/documents/script.v1.json @@ -891,7 +891,7 @@ } } }, -"revision": "20240708", +"revision": "20240630", "rootUrl": "https://script.googleapis.com/", "schemas": { "Content": { diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json index 9a7066c4551..cd6d0bee321 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -17,7 +17,7 @@ "canonicalName": "Search Console", "description": "The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)", "discoveryVersion": "v1", -"documentationLink": "https://developers.google.com/webmaster-tools/about", +"documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -400,7 +400,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1.json index ad8565bca21..bfb3dd46812 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1.json @@ -1185,7 +1185,7 @@ } } }, -"revision": "20240705", +"revision": "20240621", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json index b21242320bb..170802e811d 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta1.json @@ -705,7 +705,7 @@ } } }, -"revision": "20240705", +"revision": "20240621", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json index 2feafd14cd2..50b931c6ee1 100644 --- a/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/secretmanager.v1beta2.json @@ -1185,7 +1185,7 @@ } } }, -"revision": "20240705", +"revision": "20240621", "rootUrl": "https://secretmanager.googleapis.com/", "schemas": { "AccessSecretVersionResponse": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 9ad11d4aea6..f9e4acca812 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, -"revision": "20240707", +"revision": "20240623", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1126,7 +1126,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 8209ba2aa8e..09d10be9242 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -715,7 +715,7 @@ } } }, -"revision": "20240707", +"revision": "20240623", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1211,7 +1211,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { diff --git a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json index 8b3e2b10112..d24e130e689 100644 --- a/googleapiclient/discovery_cache/documents/servicecontrol.v2.json +++ b/googleapiclient/discovery_cache/documents/servicecontrol.v2.json @@ -169,7 +169,7 @@ } } }, -"revision": "20240712", +"revision": "20240705", "rootUrl": "https://servicecontrol.googleapis.com/", "schemas": { "Api": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json index ea3fad5615c..1f91a34f9a3 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1.json @@ -883,7 +883,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json index a5bd4a0e780..2612c2aa57b 100644 --- a/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/servicedirectory.v1beta1.json @@ -971,7 +971,7 @@ } } }, -"revision": "20240707", +"revision": "20240630", "rootUrl": "https://servicedirectory.googleapis.com/", "schemas": { "Binding": { diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index c4e32c2335b..6998b83a235 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -830,7 +830,7 @@ } } }, -"revision": "20240705", +"revision": "20240628", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index a010e6dbce5..8239a03d6de 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1765,14 +1765,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", +"description": "A list of full type names of provided contexts.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", +"description": "A list of full type names of requested contexts.", "items": { "type": "string" }, @@ -1957,7 +1957,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -2421,7 +2421,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index 4cc9a78688e..b5451af2e9c 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -918,14 +918,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", +"description": "A list of full type names of provided contexts.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", +"description": "A list of full type names of requested contexts.", "items": { "type": "string" }, @@ -1073,7 +1073,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1505,7 +1505,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index d945e35592a..5c38312c9bb 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, -"revision": "20240707", +"revision": "20240623", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1147,7 +1147,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index e7809f590ec..966a6a752c7 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, -"revision": "20240707", +"revision": "20240623", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1724,7 +1724,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index 82c73538f44..049fae515d6 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, -"revision": "20240708", +"revision": "20240625", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -934,7 +934,7 @@ "type": "object" }, "AddDataSourceRequest": { -"description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source.", +"description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope.", "id": "AddDataSourceRequest", "properties": { "dataSource": { @@ -2330,7 +2330,7 @@ "type": "object" }, "CancelDataSourceRefreshRequest": { -"description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source.", +"description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references.", "id": "CancelDataSourceRefreshRequest", "properties": { "dataSourceId": { @@ -5960,7 +5960,7 @@ "type": "object" }, "RefreshDataSourceRequest": { -"description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.", +"description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.", "id": "RefreshDataSourceRequest", "properties": { "dataSourceId": { @@ -7468,7 +7468,7 @@ "type": "object" }, "UpdateDataSourceRequest": { -"description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source.", +"description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope.", "id": "UpdateDataSourceRequest", "properties": { "dataSource": { diff --git a/googleapiclient/discovery_cache/documents/slides.v1.json b/googleapiclient/discovery_cache/documents/slides.v1.json index 206d4738d7d..e6bbb97470e 100644 --- a/googleapiclient/discovery_cache/documents/slides.v1.json +++ b/googleapiclient/discovery_cache/documents/slides.v1.json @@ -313,7 +313,7 @@ } } }, -"revision": "20240710", +"revision": "20240625", "rootUrl": "https://slides.googleapis.com/", "schemas": { "AffineTransform": { diff --git a/googleapiclient/discovery_cache/documents/solar.v1.json b/googleapiclient/discovery_cache/documents/solar.v1.json index 651bef328be..516fc84edd9 100644 --- a/googleapiclient/discovery_cache/documents/solar.v1.json +++ b/googleapiclient/discovery_cache/documents/solar.v1.json @@ -267,7 +267,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://solar.googleapis.com/", "schemas": { "BuildingInsights": { diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 46226e4ea87..702cf9968dd 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -123,7 +123,7 @@ "instanceConfigOperations": { "methods": { "list": { -"description": "Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.", +"description": "Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.", "flatPath": "v1/projects/{projectsId}/instanceConfigOperations", "httpMethod": "GET", "id": "spanner.projects.instanceConfigOperations.list", @@ -132,7 +132,7 @@ ], "parameters": { "filter": { -"description": "An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance configuration name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", +"description": "An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", "location": "query", "type": "string" }, @@ -148,7 +148,7 @@ "type": "string" }, "parent": { -"description": "Required. The project of the instance configuration operations. Values are of the form `projects/`.", +"description": "Required. The project of the instance config operations. Values are of the form `projects/`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -169,7 +169,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 config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", "flatPath": "v1/projects/{projectsId}/instanceConfigs", "httpMethod": "POST", "id": "spanner.projects.instanceConfigs.create", @@ -198,7 +198,7 @@ ] }, "delete": { -"description": "Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", +"description": "Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "DELETE", "id": "spanner.projects.instanceConfigs.delete", @@ -207,7 +207,7 @@ ], "parameters": { "etag": { -"description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance 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 config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.", "location": "query", "type": "string" }, @@ -260,7 +260,7 @@ ] }, "list": { -"description": "Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.", +"description": "Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.", "flatPath": "v1/projects/{projectsId}/instanceConfigs", "httpMethod": "GET", "id": "spanner.projects.instanceConfigs.list", @@ -297,7 +297,7 @@ ] }, "patch": { -"description": "Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance 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 config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "PATCH", "id": "spanner.projects.instanceConfigs.patch", @@ -306,7 +306,7 @@ ], "parameters": { "name": { -"description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.", +"description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", "location": "path", "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$", "required": true, @@ -748,7 +748,7 @@ ] }, "move": { -"description": "Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance 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 the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:move", "httpMethod": "POST", "id": "spanner.projects.instances.move", @@ -1426,7 +1426,7 @@ ] }, "create": { -"description": "Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.", +"description": "Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases", "httpMethod": "POST", "id": "spanner.projects.instances.databases.create", @@ -1804,97 +1804,6 @@ } }, "resources": { -"backupSchedules": { -"methods": { -"getIamPolicy": { -"description": "Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.", -"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy", -"httpMethod": "POST", -"id": "spanner.projects.instances.databases.backupSchedules.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.", -"location": "path", -"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"request": { -"$ref": "GetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/spanner.admin" -] -}, -"setIamPolicy": { -"description": "Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.", -"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy", -"httpMethod": "POST", -"id": "spanner.projects.instances.databases.backupSchedules.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources.", -"location": "path", -"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/spanner.admin" -] -}, -"testIamPermissions": { -"description": "Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.", -"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:testIamPermissions", -"httpMethod": "POST", -"id": "spanner.projects.instances.databases.backupSchedules.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.", -"location": "path", -"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, -"response": { -"$ref": "TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/spanner.admin" -] -} -} -}, "databaseRoles": { "methods": { "list": { @@ -3096,11 +3005,11 @@ } } }, -"revision": "20240711", +"revision": "20240628", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { -"description": "Autoscaling configuration for an instance.", +"description": "Autoscaling config for an instance.", "id": "AutoscalingConfig", "properties": { "autoscalingLimits": { @@ -3711,7 +3620,7 @@ "type": "array" }, "protoDescriptors": { -"description": "Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \\ --include_imports \\ --descriptor_set_out=descriptors.data \\ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).", +"description": "Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \\ --include_imports \\ --descriptor_set_out=descriptors.data \\ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).", "format": "byte", "type": "string" } @@ -3729,7 +3638,7 @@ }, "instanceConfig": { "$ref": "InstanceConfig", -"description": "The target instance configuration end state." +"description": "The target instance config end state." }, "progress": { "$ref": "InstanceOperationProgress", @@ -3744,10 +3653,10 @@ "properties": { "instanceConfig": { "$ref": "InstanceConfig", -"description": "Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3." +"description": "Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3." }, "instanceConfigId": { -"description": "Required. The ID of the instance 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.", +"description": "Required. The ID of the instance config to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google managed configurations.", "type": "string" }, "validateOnly": { @@ -4243,7 +4152,7 @@ "enumDescriptions": [ "The default mode. Only the statement results are returned.", "This mode returns only the query plan, without any results or execution statistics information.", -"This mode returns both the query plan and the execution statistics along with the results. This has a performance overhead compared to the NORMAL mode. It is not recommended to use this mode for production traffic." +"This mode returns both the query plan and the execution statistics along with the results." ], "type": "string" }, @@ -4514,12 +4423,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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", "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 processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", "format": "int32", "type": "integer" }, @@ -4552,11 +4461,11 @@ "id": "InstanceConfig", "properties": { "baseConfig": { -"description": "Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration.", +"description": "Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.", "type": "string" }, "configType": { -"description": "Output only. Whether this instance configuration is a Google- or user-managed configuration.", +"description": "Output only. Whether this instance config is a Google or User Managed Configuration.", "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_MANAGED", @@ -4564,8 +4473,8 @@ ], "enumDescriptions": [ "Unspecified.", -"Google-managed configuration.", -"User-managed configuration." +"Google managed configuration.", +"User managed configuration." ], "readOnly": true, "type": "string" @@ -4575,7 +4484,7 @@ "type": "string" }, "etag": { -"description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly.", +"description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.", "type": "string" }, "freeInstanceAvailability": { @@ -4592,7 +4501,7 @@ "Indicates that free instances are available to be created in this instance config.", "Indicates that free instances are not supported in this instance config.", "Indicates that free instances are currently not available to be created in this instance config.", -"Indicates that additional free instances cannot be created in this instance configuration because the project has reached its limit of free instances." +"Indicates that additional free instances cannot be created in this instance config because the project has reached its limit of free instances." ], "readOnly": true, "type": "string" @@ -4612,11 +4521,11 @@ "type": "array" }, "name": { -"description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.", +"description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", "type": "string" }, "optionalReplicas": { -"description": "Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations.", +"description": "Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.", "items": { "$ref": "ReplicaInfo" }, @@ -4641,19 +4550,19 @@ "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 config is being created or updated. If false, there are no ongoing operations for the instance config.", "readOnly": true, "type": "boolean" }, "replicas": { -"description": "The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.", +"description": "The geographic placement of nodes in this instance configuration and their replication properties. To create user managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.", "items": { "$ref": "ReplicaInfo" }, "type": "array" }, "state": { -"description": "Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations.", +"description": "Output only. The current instance config state. Applicable only for USER_MANAGED configs.", "enum": [ "STATE_UNSPECIFIED", "CREATING", @@ -4661,8 +4570,8 @@ ], "enumDescriptions": [ "Not specified.", -"The instance configuration is still being created.", -"The instance configuration is fully created and ready to be used to create instances." +"The instance config is still being created.", +"The instance config is fully created and ready to be used to create instances." ], "readOnly": true, "type": "string" @@ -4725,12 +4634,12 @@ "type": "string" }, "nodeCount": { -"description": "The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", +"description": "The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", "format": "int32", "type": "integer" }, "processingUnits": { -"description": "The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state.", +"description": "The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", "format": "int32", "type": "integer" }, @@ -5006,7 +4915,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 config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", "items": { "$ref": "Operation" }, @@ -5290,7 +5199,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 config for the instance to move. Values are of the form `projects//instanceConfigs/`.", "type": "string" } }, @@ -5493,7 +5402,7 @@ "description": "Additional options that affect how many partitions are created." }, "sql": { -"description": "Required. The query request to generate partitions for. The request fails if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a PartitionedDml transaction for large, partition-friendly DML operations.", +"description": "Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.", "type": "string" }, "transaction": { @@ -6024,7 +5933,7 @@ "type": "string" }, "kmsKeyNames": { -"description": "Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configurations, specify a single regional location KMS key. * For multi-regional database instance configurations of type `GOOGLE_MANAGED`, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For a database instance configuration of type `USER_MANAGED`, please specify only regional location KMS keys to cover each region in the instance configuration. Multi-regional location KMS keys are not supported for USER_MANAGED instance configurations.", +"description": "Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.", "items": { "type": "string" }, @@ -6676,7 +6585,7 @@ }, "instanceConfig": { "$ref": "InstanceConfig", -"description": "The desired instance configuration after updating." +"description": "The desired instance config after updating." }, "progress": { "$ref": "InstanceOperationProgress", @@ -6691,7 +6600,7 @@ "properties": { "instanceConfig": { "$ref": "InstanceConfig", -"description": "Required. The user instance configuration to update, which must always include the instance configuration name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used." +"description": "Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used." }, "updateMask": { "description": "Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated.", diff --git a/googleapiclient/discovery_cache/documents/speech.v1.json b/googleapiclient/discovery_cache/documents/speech.v1.json index 6b9a7b311b2..2c5dda0b7c7 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1.json @@ -524,7 +524,7 @@ } } }, -"revision": "20240704", +"revision": "20240625", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { diff --git a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json index 5c01321c853..e6bb7f39c20 100644 --- a/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/speech.v1p1beta1.json @@ -524,7 +524,7 @@ } } }, -"revision": "20240704", +"revision": "20240625", "rootUrl": "https://speech.googleapis.com/", "schemas": { "ABNFGrammar": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 24837b3673f..a687fd07d88 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -644,7 +644,7 @@ ] }, "addServerCa": { -"description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.", +"description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", "flatPath": "v1/projects/{project}/instances/{instance}/addServerCa", "httpMethod": "POST", "id": "sql.instances.addServerCa", @@ -1287,7 +1287,7 @@ ] }, "rotateServerCa": { -"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.", +"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.", "flatPath": "v1/projects/{project}/instances/{instance}/rotateServerCa", "httpMethod": "POST", "id": "sql.instances.rotateServerCa", @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240711", +"revision": "20240622", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2915,20 +2915,6 @@ false "serverCaCert": { "$ref": "SslCert", "description": "SSL configuration." -}, -"serverCaMode": { -"description": "Specify what type of CA is used for the server certificate.", -"enum": [ -"CA_MODE_UNSPECIFIED", -"GOOGLE_MANAGED_INTERNAL_CA", -"GOOGLE_MANAGED_CAS_CA" -], -"enumDescriptions": [ -"CA mode is unknown.", -"Google-managed self-signed internal CA.", -"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." -], -"type": "string" } }, "type": "object" @@ -3429,10 +3415,6 @@ true }, "type": "array" }, -"switchTransactionLogsToCloudStorageEnabled": { -"description": "Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.", -"type": "boolean" -}, "upgradableDatabaseVersions": { "description": "Output only. All database versions that are available for upgrade.", "items": { @@ -4508,20 +4490,6 @@ false "description": "Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag.", "type": "boolean" }, -"serverCaMode": { -"description": "Specify what type of CA is used for the server certificate.", -"enum": [ -"CA_MODE_UNSPECIFIED", -"GOOGLE_MANAGED_INTERNAL_CA", -"GOOGLE_MANAGED_CAS_CA" -], -"enumDescriptions": [ -"CA mode is unknown.", -"Google-managed self-signed internal CA.", -"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." -], -"type": "string" -}, "sslMode": { "description": "Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.", "enum": [ @@ -4839,8 +4807,7 @@ false "RECONFIGURE_OLD_PRIMARY", "CLUSTER_MAINTENANCE", "SELF_SERVICE_MAINTENANCE", -"SWITCHOVER_TO_REPLICA", -"MAJOR_VERSION_UPGRADE" +"SWITCHOVER_TO_REPLICA" ], "enumDeprecated": [ false, @@ -4887,7 +4854,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -4935,8 +4901,7 @@ false "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", "Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", -"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.", -"Updates the major version of a Cloud SQL instance." +"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance." ], "type": "string" }, @@ -5614,8 +5579,7 @@ true "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", "PG_CRON_FLAG_ENABLED_IN_REPLICA", -"EXTENSIONS_NOT_ENABLED_IN_REPLICA", -"UNSUPPORTED_COLUMNS" +"EXTENSIONS_NOT_ENABLED_IN_REPLICA" ], "enumDescriptions": [ "", @@ -5666,8 +5630,7 @@ true "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", "The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", -"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", -"The source database has generated columns that can't be migrated. Please change them to regular columns before migration." +"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index acc6d6950ac..4ca895ae430 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -644,7 +644,7 @@ ] }, "addServerCa": { -"description": "Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.", +"description": "Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa", "httpMethod": "POST", "id": "sql.instances.addServerCa", @@ -1287,7 +1287,7 @@ ] }, "rotateServerCa": { -"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.", +"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa", "httpMethod": "POST", "id": "sql.instances.rotateServerCa", @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240711", +"revision": "20240622", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2915,20 +2915,6 @@ false "serverCaCert": { "$ref": "SslCert", "description": "SSL configuration." -}, -"serverCaMode": { -"description": "Specify what type of CA is used for the server certificate.", -"enum": [ -"CA_MODE_UNSPECIFIED", -"GOOGLE_MANAGED_INTERNAL_CA", -"GOOGLE_MANAGED_CAS_CA" -], -"enumDescriptions": [ -"CA mode is unknown.", -"Google-managed self-signed internal CA.", -"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." -], -"type": "string" } }, "type": "object" @@ -3430,10 +3416,6 @@ true }, "type": "array" }, -"switchTransactionLogsToCloudStorageEnabled": { -"description": "Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.", -"type": "boolean" -}, "upgradableDatabaseVersions": { "description": "Output only. All database versions that are available for upgrade.", "items": { @@ -4509,20 +4491,6 @@ false "description": "Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag.", "type": "boolean" }, -"serverCaMode": { -"description": "Specify what type of CA is used for the server certificate.", -"enum": [ -"CA_MODE_UNSPECIFIED", -"GOOGLE_MANAGED_INTERNAL_CA", -"GOOGLE_MANAGED_CAS_CA" -], -"enumDescriptions": [ -"CA mode is unknown.", -"Google-managed self-signed internal CA.", -"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." -], -"type": "string" -}, "sslMode": { "description": "Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.", "enum": [ @@ -4840,8 +4808,7 @@ false "RECONFIGURE_OLD_PRIMARY", "CLUSTER_MAINTENANCE", "SELF_SERVICE_MAINTENANCE", -"SWITCHOVER_TO_REPLICA", -"MAJOR_VERSION_UPGRADE" +"SWITCHOVER_TO_REPLICA" ], "enumDeprecated": [ false, @@ -4888,7 +4855,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -4936,8 +4902,7 @@ false "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", "Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", -"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.", -"Updates the major version of a Cloud SQL instance." +"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance." ], "type": "string" }, @@ -5615,8 +5580,7 @@ true "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", "PG_CRON_FLAG_ENABLED_IN_REPLICA", -"EXTENSIONS_NOT_ENABLED_IN_REPLICA", -"UNSUPPORTED_COLUMNS" +"EXTENSIONS_NOT_ENABLED_IN_REPLICA" ], "enumDescriptions": [ "", @@ -5667,8 +5631,7 @@ true "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", "The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", -"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", -"The source database has generated columns that can't be migrated. Please change them to regular columns before migration." +"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index 6766068b99a..ee92d10600a 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -43,7 +43,7 @@ "location": "me-central2" } ], -"etag": "\"3135313836383938323339343237353634393832\"", +"etag": "\"323732353932323032353837333633313231\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -4085,7 +4085,7 @@ } } }, -"revision": "20240709", +"revision": "20240706", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AnywhereCache": { diff --git a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json index 9f9d1c7d973..da8a89ba264 100644 --- a/googleapiclient/discovery_cache/documents/storagetransfer.v1.json +++ b/googleapiclient/discovery_cache/documents/storagetransfer.v1.json @@ -632,7 +632,7 @@ } } }, -"revision": "20240710", +"revision": "20240705", "rootUrl": "https://storagetransfer.googleapis.com/", "schemas": { "AgentPool": { diff --git a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json index 0ebad21fc2c..bcfbf066207 100644 --- a/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json +++ b/googleapiclient/discovery_cache/documents/streetviewpublish.v1.json @@ -534,7 +534,7 @@ } } }, -"revision": "20240713", +"revision": "20240625", "rootUrl": "https://streetviewpublish.googleapis.com/", "schemas": { "BatchDeletePhotosRequest": { diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index 333d599de7d..d43723d23d0 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -116,7 +116,7 @@ } } }, -"revision": "20240704", +"revision": "20240619", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -216,11 +216,6 @@ "description": "Response message for ExchangeToken.", "id": "GoogleIdentityStsV1ExchangeTokenResponse", "properties": { -"access_boundary_session_key": { -"description": "The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`.", -"format": "byte", -"type": "string" -}, "access_token": { "description": "An OAuth 2.0 security token, issued by Google, in response to the token exchange request. Tokens can vary in size, depending in part on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/sts.v1beta.json b/googleapiclient/discovery_cache/documents/sts.v1beta.json index 57f76d44fcb..8a8f4b19dc7 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1beta.json +++ b/googleapiclient/discovery_cache/documents/sts.v1beta.json @@ -116,7 +116,7 @@ } } }, -"revision": "20240704", +"revision": "20240619", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v1.json b/googleapiclient/discovery_cache/documents/tagmanager.v1.json index 3209a7b08a5..76549d46e33 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v1.json @@ -1932,7 +1932,7 @@ } } }, -"revision": "20240711", +"revision": "20240701", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tagmanager.v2.json b/googleapiclient/discovery_cache/documents/tagmanager.v2.json index 38f104d5302..708c50ad54e 100644 --- a/googleapiclient/discovery_cache/documents/tagmanager.v2.json +++ b/googleapiclient/discovery_cache/documents/tagmanager.v2.json @@ -3895,7 +3895,7 @@ } } }, -"revision": "20240711", +"revision": "20240701", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/tasks.v1.json b/googleapiclient/discovery_cache/documents/tasks.v1.json index 702381c03d4..125a0900268 100644 --- a/googleapiclient/discovery_cache/documents/tasks.v1.json +++ b/googleapiclient/discovery_cache/documents/tasks.v1.json @@ -576,7 +576,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://tasks.googleapis.com/", "schemas": { "AssignmentInfo": { diff --git a/googleapiclient/discovery_cache/documents/testing.v1.json b/googleapiclient/discovery_cache/documents/testing.v1.json index 348fffba2a3..fab83411279 100644 --- a/googleapiclient/discovery_cache/documents/testing.v1.json +++ b/googleapiclient/discovery_cache/documents/testing.v1.json @@ -449,7 +449,7 @@ } } }, -"revision": "20240704", +"revision": "20240625", "rootUrl": "https://testing.googleapis.com/", "schemas": { "Account": { diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1.json index 36c9fc85fbf..8bc4f6238ff 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1.json @@ -318,7 +318,7 @@ } } }, -"revision": "20240704", +"revision": "20240530", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json index cfcd87f4ba9..fa5dd27ef82 100644 --- a/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/texttospeech.v1beta1.json @@ -261,7 +261,7 @@ } } }, -"revision": "20240704", +"revision": "20240530", "rootUrl": "https://texttospeech.googleapis.com/", "schemas": { "AudioConfig": { diff --git a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json index 0f4c2eaad4d..e2a0a8c7b52 100644 --- a/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/toolresults.v1beta3.json @@ -1463,7 +1463,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://toolresults.googleapis.com/", "schemas": { "ANR": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v1.json b/googleapiclient/discovery_cache/documents/tpu.v1.json index 809cab9846d..c40995f588b 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1.json @@ -659,7 +659,7 @@ } } }, -"revision": "20240702", +"revision": "20240613", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json index 845e50e2a5f..fee6e41e80f 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json @@ -669,7 +669,7 @@ } } }, -"revision": "20240702", +"revision": "20240613", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v2.json b/googleapiclient/discovery_cache/documents/tpu.v2.json index 4cde1b8c59a..a79a721d81d 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v2.json +++ b/googleapiclient/discovery_cache/documents/tpu.v2.json @@ -887,7 +887,7 @@ } } }, -"revision": "20240702", +"revision": "20240613", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json index 4e2a2176439..d73238f316c 100644 --- a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json +++ b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json @@ -965,7 +965,7 @@ } } }, -"revision": "20240702", +"revision": "20240613", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { diff --git a/googleapiclient/discovery_cache/documents/transcoder.v1.json b/googleapiclient/discovery_cache/documents/transcoder.v1.json index a48c87a4260..fe68cc06528 100644 --- a/googleapiclient/discovery_cache/documents/transcoder.v1.json +++ b/googleapiclient/discovery_cache/documents/transcoder.v1.json @@ -385,7 +385,7 @@ } } }, -"revision": "20240701", +"revision": "20240626", "rootUrl": "https://transcoder.googleapis.com/", "schemas": { "AdBreak": { diff --git a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json index 00282979847..7a0cfc47e16 100644 --- a/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json +++ b/googleapiclient/discovery_cache/documents/travelimpactmodel.v1.json @@ -116,7 +116,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://travelimpactmodel.googleapis.com/", "schemas": { "ComputeFlightEmissionsRequest": { diff --git a/googleapiclient/discovery_cache/documents/vault.v1.json b/googleapiclient/discovery_cache/documents/vault.v1.json index cb37733911c..58129e19c6c 100644 --- a/googleapiclient/discovery_cache/documents/vault.v1.json +++ b/googleapiclient/discovery_cache/documents/vault.v1.json @@ -1203,7 +1203,7 @@ } } }, -"revision": "20240708", +"revision": "20240617", "rootUrl": "https://vault.googleapis.com/", "schemas": { "AccountCount": { diff --git a/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json b/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json index edc4391ea16..ec92cd89a12 100644 --- a/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json +++ b/googleapiclient/discovery_cache/documents/verifiedaccess.v1.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240709", +"revision": "20240702", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { "Challenge": { diff --git a/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json b/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json index dbf48fdc247..a8c798e62aa 100644 --- a/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json +++ b/googleapiclient/discovery_cache/documents/verifiedaccess.v2.json @@ -146,7 +146,7 @@ } } }, -"revision": "20240709", +"revision": "20240702", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { "Challenge": { diff --git a/googleapiclient/discovery_cache/documents/versionhistory.v1.json b/googleapiclient/discovery_cache/documents/versionhistory.v1.json index a2b642cccbc..2ba8fbda1ac 100644 --- a/googleapiclient/discovery_cache/documents/versionhistory.v1.json +++ b/googleapiclient/discovery_cache/documents/versionhistory.v1.json @@ -271,7 +271,7 @@ } } }, -"revision": "20240710", +"revision": "20240707", "rootUrl": "https://versionhistory.googleapis.com/", "schemas": { "Channel": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 07fa8a94517..77bb347b97e 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -2280,7 +2280,7 @@ } } }, -"revision": "20240704", +"revision": "20240630", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4946,7 +4946,7 @@ "type": "string" }, "subnetwork": { -"description": "Optional. The subnetwork to connect the NIC to.", +"description": "The subnetwork to connect the NIC to.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 405791e82e9..35f06a08b67 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -2280,7 +2280,7 @@ } } }, -"revision": "20240704", +"revision": "20240630", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4991,7 +4991,7 @@ "type": "string" }, "subnetwork": { -"description": "Optional. The subnetwork to connect the NIC to.", +"description": "The subnetwork to connect the NIC to.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index cb2ff5e5f94..dd026c6a9cf 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2681,7 +2681,7 @@ } } }, -"revision": "20240715", +"revision": "20240708", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { diff --git a/googleapiclient/discovery_cache/documents/webrisk.v1.json b/googleapiclient/discovery_cache/documents/webrisk.v1.json index 50cb198a645..9bfd23994d6 100644 --- a/googleapiclient/discovery_cache/documents/webrisk.v1.json +++ b/googleapiclient/discovery_cache/documents/webrisk.v1.json @@ -420,7 +420,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://webrisk.googleapis.com/", "schemas": { "GoogleCloudWebriskV1ComputeThreatListDiffResponse": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json index bfc244934b1..e8966429e28 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1.json @@ -526,7 +526,7 @@ } } }, -"revision": "20240630", +"revision": "20240623", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json index 2e7fac0c6f6..c099d65797f 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1alpha.json @@ -526,7 +526,7 @@ } } }, -"revision": "20240630", +"revision": "20240623", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { diff --git a/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json b/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json index bd3a0e6c382..da2d60e64d2 100644 --- a/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/websecurityscanner.v1beta.json @@ -526,7 +526,7 @@ } } }, -"revision": "20240630", +"revision": "20240623", "rootUrl": "https://websecurityscanner.googleapis.com/", "schemas": { "Authentication": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index f31bbb7ccc0..e3373cbed58 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -457,7 +457,7 @@ } } }, -"revision": "20240701", +"revision": "20240625", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json index c1252904a1f..c31a055cea3 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1beta.json @@ -269,7 +269,7 @@ } } }, -"revision": "20240701", +"revision": "20240625", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "CancelExecutionRequest": { diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index 02023de594c..e5c396201f0 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -772,7 +772,7 @@ } } }, -"revision": "20240701", +"revision": "20240626", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -797,10 +797,6 @@ "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", "id": "AssetLocation", "properties": { -"ccfeRmsPath": { -"description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", -"type": "string" -}, "expected": { "$ref": "IsolationExpectations", "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json index 8751e3eafd8..45147f9141d 100644 --- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json +++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json @@ -424,7 +424,7 @@ } } }, -"revision": "20240709", +"revision": "20240702", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": { diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index 8c77a7140ec..29dc628984f 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1195,7 +1195,7 @@ } } }, -"revision": "20240709", +"revision": "20240619", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1347,11 +1347,11 @@ "type": "object" }, "DomainConfig": { -"description": "Configuration options for a custom domain.", +"description": "Configuration options for private workstation clusters.", "id": "DomainConfig", "properties": { "domain": { -"description": "Immutable. Domain used by Workstations for HTTP ingress.", +"description": "Immutable. Whether Workstations endpoint is private.", "type": "string" } }, @@ -1940,45 +1940,23 @@ }, "type": "object" }, -"PortRange": { -"description": "A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", -"id": "PortRange", -"properties": { -"first": { -"description": "Required. Starting port number for the current range of ports.", -"format": "int32", -"type": "integer" -}, -"last": { -"description": "Required. Ending port number for the current range of ports.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, "PrivateClusterConfig": { -"description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { -"description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { -"description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { -"description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { -"description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", "readOnly": true, "type": "string" } @@ -2304,13 +2282,6 @@ "description": "A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.", "id": "WorkstationConfig", "properties": { -"allowedPorts": { -"description": "Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535.", -"items": { -"$ref": "PortRange" -}, -"type": "array" -}, "annotations": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 8dc060a1552..5b482375dd1 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1127,7 +1127,7 @@ } } }, -"revision": "20240709", +"revision": "20240619", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1315,11 +1315,11 @@ "type": "object" }, "DomainConfig": { -"description": "Configuration options for a custom domain.", +"description": "Configuration options for private workstation clusters.", "id": "DomainConfig", "properties": { "domain": { -"description": "Immutable. Domain used by Workstations for HTTP ingress.", +"description": "Immutable. Whether Workstations endpoint is private.", "type": "string" } }, @@ -1875,7 +1875,7 @@ "type": "object" }, "PortRange": { -"description": "A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", +"description": "A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", "id": "PortRange", "properties": { "first": { @@ -1892,27 +1892,22 @@ "type": "object" }, "PrivateClusterConfig": { -"description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { -"description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { -"description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { -"description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { -"description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", "readOnly": true, "type": "string" } @@ -2104,16 +2099,6 @@ "readOnly": true, "type": "boolean" }, -"satisfiesPzi": { -"description": "Output only. Reserved for future use.", -"readOnly": true, -"type": "boolean" -}, -"satisfiesPzs": { -"description": "Output only. Reserved for future use.", -"readOnly": true, -"type": "boolean" -}, "sourceWorkstation": { "description": "Optional. The source workstation from which this workstations persistent directories were cloned on creation.", "type": "string" @@ -2234,16 +2219,6 @@ "readOnly": true, "type": "boolean" }, -"satisfiesPzi": { -"description": "Output only. Reserved for future use.", -"readOnly": true, -"type": "boolean" -}, -"satisfiesPzs": { -"description": "Output only. Reserved for future use.", -"readOnly": true, -"type": "boolean" -}, "subnetwork": { "description": "Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.", "type": "string" @@ -2391,16 +2366,6 @@ "format": "google-duration", "type": "string" }, -"satisfiesPzi": { -"description": "Output only. Reserved for future use.", -"readOnly": true, -"type": "boolean" -}, -"satisfiesPzs": { -"description": "Output only. Reserved for future use.", -"readOnly": true, -"type": "boolean" -}, "uid": { "description": "Output only. A system-assigned unique identifier for this workstation configuration.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index e99af2d4814..c5d009433df 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -4072,7 +4072,7 @@ } } }, -"revision": "20240714", +"revision": "20240707", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { diff --git a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json index 14da9cdff5e..9407cdf77e6 100644 --- a/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json +++ b/googleapiclient/discovery_cache/documents/youtubeAnalytics.v2.json @@ -421,7 +421,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://youtubeanalytics.googleapis.com/", "schemas": { "EmptyResponse": { diff --git a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json index e163639ce93..3ab779acc27 100644 --- a/googleapiclient/discovery_cache/documents/youtubereporting.v1.json +++ b/googleapiclient/discovery_cache/documents/youtubereporting.v1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20240713", +"revision": "20240707", "rootUrl": "https://youtubereporting.googleapis.com/", "schemas": { "Empty": { From 29b4a11dad383ebcbc6f7ffcdff85b678002e8f1 Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Wed, 17 Jul 2024 16:54:52 -0400 Subject: [PATCH 2/8] build: fetch discovery artifacts from discovery-artifact-manager (#2443) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * build: fetch discovery artifacts from discovery-artifact-manager * remove comment * restore behavior * clean up * clean up * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * address review feedback * address review feedback * address review feedback * clean up * Add comment * Address review feedback * clean up * Address review feedback * Address review feedback * clean up * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * clean up --------- Co-authored-by: Owl Bot --- describe.py | 37 +++++++++++++++++++++++-------------- noxfile.py | 3 ++- 2 files changed, 25 insertions(+), 15 deletions(-) diff --git a/describe.py b/describe.py index e8f2ab26372..3236cafb869 100644 --- a/describe.py +++ b/describe.py @@ -136,13 +136,15 @@ BASE = pathlib.Path(__file__).resolve().parent / "docs" / "dyn" -DIRECTORY_URI = "https://www.googleapis.com/discovery/v1/apis" +# Obtain the discovery index and artifacts from googleapis/discovery-artifact-manager +DIRECTORY_URI = "https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/index.json" +DISCOVERY_URI_TEMPLATE = "https://raw.githubusercontent.com/googleapis/discovery-artifact-manager/master/discoveries/{api}.{apiVersion}.json" parser = argparse.ArgumentParser(description=__doc__) parser.add_argument( "--discovery_uri_template", - default=DISCOVERY_URI, + default=DISCOVERY_URI_TEMPLATE, help="URI Template for discovery.", ) @@ -390,7 +392,11 @@ def document_collection_recursive( def document_api( - name, version, uri, doc_destination_dir, artifact_destination_dir=DISCOVERY_DOC_DIR + name, + version, + uri, + doc_destination_dir, + artifact_destination_dir=DISCOVERY_DOC_DIR, ): """Document the given API. @@ -400,16 +406,11 @@ def document_api( uri (str): URI of the API's discovery document doc_destination_dir (str): relative path where the reference documentation should be saved. - artifact_destination_dir (str): relative path where the discovery + artifact_destination_dir (Optional[str]): relative path where the discovery artifacts should be saved. """ http = build_http() - resp, content = http.request( - uri - or uritemplate.expand( - FLAGS.discovery_uri_template, {"api": name, "apiVersion": version} - ) - ) + resp, content = http.request(uri) if resp.status == 200: discovery = json.loads(content) @@ -494,15 +495,18 @@ def generate_all_api_documents( directory_uri=DIRECTORY_URI, doc_destination_dir=BASE, artifact_destination_dir=DISCOVERY_DOC_DIR, + discovery_uri_template=DISCOVERY_URI_TEMPLATE, ): """Retrieve discovery artifacts and fetch reference documentations for all apis listed in the public discovery directory. args: - directory_uri (str): uri of the public discovery directory. - doc_destination_dir (str): relative path where the reference + directory_uri (Optional[str]): uri of the public discovery directory. + doc_destination_dir (Optional[str]): relative path where the reference documentation should be saved. - artifact_destination_dir (str): relative path where the discovery + artifact_destination_dir (Optional[str]): relative path where the discovery artifacts should be saved. + discovery_uri_template (Optional[str]): URI template of the API's discovery + document. """ api_directory = collections.defaultdict(list) http = build_http() @@ -510,10 +514,14 @@ def generate_all_api_documents( if resp.status == 200: directory = json.loads(content)["items"] for api in directory: + uri = uritemplate.expand( + discovery_uri_template or api["discoveryRestUrl"], + {"api": api["name"], "apiVersion": api["version"]}, + ) document_api( api["name"], api["version"], - api["discoveryRestUrl"], + uri, doc_destination_dir, artifact_destination_dir, ) @@ -555,4 +563,5 @@ def generate_all_api_documents( generate_all_api_documents( directory_uri=FLAGS.directory_uri, doc_destination_dir=FLAGS.dest, + discovery_uri_template=FLAGS.discovery_uri_template, ) diff --git a/noxfile.py b/noxfile.py index 767def37953..b0f7f2d5a00 100644 --- a/noxfile.py +++ b/noxfile.py @@ -135,13 +135,14 @@ def scripts(session): session.install("-r", "scripts/requirements.txt") # Run py.test against the unit tests. + # TODO(https://github.com/googleapis/google-api-python-client/issues/2132): Add tests for describe.py session.run( "py.test", "--quiet", "--cov=scripts", "--cov-config=.coveragerc", "--cov-report=", - "--cov-fail-under=91", + "--cov-fail-under=90", "scripts", *session.posargs, ) From 611e168e5117e86e96406974218b46415d0efbae Mon Sep 17 00:00:00 2001 From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com> Date: Wed, 17 Jul 2024 14:20:19 -0700 Subject: [PATCH 3/8] chore: Update discovery artifacts (#2445) ## Deleted keys were detected in the following stable discovery artifacts: androidpublisher v3 https://togithub.com/googleapis/google-api-python-client/commit/f17bf425f4dff226f95d0f647e5767eecfc0afa0 compute v1 https://togithub.com/googleapis/google-api-python-client/commit/1b4591acef05b112d0a8539de78720cba355701c discovery v1 https://togithub.com/googleapis/google-api-python-client/commit/d80d9cd0bf6ebcc3fa8bc5ec0eef0a423c3bb139 integrations v1 https://togithub.com/googleapis/google-api-python-client/commit/921a566c52f732b02ca7377a725695e5200b6633 networkservices v1 https://togithub.com/googleapis/google-api-python-client/commit/f83072f9661b012d0fa903152a36fdc4ec8cc117 ondemandscanning v1 https://togithub.com/googleapis/google-api-python-client/commit/83553a24aad1ebe0c425acc6f6265ff913ad6639 retail v2 https://togithub.com/googleapis/google-api-python-client/commit/bd8333231525112c3518fbc208adb1087a29440e ## Deleted keys were detected in the following pre-stable discovery artifacts: compute alpha https://togithub.com/googleapis/google-api-python-client/commit/1b4591acef05b112d0a8539de78720cba355701c compute beta https://togithub.com/googleapis/google-api-python-client/commit/1b4591acef05b112d0a8539de78720cba355701c firebaseappdistribution v1alpha https://togithub.com/googleapis/google-api-python-client/commit/a25ee1c4219c51e53c9f1e2fb765fcbdbbd18396 merchantapi accounts_v1beta https://togithub.com/googleapis/google-api-python-client/commit/17e8f11b0ef80e3366129b74d2b8c73dfbe44754 networkservices v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/f83072f9661b012d0fa903152a36fdc4ec8cc117 ondemandscanning v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/83553a24aad1ebe0c425acc6f6265ff913ad6639 retail v2alpha https://togithub.com/googleapis/google-api-python-client/commit/bd8333231525112c3518fbc208adb1087a29440e retail v2beta https://togithub.com/googleapis/google-api-python-client/commit/bd8333231525112c3518fbc208adb1087a29440e ## Discovery Artifact Change Summary: feat(androidpublisher): update the api https://togithub.com/googleapis/google-api-python-client/commit/f17bf425f4dff226f95d0f647e5767eecfc0afa0 feat(artifactregistry): update the api https://togithub.com/googleapis/google-api-python-client/commit/0f44c614ec222f004f43a40901e5408376eb7817 feat(cloudbuild): update the api https://togithub.com/googleapis/google-api-python-client/commit/d815f693b155fa169ef626508dba7c002b1d2551 feat(compute): update the api https://togithub.com/googleapis/google-api-python-client/commit/1b4591acef05b112d0a8539de78720cba355701c feat(connectors): update the api https://togithub.com/googleapis/google-api-python-client/commit/6daffd59b88155f25d4fffd4c94dfcc53dc19996 fix(dataflow): update the api https://togithub.com/googleapis/google-api-python-client/commit/d301ebfa182786cebe8523c0e286588079dcee75 feat(dialogflow): update the api https://togithub.com/googleapis/google-api-python-client/commit/f95bb057d15673818e3254a1af0f4e32cad0eeee feat(discovery): update the api https://togithub.com/googleapis/google-api-python-client/commit/d80d9cd0bf6ebcc3fa8bc5ec0eef0a423c3bb139 feat(discoveryengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/68cbf8de8b28a166cc03139c40d37a3bec9495f8 fix(dlp): update the api https://togithub.com/googleapis/google-api-python-client/commit/115b54599a19319aaf3569fc715b6694a37e1b80 feat(essentialcontacts): update the api https://togithub.com/googleapis/google-api-python-client/commit/6787614b030ac625957cdb66875df8337dabf38f feat(file): update the api https://togithub.com/googleapis/google-api-python-client/commit/9463ea6e04a11b3930109ceb8dc8044ed1e52dd4 feat(firebaseappdistribution): update the api https://togithub.com/googleapis/google-api-python-client/commit/a25ee1c4219c51e53c9f1e2fb765fcbdbbd18396 feat(gkehub): update the api https://togithub.com/googleapis/google-api-python-client/commit/5e696b23025351c3be82c60704f8149c6addc3ab feat(integrations): update the api https://togithub.com/googleapis/google-api-python-client/commit/921a566c52f732b02ca7377a725695e5200b6633 feat(logging): update the api https://togithub.com/googleapis/google-api-python-client/commit/b41557efc6638f2c2ddfa4a2005b82390039bd6b feat(merchantapi): update the api https://togithub.com/googleapis/google-api-python-client/commit/17e8f11b0ef80e3366129b74d2b8c73dfbe44754 feat(metastore): update the api https://togithub.com/googleapis/google-api-python-client/commit/99970bb458b0b536c840d8fc877ebdf7f511936f feat(networkservices): update the api https://togithub.com/googleapis/google-api-python-client/commit/f83072f9661b012d0fa903152a36fdc4ec8cc117 feat(ondemandscanning): update the api https://togithub.com/googleapis/google-api-python-client/commit/83553a24aad1ebe0c425acc6f6265ff913ad6639 feat(playintegrity): update the api https://togithub.com/googleapis/google-api-python-client/commit/f05a31375b87e293841996c04fb1d97a537a88c7 feat(retail): update the api https://togithub.com/googleapis/google-api-python-client/commit/bd8333231525112c3518fbc208adb1087a29440e feat(spanner): update the api https://togithub.com/googleapis/google-api-python-client/commit/3308e5e5f33d0d6f425a5e14a7811c2dc48dbda8 feat(sts): update the api https://togithub.com/googleapis/google-api-python-client/commit/a82289a44c9fe757bf81c168a5e3a9c0ec562ce2 feat(workloadmanager): update the api https://togithub.com/googleapis/google-api-python-client/commit/d0ea2ac7f001240238c8b619d207fc37975789cd feat(workstations): update the api https://togithub.com/googleapis/google-api-python-client/commit/e40169320a9ffc88b81b6e62c9edd837480fe591 --- ...anager_v1.accessPolicies.accessLevels.html | 10 +- ...r_v1.accessPolicies.servicePerimeters.html | 40 +- docs/dyn/admin_directory_v1.users.html | 4 +- docs/dyn/adsenseplatform_v1alpha.html | 111 ++ ...orm_v1alpha.platforms.accounts.events.html | 147 ++ ...seplatform_v1alpha.platforms.accounts.html | 271 +++ ...form_v1alpha.platforms.accounts.sites.html | 233 +++ .../adsenseplatform_v1alpha.platforms.html | 91 + docs/dyn/androidpublisher_v3.apprecovery.html | 130 +- ...roidpublisher_v3.externaltransactions.html | 8 +- ...cations.repositories.genericArtifacts.html | 2 +- .../dyn/batch_v1.projects.locations.jobs.html | 24 +- ...jects.locations.jobs.taskGroups.tasks.html | 20 +- .../batch_v1.projects.locations.state.html | 20 +- ...lpha.organizations.locations.insights.html | 2 +- ...p_v1alpha.projects.locations.insights.html | 2 +- docs/dyn/bigquery_v2.datasets.html | 32 +- docs/dyn/bigquery_v2.jobs.html | 10 +- docs/dyn/bigquery_v2.tables.html | 14 +- docs/dyn/calendar_v3.events.html | 52 +- docs/dyn/chat_v1.spaces.html | 42 +- docs/dyn/chat_v1.spaces.messages.html | 32 +- docs/dyn/chat_v1.spaces.spaceEvents.html | 64 +- ...chromemanagement_v1.customers.reports.html | 4 +- docs/dyn/cloudbuild_v1.projects.builds.html | 8 +- ...oudbuild_v1.projects.locations.builds.html | 8 +- ...dbuild_v1.projects.locations.triggers.html | 12 +- docs/dyn/cloudbuild_v1.projects.triggers.html | 12 +- ...rrorreporting_v1beta1.projects.events.html | 2 +- docs/dyn/compute_alpha.backendServices.html | 77 +- ...ute_alpha.globalNetworkEndpointGroups.html | 6 - .../compute_alpha.instanceGroupManagers.html | 12 +- docs/dyn/compute_alpha.instanceTemplates.html | 8 +- docs/dyn/compute_alpha.instances.html | 24 +- docs/dyn/compute_alpha.machineImages.html | 12 +- .../compute_alpha.networkEndpointGroups.html | 8 - .../compute_alpha.regionBackendServices.html | 66 +- docs/dyn/compute_alpha.regionCommitments.html | 28 + ...ute_alpha.regionInstanceGroupManagers.html | 10 +- ...compute_alpha.regionInstanceTemplates.html | 6 +- docs/dyn/compute_alpha.regionInstances.html | 2 +- docs/dyn/compute_alpha.regionMultiMigs.html | 6 +- ...ute_alpha.regionNetworkEndpointGroups.html | 6 - docs/dyn/compute_alpha.regions.html | 4 +- docs/dyn/compute_alpha.reservations.html | 15 + docs/dyn/compute_alpha.resourcePolicies.html | 15 + docs/dyn/compute_alpha.vpnGateways.html | 8 +- .../compute_alpha.zoneQueuedResources.html | 8 +- docs/dyn/compute_beta.backendServices.html | 84 +- docs/dyn/compute_beta.firewallPolicies.html | 1463 +++++++++++++---- ...pute_beta.globalNetworkEndpointGroups.html | 6 - .../compute_beta.instanceGroupManagers.html | 12 +- docs/dyn/compute_beta.instanceTemplates.html | 4 + docs/dyn/compute_beta.instances.html | 13 + docs/dyn/compute_beta.machineImages.html | 6 + .../compute_beta.networkEndpointGroups.html | 8 - .../compute_beta.networkFirewallPolicies.html | 1073 +++++++++++- .../compute_beta.regionBackendServices.html | 72 +- ...pute_beta.regionInstanceGroupManagers.html | 10 +- .../compute_beta.regionInstanceTemplates.html | 3 + docs/dyn/compute_beta.regionInstances.html | 1 + ...pute_beta.regionNetworkEndpointGroups.html | 6 - ...te_beta.regionNetworkFirewallPolicies.html | 293 ++++ docs/dyn/compute_beta.regions.html | 4 +- docs/dyn/compute_beta.vpnGateways.html | 8 +- docs/dyn/compute_v1.backendServices.html | 28 +- .../dyn/compute_v1.instanceGroupManagers.html | 10 +- docs/dyn/compute_v1.instanceTemplates.html | 4 + docs/dyn/compute_v1.instances.html | 7 + docs/dyn/compute_v1.machineImages.html | 6 + .../dyn/compute_v1.regionBackendServices.html | 24 +- ...ompute_v1.regionInstanceGroupManagers.html | 8 +- .../compute_v1.regionInstanceTemplates.html | 3 + docs/dyn/compute_v1.regionInstances.html | 1 + docs/dyn/compute_v1.regions.html | 4 +- docs/dyn/compute_v1.vpnGateways.html | 8 +- ....connections.connectionSchemaMetadata.html | 2 + ...ors_v1.projects.locations.connections.html | 2 + ...ions.connections.runtimeActionSchemas.html | 2 + ...tomConnectors.customConnectorVersions.html | 6 +- ...cations.providers.connectors.versions.html | 32 +- ...rojects.locations.connections.actions.html | 4 + .../dyn/css_v1.accounts.cssProductInputs.html | 362 ++++ docs/dyn/css_v1.accounts.cssProducts.html | 442 +++++ docs/dyn/css_v1.accounts.html | 237 +++ docs/dyn/css_v1.accounts.labels.html | 236 +++ docs/dyn/css_v1.html | 111 ++ ...flow_v2.projects.conversationProfiles.html | 42 + ...ojects.locations.conversationProfiles.html | 42 + ..._v2.projects.locations.encryptionSpec.html | 134 ++ .../dyn/dialogflow_v2.projects.locations.html | 28 + ...low_v2.projects.locations.suggestions.html | 7 + .../dialogflow_v2.projects.suggestions.html | 7 + ...v2beta1.projects.conversationProfiles.html | 42 + ...beta1.projects.conversations.messages.html | 96 ++ ...1.projects.conversations.participants.html | 32 + ...ojects.locations.conversationProfiles.html | 42 + ...ects.locations.conversations.messages.html | 96 ++ ....locations.conversations.participants.html | 32 + ...ta1.projects.locations.encryptionSpec.html | 134 ++ ...dialogflow_v2beta1.projects.locations.html | 28 + ...2beta1.projects.locations.suggestions.html | 39 + ...alogflow_v2beta1.projects.suggestions.html | 39 + ...ocations.agents.environments.sessions.html | 14 + ...ow_v3.projects.locations.agents.flows.html | 6 + ...projects.locations.agents.flows.pages.html | 12 + ...v3.projects.locations.agents.sessions.html | 14 + ...3.projects.locations.agents.testCases.html | 55 +- ...ts.locations.agents.testCases.results.html | 4 + ...ojects.locations.agents.conversations.html | 26 + ...ocations.agents.environments.sessions.html | 17 + ...beta1.projects.locations.agents.flows.html | 6 + ...projects.locations.agents.flows.pages.html | 12 + ...a1.projects.locations.agents.sessions.html | 17 + ...1.projects.locations.agents.testCases.html | 55 +- ...ts.locations.agents.testCases.results.html | 4 + docs/dyn/discovery_v1.apis.html | 29 - ...collections.dataStores.servingConfigs.html | 1 + ...ns.collections.engines.servingConfigs.html | 1 + ...s.locations.dataStores.servingConfigs.html | 1 + ...anizations.locations.discoveryConfigs.html | 12 +- ...tions.locations.fileStoreDataProfiles.html | 8 +- ...nizations.locations.tableDataProfiles.html | 8 +- ...2.projects.locations.discoveryConfigs.html | 12 +- ...jects.locations.fileStoreDataProfiles.html | 8 +- ....projects.locations.tableDataProfiles.html | 8 +- ...essentialcontacts_v1.folders.contacts.html | 14 +- ...ialcontacts_v1.organizations.contacts.html | 14 +- ...ssentialcontacts_v1.projects.contacts.html | 14 +- ...le_v1beta1.projects.locations.backups.html | 4 + ..._v1alpha.projects.apps.releases.tests.html | 36 + ...v1.projects.databases.backupSchedules.html | 12 +- ...gkehub_v1.projects.locations.features.html | 40 +- ...ocations.memberships.rbacrolebindings.html | 242 +++ ...b_v1alpha.projects.locations.features.html | 48 +- ...ub_v1beta.projects.locations.features.html | 40 +- docs/dyn/index.md | 8 + ...tions_v1.projects.locations.templates.html | 77 +- ...illingAccounts.locations.savedQueries.html | 5 +- docs/dyn/logging_v2.folders.html | 2 +- ...ing_v2.folders.locations.savedQueries.html | 5 +- docs/dyn/logging_v2.organizations.html | 2 +- ....organizations.locations.savedQueries.html | 5 +- ...ng_v2.projects.locations.savedQueries.html | 5 +- docs/dyn/logging_v2.v2.html | 2 +- ...unts_v1beta.accounts.businessIdentity.html | 186 +++ ...accounts_v1beta.accounts.businessInfo.html | 252 +++ ...unts_v1beta.accounts.emailpreferences.html | 141 ++ ...api_accounts_v1beta.accounts.homepage.html | 58 + .../merchantapi_accounts_v1beta.accounts.html | 665 +------- ...unts_v1beta.accounts.shippingSettings.html | 326 ++++ ...antapi_accounts_v1beta.accounts.users.html | 55 - ...a.projects.locations.services.backups.html | 48 + ...e_v1alpha.projects.locations.services.html | 64 + ...a.projects.locations.services.backups.html | 48 + ...re_v1beta.projects.locations.services.html | 64 + ...ha1.projects.locations.preferenceSets.html | 64 +- ...jects.locations.reportConfigs.reports.html | 96 +- ...1.projects.locations.endpointPolicies.html | 172 -- ...rvices_v1.projects.locations.gateways.html | 172 -- ...services_v1.projects.locations.meshes.html | 172 -- ...v1.projects.locations.serviceBindings.html | 172 -- ...1.projects.locations.endpointPolicies.html | 172 -- ...s_v1beta1.projects.locations.gateways.html | 172 -- ...ces_v1beta1.projects.locations.meshes.html | 172 -- ...a1.projects.locations.serviceBindings.html | 172 -- ...jects.locations.scans.vulnerabilities.html | 5 - ...jects.locations.scans.vulnerabilities.html | 5 - docs/dyn/playintegrity_v1.deviceRecall.html | 119 ++ docs/dyn/playintegrity_v1.html | 5 + ...s.locations.catalogs.attributesConfig.html | 40 - ...retail_v2.projects.locations.catalogs.html | 26 +- ...s.locations.catalogs.attributesConfig.html | 40 - ....projects.locations.catalogs.branches.html | 6 - ...l_v2alpha.projects.locations.catalogs.html | 26 +- ...s.locations.catalogs.attributesConfig.html | 40 - ...il_v2beta.projects.locations.catalogs.html | 26 +- docs/dyn/serviceusage_v1.services.html | 6 +- docs/dyn/serviceusage_v1beta1.services.html | 4 +- docs/dyn/sheets_v4.spreadsheets.html | 8 +- docs/dyn/slides_v1.presentations.html | 1146 ++++++++++++- docs/dyn/slides_v1.presentations.pages.html | 7 +- ..._v1.projects.instanceConfigOperations.html | 10 +- .../spanner_v1.projects.instanceConfigs.html | 90 +- ...s.instances.databases.backupSchedules.html | 226 +++ ...anner_v1.projects.instances.databases.html | 13 +- ...projects.instances.databases.sessions.html | 2 +- docs/dyn/spanner_v1.projects.instances.html | 30 +- ...projects.instances.instancePartitions.html | 16 +- docs/dyn/sts_v1.v1.html | 1 + ...ations.sources.migratingVms.cloneJobs.html | 6 +- ...ions.sources.migratingVms.cutoverJobs.html | 6 +- ...ojects.locations.sources.migratingVms.html | 32 +- ...ations.sources.migratingVms.cloneJobs.html | 18 +- ...ions.sources.migratingVms.cutoverJobs.html | 18 +- ...ojects.locations.sources.migratingVms.html | 80 +- ...rojects.locations.workstationClusters.html | 56 +- ...orkstationClusters.workstationConfigs.html | 30 + ...rojects.locations.workstationClusters.html | 64 +- ...orkstationClusters.workstationConfigs.html | 20 +- ...sters.workstationConfigs.workstations.html | 10 + .../documents/accesscontextmanager.v1.json | 9 +- .../documents/admin.directory_v1.json | 4 +- .../documents/adsenseplatform.v1alpha.json | 721 ++++++++ .../documents/aiplatform.v1.json | 2 +- .../documents/aiplatform.v1beta1.json | 2 +- .../documents/alloydb.v1alpha.json | 23 +- .../documents/alloydb.v1beta.json | 23 +- .../documents/androidpublisher.v3.json | 64 +- .../documents/artifactregistry.v1.json | 10 +- .../documents/assuredworkloads.v1.json | 26 +- .../documents/assuredworkloads.v1beta1.json | 26 +- .../discovery_cache/documents/batch.v1.json | 12 +- .../documents/beyondcorp.v1alpha.json | 6 +- .../documents/bigquery.v2.json | 12 +- .../documents/calendar.v3.json | 6 +- .../discovery_cache/documents/chat.v1.json | 30 +- .../documents/chromemanagement.v1.json | 6 +- .../documents/cloudbuild.v1.json | 4 +- .../documents/cloudbuild.v2.json | 21 +- .../clouderrorreporting.v1beta1.json | 4 +- .../documents/compute.alpha.json | 112 +- .../documents/compute.beta.json | 434 ++++- .../discovery_cache/documents/compute.v1.json | 18 +- .../documents/connectors.v1.json | 12 +- .../documents/connectors.v2.json | 10 +- .../discovery_cache/documents/css.v1.json | 1216 ++++++++++++++ .../documents/dataflow.v1b3.json | 178 +- .../documents/dialogflow.v2.json | 271 ++- .../documents/dialogflow.v2beta1.json | 152 +- .../documents/dialogflow.v3.json | 222 ++- .../documents/dialogflow.v3beta1.json | 222 ++- .../documents/discovery.v1.json | 49 - .../documents/discoveryengine.v1.json | 65 +- .../documents/discoveryengine.v1alpha.json | 60 +- .../documents/discoveryengine.v1beta.json | 60 +- .../discovery_cache/documents/dlp.v2.json | 206 ++- .../documents/essentialcontacts.v1.json | 5 +- .../documents/file.v1beta1.json | 17 +- .../firebaseappdistribution.v1alpha.json | 44 +- .../documents/firestore.v1.json | 4 +- .../discovery_cache/documents/gkehub.v1.json | 211 ++- .../documents/gkehub.v1alpha.json | 65 +- .../documents/gkehub.v1beta.json | 50 +- .../documents/identitytoolkit.v3.json | 2 +- .../documents/integrations.v1.json | 20 +- .../discovery_cache/documents/logging.v2.json | 28 +- .../merchantapi.accounts_v1beta.json | 464 +++--- .../documents/metastore.v1.json | 36 +- .../documents/metastore.v1alpha.json | 99 +- .../documents/metastore.v1beta.json | 99 +- .../documents/migrationcenter.v1alpha1.json | 16 +- .../documents/monitoring.v1.json | 10 +- .../documents/networkservices.v1.json | 350 +--- .../documents/networkservices.v1beta1.json | 350 +--- .../documents/ondemandscanning.v1.json | 36 +- .../documents/ondemandscanning.v1beta1.json | 36 +- .../documents/playintegrity.v1.json | 74 +- .../discovery_cache/documents/retail.v2.json | 12 +- .../documents/retail.v2alpha.json | 22 +- .../documents/retail.v2beta.json | 12 +- .../discovery_cache/documents/run.v1.json | 4 +- .../documents/searchconsole.v1.json | 4 +- .../serviceconsumermanagement.v1.json | 4 +- .../serviceconsumermanagement.v1beta1.json | 4 +- .../documents/serviceusage.v1.json | 4 +- .../documents/serviceusage.v1beta1.json | 4 +- .../discovery_cache/documents/sheets.v4.json | 10 +- .../discovery_cache/documents/spanner.v1.json | 173 +- .../discovery_cache/documents/sts.v1.json | 7 +- .../documents/vmmigration.v1.json | 4 +- .../documents/vmmigration.v1alpha1.json | 4 +- .../documents/workloadmanager.v1.json | 6 +- .../documents/workstations.v1.json | 35 +- .../documents/workstations.v1beta.json | 43 +- 275 files changed, 15161 insertions(+), 5263 deletions(-) create mode 100644 docs/dyn/adsenseplatform_v1alpha.html create mode 100644 docs/dyn/adsenseplatform_v1alpha.platforms.accounts.events.html create mode 100644 docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html create mode 100644 docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html create mode 100644 docs/dyn/adsenseplatform_v1alpha.platforms.html create mode 100644 docs/dyn/css_v1.accounts.cssProductInputs.html create mode 100644 docs/dyn/css_v1.accounts.cssProducts.html create mode 100644 docs/dyn/css_v1.accounts.html create mode 100644 docs/dyn/css_v1.accounts.labels.html create mode 100644 docs/dyn/css_v1.html create mode 100644 docs/dyn/dialogflow_v2.projects.locations.encryptionSpec.html create mode 100644 docs/dyn/dialogflow_v2beta1.projects.locations.encryptionSpec.html create mode 100644 docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html create mode 100644 docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html create mode 100644 docs/dyn/merchantapi_accounts_v1beta.accounts.emailpreferences.html create mode 100644 docs/dyn/playintegrity_v1.deviceRecall.html create mode 100644 docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html create mode 100644 googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json create mode 100644 googleapiclient/discovery_cache/documents/css.v1.json diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html index fa9f3f99417..558a2d04924 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html @@ -154,7 +154,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -299,7 +299,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -385,7 +385,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -474,7 +474,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -577,7 +577,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index 4c57a03e76a..f2fa669849b 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -177,9 +177,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, @@ -261,9 +261,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, @@ -431,9 +431,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, @@ -515,9 +515,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, @@ -627,9 +627,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, @@ -711,9 +711,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, @@ -829,9 +829,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, @@ -913,9 +913,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, @@ -1047,9 +1047,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, @@ -1131,9 +1131,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. }, ], }, diff --git a/docs/dyn/admin_directory_v1.users.html b/docs/dyn/admin_directory_v1.users.html index ba687e92e93..2f72e9c9cd6 100644 --- a/docs/dyn/admin_directory_v1.users.html +++ b/docs/dyn/admin_directory_v1.users.html @@ -95,7 +95,7 @@

Instance Methods

Retrieves a user.

insert(body=None, resolveConflictAccount=None, x__xgafv=None)

-

Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case.

+

Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.

list(customFieldMask=None, customer=None, domain=None, event=None, maxResults=None, orderBy=None, pageToken=None, projection=None, query=None, showDeleted=None, sortOrder=None, viewType=None, x__xgafv=None)

Retrieves a paginated list of either deleted users or all users in a domain.

@@ -228,7 +228,7 @@

Method Details

insert(body=None, resolveConflictAccount=None, x__xgafv=None) -
Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case.
+  
Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the "User creation is not complete" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.
 
 Args:
   body: object, The request body.
diff --git a/docs/dyn/adsenseplatform_v1alpha.html b/docs/dyn/adsenseplatform_v1alpha.html
new file mode 100644
index 00000000000..9a196ffc224
--- /dev/null
+++ b/docs/dyn/adsenseplatform_v1alpha.html
@@ -0,0 +1,111 @@
+
+
+
+

AdSense Platform API

+

Instance Methods

+

+ platforms() +

+

Returns the platforms 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/adsenseplatform_v1alpha.platforms.accounts.events.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.events.html new file mode 100644 index 00000000000..3e3ecadc7ec --- /dev/null +++ b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.events.html @@ -0,0 +1,147 @@ + + + +

AdSense Platform API . platforms . accounts . events

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an account event.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an account event.
+
+Args:
+  parent: string, Required. Account to log events about. Format: platforms/{platform}/accounts/{account} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A platform sub-account event to record spam signals.
+  "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
+    "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
+      "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
+      "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
+      "city": "A String", # City. Max length 60 bytes or 30 characters.
+      "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
+      "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
+      "fax": "A String", # Fax number with international code (i.e. +441234567890).
+      "phone": "A String", # Phone number with international code (i.e. +441234567890).
+      "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
+      "state": "A String", # State. Max length 60 bytes or 30 characters.
+      "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
+    },
+    "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
+  },
+  "eventTime": "A String", # Required. Event timestamp.
+  "eventType": "A String", # Required. Event type.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A platform sub-account event to record spam signals.
+  "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
+    "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
+      "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
+      "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
+      "city": "A String", # City. Max length 60 bytes or 30 characters.
+      "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
+      "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
+      "fax": "A String", # Fax number with international code (i.e. +441234567890).
+      "phone": "A String", # Phone number with international code (i.e. +441234567890).
+      "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
+      "state": "A String", # State. Max length 60 bytes or 30 characters.
+      "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
+    },
+    "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
+  },
+  "eventTime": "A String", # Required. Event timestamp.
+  "eventType": "A String", # Required. Event type.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html new file mode 100644 index 00000000000..d2be5261406 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.html @@ -0,0 +1,271 @@ + + + +

AdSense Platform API . platforms . accounts

+

Instance Methods

+

+ events() +

+

Returns the events Resource.

+ +

+ sites() +

+

Returns the sites Resource.

+ +

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

+

Closes a sub-account.

+

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

+

Creates a sub-account.

+

+ get(name, x__xgafv=None)

+

Gets information about the selected sub-account.

+

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

+

Lists a partial view of sub-accounts for a specific parent account.

+

+ list_next()

+

Retrieves the next page of results.

+

+ lookup(parent, creationRequestId=None, x__xgafv=None)

+

Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.

+

Method Details

+
+ close(name, body=None, x__xgafv=None) +
Closes a sub-account.
+
+Args:
+  name: string, Required. Account to close. Format: platforms/{platform}/accounts/{account_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request definition for the account close rpc.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the account close rpc.
+}
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a sub-account.
+
+Args:
+  parent: string, Required. Platform to create an account for. Format: platforms/{platform} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Representation of an Account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+  "displayName": "A String", # Display name of this account.
+  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+  "state": "A String", # Output only. Approval state of the account.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of an Account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+  "displayName": "A String", # Display name of this account.
+  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+  "state": "A String", # Output only. Approval state of the account.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets information about the selected sub-account.
+
+Args:
+  name: string, Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of an Account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+  "displayName": "A String", # Display name of this account.
+  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+  "state": "A String", # Output only. Approval state of the account.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists a partial view of sub-accounts for a specific parent account.
+
+Args:
+  parent: string, Required. Platform who parents the accounts. Format: platforms/{platform} (required)
+  pageSize: integer, Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the list accounts rpc.
+  "accounts": [ # The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.
+    { # Representation of an Account.
+      "createTime": "A String", # Output only. Creation time of the account.
+      "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+      "displayName": "A String", # Display name of this account.
+      "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+      "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+      "state": "A String", # Output only. Approval state of the account.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ 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.
+        
+
+ +
+ lookup(parent, creationRequestId=None, x__xgafv=None) +
Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
+
+Args:
+  parent: string, Required. Platform who parents the account. Format: platforms/{platform} (required)
+  creationRequestId: string, Optional. The creation_request_id provided when calling createAccount.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the lookup account rpc.
+  "name": "A String", # The name of the Account Format: platforms/{platform}/accounts/{account_id}
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html new file mode 100644 index 00000000000..e3f66b86721 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1alpha.platforms.accounts.sites.html @@ -0,0 +1,233 @@ + + + +

AdSense Platform API . platforms . accounts . sites

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a site for a specified account.

+

+ delete(name, x__xgafv=None)

+

Deletes a site from a specified account.

+

+ get(name, x__xgafv=None)

+

Gets a site from a specified sub-account.

+

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

+

Lists sites for a specific account.

+

+ list_next()

+

Retrieves the next page of results.

+

+ requestReview(name, x__xgafv=None)

+

Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a site for a specified account.
+
+Args:
+  parent: string, Required. Account to create site. Format: platforms/{platform}/accounts/{account_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Representation of a Site.
+  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+  "state": "A String", # Output only. State of a site.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a Site.
+  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+  "state": "A String", # Output only. State of a site.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a site from a specified account.
+
+Args:
+  name: string, Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a site from a specified sub-account.
+
+Args:
+  name: string, Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a Site.
+  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+  "state": "A String", # Output only. State of a site.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists sites for a specific account.
+
+Args:
+  parent: string, Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account} (required)
+  pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the site list rpc.
+  "nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this.
+  "sites": [ # The sites returned in this list response.
+    { # Representation of a Site.
+      "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+      "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+      "state": "A String", # Output only. State of a site.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ requestReview(name, x__xgafv=None) +
Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.
+
+Args:
+  name: string, Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the site request review rpc.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1alpha.platforms.html b/docs/dyn/adsenseplatform_v1alpha.platforms.html new file mode 100644 index 00000000000..dea2d7dab99 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1alpha.platforms.html @@ -0,0 +1,91 @@ + + + +

AdSense Platform API . platforms

+

Instance Methods

+

+ accounts() +

+

Returns the accounts Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.apprecovery.html b/docs/dyn/androidpublisher_v3.apprecovery.html index 7a7c4a08757..28ad483e802 100644 --- a/docs/dyn/androidpublisher_v3.apprecovery.html +++ b/docs/dyn/androidpublisher_v3.apprecovery.html @@ -77,9 +77,6 @@

Instance Methods

addTargeting(packageName, appRecoveryId, body=None, x__xgafv=None)

Incrementally update targeting for a recovery action. Note that only the criteria selected during the creation of recovery action can be expanded.

-

- appRecoveries(packageName, versionCode=None, x__xgafv=None)

-

List all app recovery action resources associated with a particular package name and app version.

cancel(packageName, appRecoveryId, body=None, x__xgafv=None)

Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.

@@ -92,6 +89,9 @@

Instance Methods

deploy(packageName, appRecoveryId, body=None, x__xgafv=None)

Deploy an already created app recovery action with recovery status DRAFT. Note that this action activates the recovery action for all targeted users and changes its status to ACTIVE.

+

+ list(packageName, versionCode=None, x__xgafv=None)

+

List all app recovery action resources associated with a particular package name and app version.

Method Details

addTargeting(packageName, appRecoveryId, body=None, x__xgafv=None) @@ -133,68 +133,6 @@

Method Details

}
-
- appRecoveries(packageName, versionCode=None, x__xgafv=None) -
List all app recovery action resources associated with a particular package name and app version.
-
-Args:
-  packageName: string, Required. Package name of the app for which list of recovery actions is requested. (required)
-  versionCode: string, Required. Version code targeted by the list of recovery actions.
-  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 ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled
-  "recoveryActions": [ # List of recovery actions associated with the requested package name.
-    { # Information about an app recovery action.
-      "appRecoveryId": "A String", # ID corresponding to the app recovery action.
-      "cancelTime": "A String", # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled.
-      "createTime": "A String", # Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action.
-      "deployTime": "A String", # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed.
-      "lastUpdateTime": "A String", # Timestamp of when the developer last updated recovery action. In case the action is cancelled, it corresponds to cancellation time. It is always set after creation of the recovery action.
-      "remoteInAppUpdateData": { # Data related to Remote In-App Update action such as recovered user count, affected user count etc. # Data about the remote in-app update action such as such as recovered user base, recoverable user base etc. Set only if the recovery action type is Remote In-App Update.
-        "remoteAppUpdateDataPerBundle": [ # Data related to the recovery action at bundle level.
-          { # Data related to the recovery action at bundle level.
-            "recoveredDeviceCount": "A String", # Total number of devices which have been rescued.
-            "totalDeviceCount": "A String", # Total number of devices affected by this recovery action associated with bundle of the app.
-            "versionCode": "A String", # Version Code corresponding to the target bundle.
-          },
-        ],
-      },
-      "status": "A String", # The status of the recovery action.
-      "targeting": { # Targeting details for a recovery action such as regions, android sdk levels, app versions etc. # Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc.
-        "allUsers": { # Object representation to describe all set of users. # All users are targeted.
-          "isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed.
-        },
-        "androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices.
-          "sdkLevels": [ # Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android.
-            "A String",
-          ],
-        },
-        "regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region.
-          "regionCode": [ # Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes.
-            "A String",
-          ],
-        },
-        "versionList": { # Data format for a list of app versions. # Target version codes as a list.
-          "versionCodes": [ # List of app version codes.
-            "A String",
-          ],
-        },
-        "versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range.
-          "versionCodeEnd": "A String", # Highest app version in the range, inclusive.
-          "versionCodeStart": "A String", # Lowest app version in the range, inclusive.
-        },
-      },
-    },
-  ],
-}
-
-
cancel(packageName, appRecoveryId, body=None, x__xgafv=None)
Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.
@@ -340,4 +278,66 @@ 

Method Details

}
+
+ list(packageName, versionCode=None, x__xgafv=None) +
List all app recovery action resources associated with a particular package name and app version.
+
+Args:
+  packageName: string, Required. Package name of the app for which list of recovery actions is requested. (required)
+  versionCode: string, Required. Version code targeted by the list of recovery actions.
+  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 ListAppRecoveries. -- api-linter: core::0158::response-next-page-token-field=disabled
+  "recoveryActions": [ # List of recovery actions associated with the requested package name.
+    { # Information about an app recovery action.
+      "appRecoveryId": "A String", # ID corresponding to the app recovery action.
+      "cancelTime": "A String", # Timestamp of when the app recovery action is canceled by the developer. Only set if the recovery action has been canceled.
+      "createTime": "A String", # Timestamp of when the app recovery action is created by the developer. It is always set after creation of the recovery action.
+      "deployTime": "A String", # Timestamp of when the app recovery action is deployed to the users. Only set if the recovery action has been deployed.
+      "lastUpdateTime": "A String", # Timestamp of when the developer last updated recovery action. In case the action is cancelled, it corresponds to cancellation time. It is always set after creation of the recovery action.
+      "remoteInAppUpdateData": { # Data related to Remote In-App Update action such as recovered user count, affected user count etc. # Data about the remote in-app update action such as such as recovered user base, recoverable user base etc. Set only if the recovery action type is Remote In-App Update.
+        "remoteAppUpdateDataPerBundle": [ # Data related to the recovery action at bundle level.
+          { # Data related to the recovery action at bundle level.
+            "recoveredDeviceCount": "A String", # Total number of devices which have been rescued.
+            "totalDeviceCount": "A String", # Total number of devices affected by this recovery action associated with bundle of the app.
+            "versionCode": "A String", # Version Code corresponding to the target bundle.
+          },
+        ],
+      },
+      "status": "A String", # The status of the recovery action.
+      "targeting": { # Targeting details for a recovery action such as regions, android sdk levels, app versions etc. # Specifies targeting criteria for the recovery action such as regions, android sdk versions, app versions etc.
+        "allUsers": { # Object representation to describe all set of users. # All users are targeted.
+          "isAllUsersRequested": True or False, # Required. Set to true if all set of users are needed.
+        },
+        "androidSdks": { # Android api level targeting data for app recovery action targeting. # Targeting is based on android api levels of devices.
+          "sdkLevels": [ # Android api levels of devices targeted by recovery action. See https://developer.android.com/guide/topics/manifest/uses-sdk-element#ApiLevels for different api levels in android.
+            "A String",
+          ],
+        },
+        "regions": { # Region targeting data for app recovery action targeting. # Targeting is based on the user account region.
+          "regionCode": [ # Regions targeted by the recovery action. Region codes are ISO 3166 Alpha-2 country codes. For example, US stands for United States of America. See https://www.iso.org/iso-3166-country-codes.html for the complete list of country codes.
+            "A String",
+          ],
+        },
+        "versionList": { # Data format for a list of app versions. # Target version codes as a list.
+          "versionCodes": [ # List of app version codes.
+            "A String",
+          ],
+        },
+        "versionRange": { # Data format for a continuous range of app versions. # Target version codes as a range.
+          "versionCodeEnd": "A String", # Highest app version in the range, inclusive.
+          "versionCodeStart": "A String", # Lowest app version in the range, inclusive.
+        },
+      },
+    },
+  ],
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/androidpublisher_v3.externaltransactions.html b/docs/dyn/androidpublisher_v3.externaltransactions.html index 87b674c4392..9bbb8ffa422 100644 --- a/docs/dyn/androidpublisher_v3.externaltransactions.html +++ b/docs/dyn/androidpublisher_v3.externaltransactions.html @@ -136,7 +136,7 @@

Method Details

}, "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. }, - "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. + "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. "transactionState": "A String", # Output only. The current state of the transaction. "transactionTime": "A String", # Required. The time when the transaction was completed. "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. @@ -189,7 +189,7 @@

Method Details

}, "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. }, - "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. + "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. "transactionState": "A String", # Output only. The current state of the transaction. "transactionTime": "A String", # Required. The time when the transaction was completed. "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. @@ -248,7 +248,7 @@

Method Details

}, "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. }, - "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. + "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. "transactionState": "A String", # Output only. The current state of the transaction. "transactionTime": "A String", # Required. The time when the transaction was completed. "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. @@ -323,7 +323,7 @@

Method Details

}, "testPurchase": { # Represents a transaction performed using a test account. These transactions will not be charged by Google. # Output only. If set, this transaction was a test purchase. Google will not charge for a test transaction. }, - "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. + "transactionProgramCode": 42, # Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions. "transactionState": "A String", # Output only. The current state of the transaction. "transactionTime": "A String", # Required. The time when the transaction was completed. "userTaxAddress": { # User's address for the external transaction. # Required. User address for tax computation. diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html index 0ff14748d2c..4bcdb61c3a4 100644 --- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html +++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.genericArtifacts.html @@ -97,7 +97,7 @@

Method Details

{ # The request to upload a generic artifact. The created GenericArtifact will have the resource name {parent}/genericArtifacts/package_id:version_id. The created file will have the resource name {parent}/files/package_id:version_id:filename. "filename": "A String", # The name of the file of the generic artifact to be uploaded. E.g. `example-file.zip` The filename is limited to letters, numbers, and url safe characters, i.e. [a-zA-Z0-9-_.~@]. - "packageId": "A String", # The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters. + "packageId": "A String", # The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` should start and end with a letter or number, only contain letters, numbers, hyphens, underscores, and periods, and not exceed 256 characters. "versionId": "A String", # The ID of the version of the generic artifact. If the version does not exist, a new version will be created. The version_id must start and end with a letter or number, can only contain lowercase letters, numbers, hyphens and periods, i.e. [a-z0-9-.] and cannot exceed a total of 128 characters. Creating a version called `latest` is not allowed. } diff --git a/docs/dyn/batch_v1.projects.locations.jobs.html b/docs/dyn/batch_v1.projects.locations.jobs.html index e292439499d..2f501200062 100644 --- a/docs/dyn/batch_v1.projects.locations.jobs.html +++ b/docs/dyn/batch_v1.projects.locations.jobs.html @@ -213,13 +213,13 @@

Method Details

"runDuration": "A String", # The duration of time that the Job spent in status RUNNING. "state": "A String", # Job state "statusEvents": [ # Job status events - { # Status event + { # Status event. "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State + "taskState": "A String", # Task State. This field is only defined for task-level status events. "type": "A String", # Type of the event. }, ], @@ -482,13 +482,13 @@

Method Details

"runDuration": "A String", # The duration of time that the Job spent in status RUNNING. "state": "A String", # Job state "statusEvents": [ # Job status events - { # Status event + { # Status event. "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State + "taskState": "A String", # Task State. This field is only defined for task-level status events. "type": "A String", # Type of the event. }, ], @@ -793,13 +793,13 @@

Method Details

"runDuration": "A String", # The duration of time that the Job spent in status RUNNING. "state": "A String", # Job state "statusEvents": [ # Job status events - { # Status event + { # Status event. "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State + "taskState": "A String", # Task State. This field is only defined for task-level status events. "type": "A String", # Type of the event. }, ], @@ -1073,13 +1073,13 @@

Method Details

"runDuration": "A String", # The duration of time that the Job spent in status RUNNING. "state": "A String", # Job state "statusEvents": [ # Job status events - { # Status event + { # Status event. "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State + "taskState": "A String", # Task State. This field is only defined for task-level status events. "type": "A String", # Type of the event. }, ], diff --git a/docs/dyn/batch_v1.projects.locations.jobs.taskGroups.tasks.html b/docs/dyn/batch_v1.projects.locations.jobs.taskGroups.tasks.html index 960050f9a90..70988349623 100644 --- a/docs/dyn/batch_v1.projects.locations.jobs.taskGroups.tasks.html +++ b/docs/dyn/batch_v1.projects.locations.jobs.taskGroups.tasks.html @@ -108,16 +108,16 @@

Method Details

{ # A Cloud Batch task. "name": "A String", # Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01". - "status": { # Status of a task # Task Status. - "state": "A String", # Task state + "status": { # Status of a task. # Task Status. + "state": "A String", # Task state. "statusEvents": [ # Detailed info about why the state is reached. - { # Status event + { # Status event. "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State + "taskState": "A String", # Task State. This field is only defined for task-level status events. "type": "A String", # Type of the event. }, ], @@ -147,16 +147,16 @@

Method Details

"tasks": [ # Tasks. { # A Cloud Batch task. "name": "A String", # Task name. The name is generated from the parent TaskGroup name and 'id' field. For example: "projects/123456/locations/us-west1/jobs/job01/taskGroups/group01/tasks/task01". - "status": { # Status of a task # Task Status. - "state": "A String", # Task state + "status": { # Status of a task. # Task Status. + "state": "A String", # Task state. "statusEvents": [ # Detailed info about why the state is reached. - { # Status event + { # Status event. "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State + "taskState": "A String", # Task State. This field is only defined for task-level status events. "type": "A String", # Type of the event. }, ], diff --git a/docs/dyn/batch_v1.projects.locations.state.html b/docs/dyn/batch_v1.projects.locations.state.html index 9552d1ffc75..af2c1eb10d2 100644 --- a/docs/dyn/batch_v1.projects.locations.state.html +++ b/docs/dyn/batch_v1.projects.locations.state.html @@ -105,16 +105,16 @@

Method Details

{ # Task Info "runnable": "A String", # The highest index of a runnable started by the agent for this task. The runnables are indexed from 1. Value 0 is undefined. "taskId": "A String", # ID of the Task - "taskStatus": { # Status of a task # The status of the Task. If we need agent specific fields we should fork the public TaskStatus into an agent specific one. Or add them below. - "state": "A String", # Task state + "taskStatus": { # Status of a task. # The status of the Task. If we need agent specific fields we should fork the public TaskStatus into an agent specific one. Or add them below. + "state": "A String", # Task state. "statusEvents": [ # Detailed info about why the state is reached. - { # Status event + { # Status event. "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State + "taskState": "A String", # Task State. This field is only defined for task-level status events. "type": "A String", # Type of the event. }, ], @@ -308,16 +308,16 @@

Method Details

}, ], }, - "status": { # Status of a task # Task status. - "state": "A String", # Task state + "status": { # Status of a task. # Task status. + "state": "A String", # Task state. "statusEvents": [ # Detailed info about why the state is reached. - { # Status event + { # Status event. "description": "A String", # Description of the event. "eventTime": "A String", # The time this event occurred. - "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution + "taskExecution": { # This Task Execution field includes detail information for task execution procedures, based on StatusEvent types. # Task Execution. This field is only defined for task-level status events where the task fails. "exitCode": 42, # The exit code of a finished task. If the task succeeded, the exit code will be 0. If the task failed but not due to the following reasons, the exit code will be 50000. Otherwise, it can be from different sources: * Batch known failures: https://cloud.google.com/batch/docs/troubleshooting#reserved-exit-codes. * Batch runnable execution failures; you can rely on Batch logs to further diagnose: https://cloud.google.com/batch/docs/analyze-job-using-logs. If there are multiple runnables failures, Batch only exposes the first error. }, - "taskState": "A String", # Task State + "taskState": "A String", # Task State. This field is only defined for task-level status events. "type": "A String", # Type of the event. }, ], diff --git a/docs/dyn/beyondcorp_v1alpha.organizations.locations.insights.html b/docs/dyn/beyondcorp_v1alpha.organizations.locations.insights.html index 22e2af1b8bd..b10c144d302 100644 --- a/docs/dyn/beyondcorp_v1alpha.organizations.locations.insights.html +++ b/docs/dyn/beyondcorp_v1alpha.organizations.locations.insights.html @@ -249,7 +249,7 @@

Method Details

Args: parent: string, Required. The resource name of InsightMetadata using the form: `organizations/{organization_id}/locations/{location}` `projects/{project_id}/locations/{location_id}` (required) - filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). + filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). orderBy: string, Optional. Hint for how to order the results. This is currently ignored. pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50. pageToken: string, Optional. A token identifying a page of results the server should return. diff --git a/docs/dyn/beyondcorp_v1alpha.projects.locations.insights.html b/docs/dyn/beyondcorp_v1alpha.projects.locations.insights.html index f5f265c13fb..6ce7bc89c0a 100644 --- a/docs/dyn/beyondcorp_v1alpha.projects.locations.insights.html +++ b/docs/dyn/beyondcorp_v1alpha.projects.locations.insights.html @@ -249,7 +249,7 @@

Method Details

Args: parent: string, Required. The resource name of InsightMetadata using the form: `organizations/{organization_id}/locations/{location}` `projects/{project_id}/locations/{location_id}` (required) - filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). + filter: string, Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * "category = application AND type = count" * "category = application AND subCategory = iap" * "type = status" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160). orderBy: string, Optional. Hint for how to order the results. This is currently ignored. pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. NOTE: Default page size is 50. pageToken: string, Optional. A token identifying a page of results the server should return. diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html index dc8892bdd22..6a341c28e0d 100644 --- a/docs/dyn/bigquery_v2.datasets.html +++ b/docs/dyn/bigquery_v2.datasets.html @@ -158,13 +158,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -260,13 +260,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -360,13 +360,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -520,13 +520,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -620,13 +620,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -735,13 +735,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -838,13 +838,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. @@ -938,13 +938,13 @@

Method Details

"domain": "A String", # [Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: "example.com". Maps to IAM policy member "domain:DOMAIN". "groupByEmail": "A String", # [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". "iamMember": "A String", # [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. - "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". + "role": "A String", # An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER". "routine": { # Id path of a routine. # [Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this routine. "projectId": "A String", # Required. The ID of the project containing this routine. "routineId": "A String", # Required. The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters. }, - "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. + "specialGroup": "A String", # [Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members. "userByEmail": "A String", # [Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member "user:EMAIL" or "serviceAccount:EMAIL". "view": { # [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to views/tables/routines in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. "datasetId": "A String", # Required. The ID of the dataset containing this table. diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index b8f7834e669..72773ff7108 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -417,7 +417,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -1815,7 +1815,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -3289,7 +3289,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -4658,7 +4658,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -6050,7 +6050,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html index f2c9865ad09..405765143ad 100644 --- a/docs/dyn/bigquery_v2.tables.html +++ b/docs/dyn/bigquery_v2.tables.html @@ -206,7 +206,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -678,7 +678,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -1091,7 +1091,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -1612,7 +1612,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -2026,7 +2026,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -2558,7 +2558,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. @@ -2972,7 +2972,7 @@

Method Details

"bigtableOptions": { # Options specific to Google Cloud Bigtable data sources. # Optional. Additional options if sourceFormat is set to BIGTABLE. "columnFamilies": [ # Optional. List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable. { # Information related to a Bigtable column family. - "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field. + "columns": [ # Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field. { # Information related to a Bigtable column. "encoding": "A String", # Optional. The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels. "fieldName": "A String", # Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name in queries. diff --git a/docs/dyn/calendar_v3.events.html b/docs/dyn/calendar_v3.events.html index f0fbbf739b9..be076afef8d 100644 --- a/docs/dyn/calendar_v3.events.html +++ b/docs/dyn/calendar_v3.events.html @@ -376,7 +376,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -413,7 +413,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -672,7 +672,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -709,7 +709,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -963,7 +963,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -1000,7 +1000,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -1258,7 +1258,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -1295,7 +1295,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -1558,7 +1558,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -1595,7 +1595,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -1884,7 +1884,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -1921,7 +1921,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -2275,7 +2275,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -2312,7 +2312,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -2603,7 +2603,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -2640,7 +2640,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -2899,7 +2899,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -2936,7 +2936,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -3200,7 +3200,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -3237,7 +3237,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -3505,7 +3505,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -3542,7 +3542,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -3801,7 +3801,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -3838,7 +3838,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. @@ -4102,7 +4102,7 @@

Method Details

"A String", ], "recurringEventId": "A String", # For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable. - "reminders": { # Information about the event's reminders for the authenticated user. + "reminders": { # Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event. "overrides": [ # If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5. { "method": "A String", # The method used by this reminder. Possible values are: @@ -4139,7 +4139,7 @@

Method Details

"transparency": "opaque", # Whether the event blocks time on the calendar. Optional. Possible values are: # - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. # - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI. - "updated": "A String", # Last modification time of the event (as a RFC3339 timestamp). Read-only. + "updated": "A String", # Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only. "visibility": "default", # Visibility of the event. Optional. Possible values are: # - "default" - Uses the default visibility for events on the calendar. This is the default value. # - "public" - The event is public and event details are visible to all readers of the calendar. diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index d60901f745d..4b2bc501b9e 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -149,12 +149,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The import mode space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -183,12 +183,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -216,12 +216,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -273,12 +273,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -312,12 +312,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -356,12 +356,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -406,12 +406,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -427,7 +427,7 @@

Method Details

"type": "A String", # Output only. Deprecated: Use `space_type` instead. The type of a space. } - updateMask: string, Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error. If you receive the error message `ALREADY_EXISTS` when updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error). `space_type` is not supported with admin access. - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.) `space_history_state` is not supported with admin access. - `access_settings.audience` (Supports changing the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. + updateMask: string, Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -439,12 +439,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -493,12 +493,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # Required. The `Space.spaceType` field is required. To create a space, set `Space.spaceType` to `SPACE` and set `Space.displayName`. If you receive the error message `ALREADY_EXISTS` when setting up a space, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. To create a group chat, set `Space.spaceType` to `GROUP_CHAT`. Don't set `Space.displayName`. To create a 1:1 conversation between humans, set `Space.spaceType` to `DIRECT_MESSAGE` and set `Space.singleUserBotDm` to `false`. Don't set `Space.displayName` or `Space.spaceDetails`. To create an 1:1 conversation between a human and the calling Chat app, set `Space.spaceType` to `DIRECT_MESSAGE` and `Space.singleUserBotDm` to `true`. Don't set `Space.displayName` or `Space.spaceDetails`. If a `DIRECT_MESSAGE` space already exists, that space is returned instead of creating a new space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -526,12 +526,12 @@

Method Details

{ # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index a27cfced554..2e3b0337bdd 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -1853,12 +1853,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -3627,12 +3627,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -5419,12 +5419,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -7199,12 +7199,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -8984,12 +8984,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -10752,12 +10752,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -12520,12 +12520,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -14288,12 +14288,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index bad59df17dd..71bca4dc5e4 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -1968,12 +1968,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -3731,12 +3731,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -5494,12 +5494,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -7255,12 +7255,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -9014,12 +9014,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -10773,12 +10773,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -10888,12 +10888,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -10915,12 +10915,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -12821,12 +12821,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -14584,12 +14584,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -16347,12 +16347,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -18108,12 +18108,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -19867,12 +19867,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -21626,12 +21626,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # If your Chat app [authenticates as a user](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user), the output populates the [space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces) `name`. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -21741,12 +21741,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. @@ -21768,12 +21768,12 @@

Method Details

"space": { # A space in Google Chat. Spaces are conversations between two or more users or 1:1 messages between a user and a Chat app. # The updated space. "accessSettings": { # Represents the [access setting](https://support.google.com/chat/answer/11971020) of the space. # Optional. Specifies the [access setting](https://support.google.com/chat/answer/11971020) of the space. Only populated when the `space_type` is `SPACE`. "accessState": "A String", # Output only. Indicates the access state of the space. - "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. + "audience": "A String", # Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`. }, "adminInstalled": True or False, # Output only. For direct message (DM) spaces with a Chat app, whether the space was created by a Google Workspace administrator. Administrators can install and set up a direct message with a Chat app on behalf of users in their organization. To support admin install, your Chat app must feature direct messaging. "createTime": "A String", # Optional. Immutable. For spaces created in Chat, the time the space was created. This field is output only, except when used in import mode spaces. For import mode spaces, set this field to the historical timestamp at which the space was created in the source in order to preserve the original creation time. Only populated in the output when `spaceType` is `GROUP_CHAT` or `SPACE`. "displayName": "A String", # The space's display name. Required when [creating a space](https://developers.google.com/workspace/chat/api/reference/rest/v1/spaces/create). If you receive the error message `ALREADY_EXISTS` when creating a space or updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name. For direct messages, this field might be empty. Supports up to 128 characters. - "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only. + "externalUserAllowed": True or False, # Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only. "importMode": True or False, # Optional. Whether this space is created in `Import Mode` as part of a data migration into Google Workspace. While spaces are being imported, they aren't visible to users until the import is complete. "name": "A String", # Resource name of the space. Format: `spaces/{space}` "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. diff --git a/docs/dyn/chromemanagement_v1.customers.reports.html b/docs/dyn/chromemanagement_v1.customers.reports.html index 018ba0b2858..2cf118d0d2b 100644 --- a/docs/dyn/chromemanagement_v1.customers.reports.html +++ b/docs/dyn/chromemanagement_v1.customers.reports.html @@ -340,8 +340,8 @@

Method Details

Args: customer: string, Required. Customer id or "my_customer" to use the customer associated to the account making the request. (required) - filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id - orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id + filter: string, Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions + orderBy: string, Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions orgUnitId: string, The ID of the organizational unit. pageSize: integer, Maximum number of results to return. Maximum and default are 100. pageToken: string, Token to specify the page of the request to be returned. diff --git a/docs/dyn/cloudbuild_v1.projects.builds.html b/docs/dyn/cloudbuild_v1.projects.builds.html index b8baf936d51..b170d1787da 100644 --- a/docs/dyn/cloudbuild_v1.projects.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.builds.html @@ -248,7 +248,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -618,7 +618,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1019,7 +1019,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1395,7 +1395,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.builds.html b/docs/dyn/cloudbuild_v1.projects.locations.builds.html index 2740973c710..db839e27767 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.builds.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.builds.html @@ -247,7 +247,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -617,7 +617,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1018,7 +1018,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1394,7 +1394,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. diff --git a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html index 7e6f644ccd4..9214132e968 100644 --- a/docs/dyn/cloudbuild_v1.projects.locations.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.locations.triggers.html @@ -236,7 +236,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -775,7 +775,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1342,7 +1342,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1893,7 +1893,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -2449,7 +2449,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -2990,7 +2990,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. diff --git a/docs/dyn/cloudbuild_v1.projects.triggers.html b/docs/dyn/cloudbuild_v1.projects.triggers.html index ce2d032ff9a..662205fc333 100644 --- a/docs/dyn/cloudbuild_v1.projects.triggers.html +++ b/docs/dyn/cloudbuild_v1.projects.triggers.html @@ -236,7 +236,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -775,7 +775,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1342,7 +1342,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -1893,7 +1893,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -2450,7 +2450,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. @@ -2989,7 +2989,7 @@

Method Details

"finishTime": "A String", # Output only. Time at which execution of the build was finished. The difference between finish_time and start_time is the duration of the build's execution. "gitConfig": { # GitConfig is a configuration for git operations. # Optional. Configuration for git operations. "http": { # HttpConfig is a configuration for HTTP related git operations. # Configuration for HTTP related git operations. - "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port]. + "proxySecretVersionName": "A String", # SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`. }, }, "id": "A String", # Output only. Unique identifier of the build. diff --git a/docs/dyn/clouderrorreporting_v1beta1.projects.events.html b/docs/dyn/clouderrorreporting_v1beta1.projects.events.html index 0400c19df2d..b66c01228d6 100644 --- a/docs/dyn/clouderrorreporting_v1beta1.projects.events.html +++ b/docs/dyn/clouderrorreporting_v1beta1.projects.events.html @@ -206,7 +206,7 @@

Method Details

"user": "A String", # The user who caused or was affected by the crash. This can be a user ID, an email address, or an arbitrary token that uniquely identifies the user. When sending an error report, leave this field empty if the user was not logged in. In this case the Error Reporting system will use other data, such as remote IP address, to distinguish affected users. See `affected_users_count` in `ErrorGroupStats`. }, "eventTime": "A String", # Optional. Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system is used. If provided, the time must not exceed the [logs retention period](https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, or be more than 24 hours in the future. If an invalid time is provided, then an error is returned. - "message": "A String", # Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack). + "message": "A String", # Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack). "serviceContext": { # Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel. # Required. The service context in which this error has occurred. "resourceType": "A String", # Type of the MonitoredResource. List of possible values: https://cloud.google.com/monitoring/api/resources Value is set automatically for incoming errors and must not be set when reporting errors. "service": "A String", # An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to `version`, which can be changed whenever new code is deployed. Contains the service name for error reports extracted from Google App Engine logs or `default` if the App Engine default service is used. diff --git a/docs/dyn/compute_alpha.backendServices.html b/docs/dyn/compute_alpha.backendServices.html index 5da6fa53131..000cfc0abfb 100644 --- a/docs/dyn/compute_alpha.backendServices.html +++ b/docs/dyn/compute_alpha.backendServices.html @@ -300,6 +300,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -739,9 +746,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -1069,6 +1076,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -1508,9 +1522,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -1679,6 +1693,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -2118,9 +2139,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -2272,6 +2293,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -2711,9 +2739,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -2763,6 +2791,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -3202,9 +3237,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -3270,6 +3305,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -3709,9 +3751,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -4349,6 +4391,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -4788,9 +4837,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. diff --git a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html index ddf7f384898..b5be2cae7c0 100644 --- a/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.globalNetworkEndpointGroups.html @@ -122,7 +122,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -398,7 +397,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -551,7 +549,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -616,7 +613,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -811,7 +807,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -920,7 +915,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index 9216cea065b..c3fd7e97f85 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -363,7 +363,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1324,7 +1324,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1524,7 +1524,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1854,7 +1854,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2407,7 +2407,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -4279,7 +4279,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_alpha.instanceTemplates.html b/docs/dyn/compute_alpha.instanceTemplates.html index 9af4028e419..adaa57adc6e 100644 --- a/docs/dyn/compute_alpha.instanceTemplates.html +++ b/docs/dyn/compute_alpha.instanceTemplates.html @@ -390,7 +390,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -932,7 +932,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1392,7 +1392,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1887,7 +1887,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.instances.html b/docs/dyn/compute_alpha.instances.html index c6fd5ecc13e..6ad330494e5 100644 --- a/docs/dyn/compute_alpha.instances.html +++ b/docs/dyn/compute_alpha.instances.html @@ -1029,7 +1029,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -1068,7 +1068,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1731,7 +1731,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -2764,7 +2764,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -2803,7 +2803,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -3822,7 +3822,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -3861,7 +3861,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -4399,7 +4399,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -4438,7 +4438,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -6621,7 +6621,7 @@

Method Details

{ # Sets the scheduling options for an Instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -8436,7 +8436,7 @@

Method Details

}, "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "serviceIntegrationStatuses": { # [Output Only] Represents the status of the service integration specs defined by the user in instance.serviceIntegrationSpecs. @@ -8475,7 +8475,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.machineImages.html b/docs/dyn/compute_alpha.machineImages.html index 3fef14c548c..bc41011422a 100644 --- a/docs/dyn/compute_alpha.machineImages.html +++ b/docs/dyn/compute_alpha.machineImages.html @@ -502,7 +502,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -742,7 +742,7 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1172,7 +1172,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1412,7 +1412,7 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1873,7 +1873,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -2113,7 +2113,7 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.networkEndpointGroups.html b/docs/dyn/compute_alpha.networkEndpointGroups.html index d1a59909e5b..12190e30f0c 100644 --- a/docs/dyn/compute_alpha.networkEndpointGroups.html +++ b/docs/dyn/compute_alpha.networkEndpointGroups.html @@ -149,7 +149,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -258,7 +257,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -536,7 +534,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -690,7 +687,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -756,7 +752,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -952,7 +947,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -1033,7 +1027,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -1086,7 +1079,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_alpha.regionBackendServices.html b/docs/dyn/compute_alpha.regionBackendServices.html index 98226353b9b..c38ac05ac86 100644 --- a/docs/dyn/compute_alpha.regionBackendServices.html +++ b/docs/dyn/compute_alpha.regionBackendServices.html @@ -273,6 +273,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -712,9 +719,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -886,6 +893,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -1325,9 +1339,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -1480,6 +1494,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -1919,9 +1940,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -1972,6 +1993,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -2411,9 +2439,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -2480,6 +2508,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -2919,9 +2954,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. @@ -3431,6 +3466,13 @@

Method Details

{ # Message containing information of one individual backend. "balancingMode": "A String", # Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected. "capacityScaler": 3.14, # A multiplier applied to the backend's target capacity of its balancing mode. The default value is 1, which means the group serves up to 100% of its configured capacity (depending on balancingMode). A setting of 0 means the group is completely drained, offering 0% of its available capacity. The valid ranges are 0.0 and [0.1,1.0]. You cannot configure a setting larger than 0 and smaller than 0.1. You cannot configure a setting of 0 when there is only one backend attached to the backend service. Not available with backends that don't support using a balancingMode. This includes backends such as global internet NEGs, regional serverless NEGs, and PSC NEGs. + "customMetrics": [ # List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy. + { # 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. + }, + ], "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "failover": True or False, # This field designates whether this is a failover backend. More than one failover backend can be configured for a given BackendService. "group": "A String", # The fully-qualified URL of an instance group or network endpoint group (NEG) resource. To determine what types of backends a load balancer supports, see the [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service#backends). You must use the *fully-qualified* URL (starting with https://www.googleapis.com/) to specify the instance group or NEG. Partial URLs are not supported. @@ -3870,9 +3912,9 @@

Method Details

"subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], "vpcNetworkScope": "A String", # The network scope of the backends that can be added to the backend service. This field can be either GLOBAL_VPC_NETWORK or REGIONAL_VPC_NETWORK. A backend service with the VPC scope set to GLOBAL_VPC_NETWORK is only allowed to have backends in global VPC networks. When the VPC scope is set to REGIONAL_VPC_NETWORK the backend service is only allowed to have backends in regional networks in the same scope as the backend service. Note: if not specified then GLOBAL_VPC_NETWORK will be used. diff --git a/docs/dyn/compute_alpha.regionCommitments.html b/docs/dyn/compute_alpha.regionCommitments.html index 98e0b78b3dd..93ee59d3c5d 100644 --- a/docs/dyn/compute_alpha.regionCommitments.html +++ b/docs/dyn/compute_alpha.regionCommitments.html @@ -141,6 +141,7 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -201,6 +202,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -272,6 +276,7 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, + "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -611,6 +616,7 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -671,6 +677,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -742,6 +751,7 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, + "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -774,6 +784,7 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -834,6 +845,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -905,6 +919,7 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, + "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -1067,6 +1082,7 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -1127,6 +1143,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -1198,6 +1217,7 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, + "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -1292,6 +1312,7 @@

Method Details

"autoRenew": True or False, # Specifies whether to enable automatic renewal for the commitment. The default value is false if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment. "category": "A String", # The category of the commitment. Category MACHINE specifies commitments composed of machine resources such as VCPU or MEMORY, listed in resources. Category LICENSE specifies commitments composed of software licenses, listed in licenseResources. Note that only MACHINE commitments should have a Type specified. "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format. + "customEndTimestamp": "A String", # [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration. "description": "A String", # An optional description of this resource. Provide this property when you create the resource. "endTimestamp": "A String", # [Output Only] Commitment end time in RFC3339 text format. "existingReservations": [ # Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: - https://www.googleapis.com/compute/v1/projects/project/zones/zone /reservations/reservation - projects/project/zones/zone/reservations/reservation @@ -1352,6 +1373,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -1423,6 +1447,7 @@

Method Details

}, "cancellationFeeExpirationTimestamp": "A String", # [Output Only] An optional, cancellation fee expiration time. RFC3339 text format. }, + "customTermEligibilityEndTimestamp": "A String", # [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected. }, "resources": [ # A list of commitment amounts for particular resources. Note that VCPU and MEMORY resource commitments must occur together. { # Commitment for a particular resource (a Commitment is composed of one or more of these). @@ -1614,6 +1639,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index 1d18d8b9938..c73db1a04e9 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -1055,7 +1055,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1255,7 +1255,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1585,7 +1585,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2138,7 +2138,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -4010,7 +4010,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_alpha.regionInstanceTemplates.html b/docs/dyn/compute_alpha.regionInstanceTemplates.html index 7797342bd82..6060cae0968 100644 --- a/docs/dyn/compute_alpha.regionInstanceTemplates.html +++ b/docs/dyn/compute_alpha.regionInstanceTemplates.html @@ -501,7 +501,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -862,7 +862,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1358,7 +1358,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.regionInstances.html b/docs/dyn/compute_alpha.regionInstances.html index d3705e89685..974d460769d 100644 --- a/docs/dyn/compute_alpha.regionInstances.html +++ b/docs/dyn/compute_alpha.regionInstances.html @@ -343,7 +343,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_alpha.regionMultiMigs.html b/docs/dyn/compute_alpha.regionMultiMigs.html index b2f9b9dab0e..a683dc258e9 100644 --- a/docs/dyn/compute_alpha.regionMultiMigs.html +++ b/docs/dyn/compute_alpha.regionMultiMigs.html @@ -279,7 +279,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -502,7 +502,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -856,7 +856,7 @@

Method Details

}, }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html index bac637f5d15..6580445b3c5 100644 --- a/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_alpha.regionNetworkEndpointGroups.html @@ -123,7 +123,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -401,7 +400,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -555,7 +553,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -621,7 +618,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -817,7 +813,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -927,7 +922,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_alpha.regions.html b/docs/dyn/compute_alpha.regions.html index 53036e0a87f..f211f4d1b18 100644 --- a/docs/dyn/compute_alpha.regions.html +++ b/docs/dyn/compute_alpha.regions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

get(project, region, x__xgafv=None)

-

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.

+

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

@@ -94,7 +94,7 @@

Method Details

get(project, region, x__xgafv=None) -
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.
+  
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_alpha.reservations.html b/docs/dyn/compute_alpha.reservations.html
index 297b9e72cdc..35e904ff4cc 100644
--- a/docs/dyn/compute_alpha.reservations.html
+++ b/docs/dyn/compute_alpha.reservations.html
@@ -181,6 +181,9 @@ 

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -465,6 +468,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -669,6 +675,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -902,6 +911,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. @@ -1404,6 +1416,9 @@

Method Details

"resourceStatus": { # [Output Only] Contains output only fields. # [Output Only] Status information for Reservation resource. "specificSkuAllocation": { # Contains Properties set for the reservation. # Allocation Properties of this reservation. "sourceInstanceTemplateId": "A String", # ID of the instance template used to populate reservation properties. + "utilizations": { # Per service utilization breakdown. The Key is the Google Cloud managed service name. + "a_key": "A String", + }, }, }, "satisfiesPzs": True or False, # [Output Only] Reserved for future use. diff --git a/docs/dyn/compute_alpha.resourcePolicies.html b/docs/dyn/compute_alpha.resourcePolicies.html index c599628f975..11be35d2982 100644 --- a/docs/dyn/compute_alpha.resourcePolicies.html +++ b/docs/dyn/compute_alpha.resourcePolicies.html @@ -226,6 +226,9 @@

Method Details

}, }, }, + "workloadPolicy": { # Represents the workload policy. + "type": "A String", + }, }, ], "warning": { # Informational warning which replaces the list of resourcePolicies when the list is empty. @@ -508,6 +511,9 @@

Method Details

}, }, }, + "workloadPolicy": { # Represents the workload policy. + "type": "A String", + }, }
@@ -710,6 +716,9 @@

Method Details

}, }, }, + "workloadPolicy": { # Represents the workload policy. + "type": "A String", + }, } requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @@ -942,6 +951,9 @@

Method Details

}, }, }, + "workloadPolicy": { # Represents the workload policy. + "type": "A String", + }, }, ], "kind": "compute#resourcePolicyList", # [Output Only] Type of resource.Always compute#resourcePoliciesList for listsof resourcePolicies @@ -1073,6 +1085,9 @@

Method Details

}, }, }, + "workloadPolicy": { # Represents the workload policy. + "type": "A String", + }, } paths: string, A parameter (repeated) diff --git a/docs/dyn/compute_alpha.vpnGateways.html b/docs/dyn/compute_alpha.vpnGateways.html index b8e2b49648c..46601754f8b 100644 --- a/docs/dyn/compute_alpha.vpnGateways.html +++ b/docs/dyn/compute_alpha.vpnGateways.html @@ -148,7 +148,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -365,7 +365,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -440,7 +440,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -606,7 +606,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. diff --git a/docs/dyn/compute_alpha.zoneQueuedResources.html b/docs/dyn/compute_alpha.zoneQueuedResources.html index e7a75e81175..29fc233a353 100644 --- a/docs/dyn/compute_alpha.zoneQueuedResources.html +++ b/docs/dyn/compute_alpha.zoneQueuedResources.html @@ -381,7 +381,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1128,7 +1128,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -1568,7 +1568,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. @@ -2138,7 +2138,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. - "availabilityDomain": 42, # Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "currentCpus": 42, # Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. "currentMemoryMb": "A String", # Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. "gracefulShutdown": { # Configuration for gracefully shutting down the instance. diff --git a/docs/dyn/compute_beta.backendServices.html b/docs/dyn/compute_beta.backendServices.html index 17f6f9b00c3..50d3bb643e5 100644 --- a/docs/dyn/compute_beta.backendServices.html +++ b/docs/dyn/compute_beta.backendServices.html @@ -487,14 +487,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -1007,14 +1015,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }
@@ -1370,14 +1386,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } @@ -1715,14 +1739,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -1959,14 +1991,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -2219,14 +2259,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } @@ -3048,14 +3096,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } diff --git a/docs/dyn/compute_beta.firewallPolicies.html b/docs/dyn/compute_beta.firewallPolicies.html index 5e607354b89..478eea6f577 100644 --- a/docs/dyn/compute_beta.firewallPolicies.html +++ b/docs/dyn/compute_beta.firewallPolicies.html @@ -77,6 +77,9 @@

Instance Methods

addAssociation(firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)

Inserts an association for the specified firewall policy.

+

+ addPacketMirroringRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)

+

Inserts a packet mirroring rule into a firewall policy.

addRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)

Inserts a rule into a firewall policy.

@@ -98,6 +101,9 @@

Instance Methods

getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

+

+ getPacketMirroringRule(firewallPolicy, priority=None, x__xgafv=None)

+

Gets a packet mirroring rule of the specified priority.

getRule(firewallPolicy, priority=None, x__xgafv=None)

Gets a rule of the specified priority.

@@ -119,12 +125,18 @@

Instance Methods

patch(firewallPolicy, body=None, requestId=None, x__xgafv=None)

Patches the specified policy with the data included in the request.

+

+ patchPacketMirroringRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

+

Patches a packet mirroring rule of the specified priority.

patchRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

Patches a rule of the specified priority.

removeAssociation(firewallPolicy, name=None, requestId=None, x__xgafv=None)

Removes an association for the specified firewall policy.

+

+ removePacketMirroringRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)

+

Deletes a packet mirroring rule of the specified priority.

removeRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)

Deletes a rule of the specified priority.

@@ -270,6 +282,204 @@

Method Details

}
+
+ addPacketMirroringRule(firewallPolicy, body=None, requestId=None, x__xgafv=None) +
Inserts a packet mirroring rule into a firewall policy.
+
+Args:
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+      {
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+      },
+    ],
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+
addRule(firewallPolicy, body=None, requestId=None, x__xgafv=None)
Inserts a rule into a firewall policy.
@@ -751,10 +961,7 @@ 

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. - "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. - "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". "description": "A String", # An optional description for this resource. @@ -827,58 +1034,134 @@

Method Details

"tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. }, ], - "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. -}
-
- -
- getAssociation(firewallPolicy, name=None, x__xgafv=None) -
Gets an association with the specified name.
-
-Args:
-  firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
-  name: string, The name of the association to get from the firewall policy.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    {
-  "attachmentTarget": "A String", # The target that the firewall policy is attached to.
-  "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
-  "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.
-  "name": "A String", # The name for an association.
-  "shortName": "A String", # [Output Only] The short name of the firewall policy of the association.
-}
-
- -
- getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None) -
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
-
-Args:
-  resource: string, Name or id of the resource for this request. (required)
-  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
-  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",
+  "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
+  "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
+  "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+      "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+      "description": "A String", # An optional description for this resource.
+      "direction": "A String", # The direction in which this rule applies.
+      "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+      "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+      "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+          "A String",
+        ],
+        "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+          "A String",
+        ],
+        "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+          "A String",
+        ],
+        "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+          "A String",
+        ],
+        "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+          {
+            "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+            "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+              "A String",
+            ],
+          },
+        ],
+        "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+          "A String",
+        ],
+        "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+          "A String",
+        ],
+        "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+          "A String",
+        ],
+        "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+          {
+            "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+            "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+          },
+        ],
+        "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+          "A String",
+        ],
+      },
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+      "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+      "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+      "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+      "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+        "A String",
+      ],
+      "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+        {
+          "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+          "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+        },
+      ],
+      "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+        "A String",
+      ],
+      "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+    },
+  ],
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+}
+
+ +
+ getAssociation(firewallPolicy, name=None, x__xgafv=None) +
Gets an association with the specified name.
+
+Args:
+  firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
+  name: string, The name of the association to get from the firewall policy.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "attachmentTarget": "A String", # The target that the firewall policy is attached to.
+  "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
+  "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.
+  "name": "A String", # The name for an association.
+  "shortName": "A String", # [Output Only] The short name of the firewall policy of the association.
+}
+
+ +
+ getIamPolicy(resource, optionsRequestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+
+Args:
+  resource: string, Name or id of the resource for this request. (required)
+  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+  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",
           ],
           "ignoreChildExemptions": True or False, # This is deprecated and has no effect. Do not use.
           "logType": "A String", # The log type that this config enables.
@@ -956,6 +1239,94 @@ 

Method Details

}
+
+ getPacketMirroringRule(firewallPolicy, priority=None, x__xgafv=None) +
Gets a packet mirroring rule of the specified priority.
+
+Args:
+  firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
+  priority: integer, The priority of the rule to get from the firewall policy.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+      {
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+      },
+    ],
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+}
+
+
getRule(firewallPolicy, priority=None, x__xgafv=None)
Gets a rule of the specified priority.
@@ -1069,10 +1440,7 @@ 

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. - "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. - "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". "description": "A String", # An optional description for this resource. @@ -1145,44 +1513,120 @@

Method Details

"tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. }, ], - "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. -} - - parentId: string, Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. - requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period. - "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. - "creationTimestamp": "A String", # [Deprecated] This field is deprecated. - "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. - "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. - "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. - "errors": [ # [Output Only] The array of errors encountered while processing this operation. - { - "code": "A String", # [Output Only] The error type identifier for this error. - "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. - { - "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } - "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". - "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request. - "a_key": "A String", - }, - "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. - }, - "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. - "links": [ # URL(s) pointing to additional information on handling the current error. - { # Describes a URL link. - "description": "A String", # Describes what the link offers. - "url": "A String", # The URL of the link. + "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. + "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. + "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. + "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. +} + + parentId: string, Parent ID for this request. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization. + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. + "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. }, ], }, @@ -1307,6 +1751,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1449,9 +1966,505 @@

Method Details

move(firewallPolicy, parentId=None, requestId=None, x__xgafv=None)
Moves the specified firewall policy.
 
-Args:
-  firewallPolicy: string, Name of the firewall policy to update. (required)
-  parentId: string, The new parent of the firewall policy. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
+Args:
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  parentId: string, The new parent of the firewall policy. The ID can be either be "folders/[FOLDER_ID]" if the parent is a folder or "organizations/[ORGANIZATION_ID]" if the parent is an organization.
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ patch(firewallPolicy, body=None, requestId=None, x__xgafv=None) +
Patches the specified policy with the data included in the request.
+
+Args:
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a Firewall Policy resource.
+  "associations": [ # A list of associations that belong to this firewall policy.
+    {
+      "attachmentTarget": "A String", # The target that the firewall policy is attached to.
+      "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
+      "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.
+      "name": "A String", # The name for an association.
+      "shortName": "A String", # [Output Only] The short name of the firewall policy of the association.
+    },
+  ],
+  "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.
+  "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
+  "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
+  "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy.
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+      "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+      "description": "A String", # An optional description for this resource.
+      "direction": "A String", # The direction in which this rule applies.
+      "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+      "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+      "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+          "A String",
+        ],
+        "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+          "A String",
+        ],
+        "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+          "A String",
+        ],
+        "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+          "A String",
+        ],
+        "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+          {
+            "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+            "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+              "A String",
+            ],
+          },
+        ],
+        "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+          "A String",
+        ],
+        "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+          "A String",
+        ],
+        "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+          "A String",
+        ],
+        "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+          {
+            "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+            "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+          },
+        ],
+        "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+          "A String",
+        ],
+      },
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+      "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+      "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+      "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+      "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+        "A String",
+      ],
+      "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+        {
+          "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+          "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+        },
+      ],
+      "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+        "A String",
+      ],
+      "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+    },
+  ],
+  "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
+  "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
+  "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+      "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+      "description": "A String", # An optional description for this resource.
+      "direction": "A String", # The direction in which this rule applies.
+      "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+      "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+      "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+          "A String",
+        ],
+        "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+          "A String",
+        ],
+        "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+          "A String",
+        ],
+        "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+          "A String",
+        ],
+        "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+          {
+            "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+            "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+              "A String",
+            ],
+          },
+        ],
+        "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+          "A String",
+        ],
+        "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+          "A String",
+        ],
+        "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+          "A String",
+        ],
+        "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+          {
+            "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+            "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+          },
+        ],
+        "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+          "A String",
+        ],
+      },
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+      "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+      "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+      "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+      "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+        "A String",
+      ],
+      "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+        {
+          "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+          "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+        },
+      ],
+      "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+        "A String",
+      ],
+      "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+    },
+  ],
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ patchPacketMirroringRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None) +
Patches a packet mirroring rule of the specified priority.
+
+Args:
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+      {
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+      },
+    ],
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+}
+
+  priority: integer, The priority of the rule to patch.
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1570,112 +2583,87 @@ 

Method Details

- patch(firewallPolicy, body=None, requestId=None, x__xgafv=None) -
Patches the specified policy with the data included in the request.
+    patchRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)
+  
Patches a rule of the specified priority.
 
 Args:
   firewallPolicy: string, Name of the firewall policy to update. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # Represents a Firewall Policy resource.
-  "associations": [ # A list of associations that belong to this firewall policy.
-    {
-      "attachmentTarget": "A String", # The target that the firewall policy is attached to.
-      "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
-      "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.
-      "name": "A String", # The name for an association.
-      "shortName": "A String", # [Output Only] The short name of the firewall policy of the association.
-    },
-  ],
-  "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.
-  "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
-  "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy.
-  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
-  "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies
-  "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.
-  "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
-  "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
-  "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
-  "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
-    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
-      "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
-      "description": "A String", # An optional description for this resource.
-      "direction": "A String", # The direction in which this rule applies.
-      "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
-      "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
-      "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
-      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
-        "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
-          "A String",
-        ],
-        "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
-          "A String",
-        ],
-        "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
-          "A String",
-        ],
-        "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
-          "A String",
-        ],
-        "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
-          "A String",
-        ],
-        "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
-          {
-            "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
-            "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
-              "A String",
-            ],
-          },
-        ],
-        "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
-          "A String",
-        ],
-        "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
-          "A String",
-        ],
-        "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
-          "A String",
-        ],
-        "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
-          "A String",
-        ],
-        "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
-          {
-            "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-            "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-          },
-        ],
-        "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
           "A String",
         ],
       },
-      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
-      "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
-      "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
-      "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
-      "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
-        "A String",
-      ],
-      "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
-        {
-          "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-          "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-        },
-      ],
-      "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
-        "A String",
-      ],
-      "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+      {
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+      },
+    ],
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
     },
   ],
-  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
-  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
-  "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
 }
 
+  priority: integer, The priority of the rule to patch.
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1794,87 +2782,12 @@ 

Method Details

- patchRule(firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None) -
Patches a rule of the specified priority.
+    removeAssociation(firewallPolicy, name=None, requestId=None, x__xgafv=None)
+  
Removes an association for the specified firewall policy.
 
 Args:
   firewallPolicy: string, Name of the firewall policy to update. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
-  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
-  "description": "A String", # An optional description for this resource.
-  "direction": "A String", # The direction in which this rule applies.
-  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
-  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
-  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
-  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
-    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
-      "A String",
-    ],
-    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
-      "A String",
-    ],
-    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
-      "A String",
-    ],
-    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
-      "A String",
-    ],
-    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
-      {
-        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
-        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
-          "A String",
-        ],
-      },
-    ],
-    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
-      "A String",
-    ],
-    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
-      "A String",
-    ],
-    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
-      "A String",
-    ],
-    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
-      "A String",
-    ],
-    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
-      {
-        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-      },
-    ],
-    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
-      "A String",
-    ],
-  },
-  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
-  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
-  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
-  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
-  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
-    "A String",
-  ],
-  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
-    {
-      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
-      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
-    },
-  ],
-  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
-    "A String",
-  ],
-  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
-}
-
-  priority: integer, The priority of the rule to patch.
+  name: string, Name for the attachment that will be removed.
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1993,12 +2906,12 @@ 

Method Details

- removeAssociation(firewallPolicy, name=None, requestId=None, x__xgafv=None) -
Removes an association for the specified firewall policy.
+    removePacketMirroringRule(firewallPolicy, priority=None, requestId=None, x__xgafv=None)
+  
Deletes a packet mirroring rule of the specified priority.
 
 Args:
   firewallPolicy: string, Name of the firewall policy to update. (required)
-  name: string, Name for the attachment that will be removed.
+  priority: integer, The priority of the rule to remove from the firewall policy.
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
diff --git a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html
index 807675efb3a..dfcebb7f00e 100644
--- a/docs/dyn/compute_beta.globalNetworkEndpointGroups.html
+++ b/docs/dyn/compute_beta.globalNetworkEndpointGroups.html
@@ -122,7 +122,6 @@ 

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -395,7 +394,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -546,7 +544,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -608,7 +605,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -799,7 +795,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -905,7 +900,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_beta.instanceGroupManagers.html b/docs/dyn/compute_beta.instanceGroupManagers.html index 94b629af2ff..98028635474 100644 --- a/docs/dyn/compute_beta.instanceGroupManagers.html +++ b/docs/dyn/compute_beta.instanceGroupManagers.html @@ -354,7 +354,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1289,7 +1289,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1472,7 +1472,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1784,7 +1784,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2315,7 +2315,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -4150,7 +4150,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_beta.instanceTemplates.html b/docs/dyn/compute_beta.instanceTemplates.html index 5d976323b2d..f18bae10d34 100644 --- a/docs/dyn/compute_beta.instanceTemplates.html +++ b/docs/dyn/compute_beta.instanceTemplates.html @@ -367,6 +367,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -862,6 +863,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1276,6 +1278,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1724,6 +1727,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.instances.html b/docs/dyn/compute_beta.instances.html index 456538715be..89fa8799191 100644 --- a/docs/dyn/compute_beta.instances.html +++ b/docs/dyn/compute_beta.instances.html @@ -798,6 +798,7 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -813,6 +814,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1411,6 +1413,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -2260,6 +2263,7 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -2275,6 +2279,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -2374,6 +2379,7 @@

Method Details

{ "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. + "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. "rules": [ # The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". @@ -3201,6 +3207,7 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -3216,6 +3223,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -3689,6 +3697,7 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -3704,6 +3713,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -5837,6 +5847,7 @@

Method Details

{ # Sets the scheduling options for an Instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -7594,6 +7605,7 @@

Method Details

"resourceStatus": { # Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls. # [Output Only] Specifies values set for instance attributes as compared to the values requested by user in the corresponding input only field. "physicalHost": "A String", # [Output Only] An opaque ID of the host on which the VM is running. "scheduling": { + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "terminationTimestamp": "A String", # Time in future when the instance will be terminated in RFC3339 text format. }, "upcomingMaintenance": { # Upcoming Maintenance notification information. @@ -7609,6 +7621,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.machineImages.html b/docs/dyn/compute_beta.machineImages.html index 882a57ad2ae..97ee34070a2 100644 --- a/docs/dyn/compute_beta.machineImages.html +++ b/docs/dyn/compute_beta.machineImages.html @@ -478,6 +478,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -680,6 +681,7 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1075,6 +1077,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1277,6 +1280,7 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1702,6 +1706,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1904,6 +1909,7 @@

Method Details

"postKeyRevocationActionType": "A String", # PostKeyRevocationActionType of the instance. "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.networkEndpointGroups.html b/docs/dyn/compute_beta.networkEndpointGroups.html index 9be6a71887c..f2de9e0f20f 100644 --- a/docs/dyn/compute_beta.networkEndpointGroups.html +++ b/docs/dyn/compute_beta.networkEndpointGroups.html @@ -149,7 +149,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -255,7 +254,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -530,7 +528,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -682,7 +679,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -745,7 +741,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -937,7 +932,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -1015,7 +1009,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -1067,7 +1060,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_beta.networkFirewallPolicies.html b/docs/dyn/compute_beta.networkFirewallPolicies.html index 44c593e57a0..2df899fd61b 100644 --- a/docs/dyn/compute_beta.networkFirewallPolicies.html +++ b/docs/dyn/compute_beta.networkFirewallPolicies.html @@ -77,6 +77,9 @@

Instance Methods

addAssociation(project, firewallPolicy, body=None, replaceExistingAssociation=None, requestId=None, x__xgafv=None)

Inserts an association for the specified firewall policy.

+

+ addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)

+

Inserts a packet mirroring rule into a firewall policy.

addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)

Inserts a rule into a firewall policy.

@@ -98,6 +101,9 @@

Instance Methods

getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. May be empty if no such policy or resource exists.

+

+ getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None)

+

Gets a packet mirroring rule of the specified priority.

getRule(project, firewallPolicy, priority=None, x__xgafv=None)

Gets a rule of the specified priority.

@@ -113,12 +119,18 @@

Instance Methods

patch(project, firewallPolicy, body=None, requestId=None, x__xgafv=None)

Patches the specified policy with the data included in the request.

+

+ patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

+

Patches a packet mirroring rule of the specified priority.

patchRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None)

Patches a rule of the specified priority.

removeAssociation(project, firewallPolicy, name=None, requestId=None, x__xgafv=None)

Removes an association for the specified firewall policy.

+

+ removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)

+

Deletes a packet mirroring rule of the specified priority.

removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)

Deletes a rule of the specified priority.

@@ -265,6 +277,207 @@

Method Details

}
+
+ addPacketMirroringRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None) +
Inserts a packet mirroring rule into a firewall policy.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+      {
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+      },
+    ],
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+}
+
+  maxPriority: integer, When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
+  minPriority: integer, When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+
addRule(project, firewallPolicy, body=None, maxPriority=None, minPriority=None, requestId=None, x__xgafv=None)
Inserts a rule into a firewall policy.
@@ -752,10 +965,7 @@ 

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. - "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. - "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. - "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. - "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". "description": "A String", # An optional description for this resource. @@ -828,55 +1038,131 @@

Method Details

"tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. }, ], - "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. -}
-
- -
- getAssociation(project, firewallPolicy, name=None, x__xgafv=None) -
Gets an association with the specified name.
-
-Args:
-  project: string, Project ID for this request. (required)
-  firewallPolicy: string, Name of the firewall policy to which the queried association belongs. (required)
-  name: string, The name of the association to get from the firewall policy.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    {
-  "attachmentTarget": "A String", # The target that the firewall policy is attached to.
-  "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
-  "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.
-  "name": "A String", # The name for an association.
-  "shortName": "A String", # [Output Only] The short name of the firewall policy of the association.
-}
-
- -
- getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None) -
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
-
-Args:
-  project: string, Project ID for this request. (required)
-  resource: string, Name or id of the resource for this request. (required)
-  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
-  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.
+  "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.
+  "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples.
+  "rules": [ # A list of rules that belong to this policy. There must always be a default rule (rule with priority 2147483647 and match "*"). If no rules are provided when creating a firewall policy, a default rule with action "allow" will be added.
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+      "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+      "description": "A String", # An optional description for this resource.
+      "direction": "A String", # The direction in which this rule applies.
+      "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+      "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+      "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+      "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+        "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+          "A String",
+        ],
+        "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+          "A String",
+        ],
+        "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+          "A String",
+        ],
+        "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+          "A String",
+        ],
+        "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+          {
+            "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+            "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+              "A String",
+            ],
+          },
+        ],
+        "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+          "A String",
+        ],
+        "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+          "A String",
+        ],
+        "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+          "A String",
+        ],
+        "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+          "A String",
+        ],
+        "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+          {
+            "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+            "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+          },
+        ],
+        "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+          "A String",
+        ],
+      },
+      "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+      "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+      "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+      "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+      "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+        "A String",
+      ],
+      "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+        {
+          "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+          "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+        },
+      ],
+      "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+        "A String",
+      ],
+      "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+    },
+  ],
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+}
+
+ +
+ getAssociation(project, firewallPolicy, name=None, x__xgafv=None) +
Gets an association with the specified name.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to which the queried association belongs. (required)
+  name: string, The name of the association to get from the firewall policy.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "attachmentTarget": "A String", # The target that the firewall policy is attached to.
+  "displayName": "A String", # [Output Only] Deprecated, please use short name instead. The display name of the firewall policy of the association.
+  "firewallPolicyId": "A String", # [Output Only] The firewall policy ID of the association.
+  "name": "A String", # The name for an association.
+  "shortName": "A String", # [Output Only] The short name of the firewall policy of the association.
+}
+
+ +
+ getIamPolicy(project, resource, optionsRequestedPolicyVersion=None, x__xgafv=None) +
Gets the access control policy for a resource. May be empty if no such policy or resource exists.
+
+Args:
+  project: string, Project ID for this request. (required)
+  resource: string, Name or id of the resource for this request. (required)
+  optionsRequestedPolicyVersion: integer, Requested IAM Policy version.
+  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.
@@ -959,6 +1245,95 @@ 

Method Details

}
+
+ getPacketMirroringRule(project, firewallPolicy, priority=None, x__xgafv=None) +
Gets a packet mirroring rule of the specified priority.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to which the queried rule belongs. (required)
+  priority: integer, The priority of the rule to get from the firewall policy.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+      {
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+      },
+    ],
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
+}
+
+
getRule(project, firewallPolicy, priority=None, x__xgafv=None)
Gets a rule of the specified priority.
@@ -1067,13 +1442,86 @@ 

Method Details

"shortName": "A String", # [Output Only] The short name of the firewall policy of the association. }, ], - "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. - "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. - "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. - "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. - "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies - "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "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. + "displayName": "A String", # Deprecated, please use short name instead. User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "fingerprint": "A String", # Specifies a fingerprint for this resource, which is essentially a hash of the metadata's contents and used for optimistic locking. The fingerprint is initially generated by Compute Engine and changes after every request to modify or update metadata. You must always provide an up-to-date fingerprint hash in order to update or change metadata, otherwise the request will fail with error 412 conditionNotMet. To see the latest fingerprint, make get() request to the firewall policy. + "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. + "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies + "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1311,6 +1759,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1448,6 +1969,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1505,30 +2099,230 @@

Method Details

"A String", ], }, - "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. - "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. - "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. - "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. - "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. - "A String", - ], - "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. +} + + requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period. + "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise. + "creationTimestamp": "A String", # [Deprecated] This field is deprecated. + "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created. + "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format. + "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated. + "errors": [ # [Output Only] The array of errors encountered while processing this operation. + { + "code": "A String", # [Output Only] The error type identifier for this error. + "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED. + { + "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } } + "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com". + "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request. + "a_key": "A String", + }, + "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE. + }, + "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit. + "links": [ # URL(s) pointing to additional information on handling the current error. + { # Describes a URL link. + "description": "A String", # Describes what the link offers. + "url": "A String", # The URL of the link. + }, + ], + }, + "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error. + "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX" + "message": "A String", # The localized error message in the above locale. + }, + "quotaInfo": { # Additional details for quota exceeded error for resource quota. + "dimensions": { # The map holding related quota dimensions. + "a_key": "A String", + }, + "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric. + "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric. + "limitName": "A String", # The name of the quota limit. + "metricName": "A String", # The Compute Engine quota metric name. + "rolloutStatus": "A String", # Rollout status of the future quota limit. + }, + }, + ], + "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional. + "message": "A String", # [Output Only] An optional, human-readable error message. + }, + ], + }, + "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`. + "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found. + "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server. + "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format. + "instancesBulkInsertOperationMetadata": { + "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a + "a_key": { + "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far. + "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback. + "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error. + "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. + "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created. + }, + }, + }, + "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources. + "name": "A String", # [Output Only] Name of the operation. + "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request. + "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on. + "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses. + "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations. + "selfLink": "A String", # [Output Only] Server-defined URL for the resource. + "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. + "clientOperationId": "A String", # [Output Only] The client operation id. + "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a + "a_key": { + "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated. + "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. + }, + "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`. + }, + }, + }, + "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format. + "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`. + "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation. + "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource. + "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from. + "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`. + "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated. + { + "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response. + "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" } { - "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. - "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding). + "value": "A String", # [Output Only] A warning data value corresponding to the key. }, ], - "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. - "A String", - ], - "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + "message": "A String", # [Output Only] A human-readable description of the warning code. }, ], - "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. - "shortName": "A String", # User-provided name of the Organization firewall policy. The name should be unique in the organization in which the firewall policy is created. This field is not applicable to network firewall policies. This name must be set on creation and cannot be changed. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations. +}
+
+ +
+ patchPacketMirroringRule(project, firewallPolicy, body=None, priority=None, requestId=None, x__xgafv=None) +
Patches a packet mirroring rule of the specified priority.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny).
+  "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next".
+  "description": "A String", # An optional description for this resource.
+  "direction": "A String", # The direction in which this rule applies.
+  "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled.
+  "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules.
+  "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules
+  "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced.
+    "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10.
+      "A String",
+    ],
+    "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100.
+      "A String",
+    ],
+    "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000.
+      "A String",
+    ],
+    "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination.
+      "A String",
+    ],
+    "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match.
+      {
+        "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number.
+        "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"].
+          "A String",
+        ],
+      },
+    ],
+    "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10.
+      "A String",
+    ],
+    "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100.
+      "A String",
+    ],
+    "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000.
+      "A String",
+    ],
+    "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000.
+      "A String",
+    ],
+    "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256.
+      {
+        "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+        "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+      },
+    ],
+    "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source.
+      "A String",
+    ],
+  },
+  "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority.
+  "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated.
+  "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule.
+  "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions.
+  "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule.
+    "A String",
+  ],
+  "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256.
+    {
+      "name": "A String", # Name of the secure tag, created with TagManager's TagValue API.
+      "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted.
+    },
+  ],
+  "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule.
+    "A String",
+  ],
+  "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions.
 }
 
+  priority: integer, The priority of the rule to patch.
   requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
   x__xgafv: string, V1 error format.
     Allowed values
@@ -1971,6 +2765,131 @@ 

Method Details

}
+
+ removePacketMirroringRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None) +
Deletes a packet mirroring rule of the specified priority.
+
+Args:
+  project: string, Project ID for this request. (required)
+  firewallPolicy: string, Name of the firewall policy to update. (required)
+  priority: integer, The priority of the rule to remove from the firewall policy.
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/beta/globalOperations) * [Regional](/compute/docs/reference/rest/beta/regionOperations) * [Zonal](/compute/docs/reference/rest/beta/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+
removeRule(project, firewallPolicy, priority=None, requestId=None, x__xgafv=None)
Deletes a rule of the specified priority.
diff --git a/docs/dyn/compute_beta.regionBackendServices.html b/docs/dyn/compute_beta.regionBackendServices.html
index d6b9019e7f6..32048b9dc3f 100644
--- a/docs/dyn/compute_beta.regionBackendServices.html
+++ b/docs/dyn/compute_beta.regionBackendServices.html
@@ -460,14 +460,22 @@ 

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }
@@ -826,14 +834,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } @@ -1172,14 +1188,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -1417,14 +1441,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -1678,14 +1710,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } @@ -2380,14 +2420,22 @@

Method Details

], "serviceLbPolicy": "A String", # URL to networkservices.ServiceLbPolicy resource. Can only be set if load balancing scheme is EXTERNAL, EXTERNAL_MANAGED, INTERNAL_MANAGED or INTERNAL_SELF_MANAGED and the scope is global. "sessionAffinity": "A String", # Type of session affinity to use. The default is NONE. Only NONE and HEADER_FIELD are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. For more details, see: [Session Affinity](https://cloud.google.com/load-balancing/docs/backend-service#session_affinity). + "strongSessionAffinityCookie": { # The HTTP cookie used for stateful session affinity. # Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY. + "name": "A String", # Name of the cookie. + "path": "A String", # Path to set for the cookie. + "ttl": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Lifetime of the cookie. + "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. + "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years + }, + }, "subsetting": { # Subsetting configuration for this BackendService. Currently this is applicable only for Internal TCP/UDP load balancing, Internal HTTP(S) load balancing and Traffic Director. "policy": "A String", "subsetSize": 42, # The number of backends per backend group assigned to each proxy instance or each service mesh client. An input parameter to the `CONSISTENT_HASH_SUBSETTING` algorithm. Can only be set if `policy` is set to `CONSISTENT_HASH_SUBSETTING`. Can only be set if load balancing scheme is `INTERNAL_MANAGED` or `INTERNAL_SELF_MANAGED`. `subset_size` is optional for Internal HTTP(S) load balancing and required for Traffic Director. If you do not provide this value, Cloud Load Balancing will calculate it dynamically to optimize the number of proxies/clients visible to each backend and vice versa. Must be greater than 0. If `subset_size` is larger than the number of backends/endpoints, then subsetting is disabled. }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } diff --git a/docs/dyn/compute_beta.regionInstanceGroupManagers.html b/docs/dyn/compute_beta.regionInstanceGroupManagers.html index 3a97cfe0e54..49d190e12b4 100644 --- a/docs/dyn/compute_beta.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_beta.regionInstanceGroupManagers.html @@ -1040,7 +1040,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1223,7 +1223,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1535,7 +1535,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2066,7 +2066,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -3901,7 +3901,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_beta.regionInstanceTemplates.html b/docs/dyn/compute_beta.regionInstanceTemplates.html index 50ba0b1d5e8..be002676f5f 100644 --- a/docs/dyn/compute_beta.regionInstanceTemplates.html +++ b/docs/dyn/compute_beta.regionInstanceTemplates.html @@ -477,6 +477,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -792,6 +793,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. @@ -1241,6 +1243,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.regionInstances.html b/docs/dyn/compute_beta.regionInstances.html index 513d7e95814..2097ae187e1 100644 --- a/docs/dyn/compute_beta.regionInstances.html +++ b/docs/dyn/compute_beta.regionInstances.html @@ -320,6 +320,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "hostErrorTimeoutSeconds": 42, # Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. diff --git a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html index baf2c9ff45b..23acaec90a6 100644 --- a/docs/dyn/compute_beta.regionNetworkEndpointGroups.html +++ b/docs/dyn/compute_beta.regionNetworkEndpointGroups.html @@ -123,7 +123,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -398,7 +397,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. @@ -550,7 +548,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -613,7 +610,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -805,7 +801,6 @@

Method Details

"urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse service and version fields from a request URL. URL mask allows for routing to multiple App Engine services without having to create multiple Network Endpoint Groups and backend services. For example, the request URLs foo1-dot-appname.appspot.com/v1 and foo1-dot-appname.appspot.com/v2 can be backed by the same Serverless NEG with URL mask <service>-dot-appname.appspot.com/<version>. The URL mask will parse them to { service = "foo1", version = "v1" } and { service = "foo1", version = "v2" } respectively. "version": "A String", # Optional serving version. The version name is case-sensitive and must be 1-100 characters long. Example value: v1, v2. }, - "clientPortMappingMode": "A String", # Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional. "cloudFunction": { # Configuration for a Cloud Function network endpoint group (NEG). The function must be provided explicitly or in the URL mask. Note: Cloud Function must be in the same project and located in the same region as the Serverless NEG. # Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set. "function": "A String", # A user-defined name of the Cloud Function. The function name is case-sensitive and must be 1-63 characters long. Example value: func1. "urlMask": "A String", # An URL mask is one of the main components of the Cloud Function. A template to parse function field from a request URL. URL mask allows for routing to multiple Cloud Functions without having to create multiple Network Endpoint Groups and backend services. For example, request URLs mydomain.com/function1 and mydomain.com/function2 can be backed by the same Serverless NEG with URL mask /<function>. The URL mask will parse them to { function = "function1" } and { function = "function2" } respectively. @@ -912,7 +907,6 @@

Method Details

"a_key": "A String", }, "clientDestinationPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with GCE_VM_IP_PORTMAP endpoint type. - "clientPort": 42, # Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode. "fqdn": "A String", # Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT. "instance": "A String", # The name or a URL of VM instance of this network endpoint. This field is required for network endpoints of type GCE_VM_IP and GCE_VM_IP_PORT. The instance must be in the same zone of network endpoint group (for zonal NEGs) or in the zone within the region of the NEG (for regional NEGs). If the ipAddress is specified, it must belongs to the VM instance. The name must be 1-63 characters long, and comply with RFC1035 or be a valid URL pointing to an existing instance. "ipAddress": "A String", # Optional IPv4 address of network endpoint. The IP address must belong to a VM in Compute Engine (either the primary IP or as part of an aliased IP range). If the IP address is not specified, then the primary IP address for the VM instance in the network that the network endpoint group belongs to will be used. This field is redundant and need not be set for network endpoints of type GCE_VM_IP. If set, it must be set to the primary internal IP address of the attached VM instance that matches the subnetwork of the NEG. The primary internal IP address from any NIC of a multi-NIC VM instance can be added to a NEG as long as it matches the NEG subnetwork. diff --git a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html index 62497eb8b04..227491bfb72 100644 --- a/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html +++ b/docs/dyn/compute_beta.regionNetworkFirewallPolicies.html @@ -760,6 +760,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -889,6 +962,7 @@

Method Details

{ "displayName": "A String", # [Output Only] The display name of the firewall policy. "name": "A String", # [Output Only] The name of the firewall policy. + "priority": 42, # [Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY. "rules": [ # The rules that apply to the network. { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". @@ -1239,6 +1313,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1477,6 +1624,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. @@ -1615,6 +1835,79 @@

Method Details

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server. "kind": "compute#firewallPolicy", # [Output only] Type of the resource. Always compute#firewallPolicyfor firewall policies "name": "A String", # Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy. + "packetMirroringRules": [ # A list of packet mirroring rules that belong to this policy. + { # Represents a rule that describes one or more match conditions along with the action to be taken when traffic matches this condition (allow or deny). + "action": "A String", # The Action to perform when the client connection triggers the rule. Valid actions are "allow", "deny" and "goto_next". + "description": "A String", # An optional description for this resource. + "direction": "A String", # The direction in which this rule applies. + "disabled": True or False, # Denotes whether the firewall policy rule is disabled. When set to true, the firewall policy rule is not enforced and traffic behaves as if it did not exist. If this is unspecified, the firewall policy rule will be enabled. + "enableLogging": True or False, # Denotes whether to enable logging for a particular rule. If logging is enabled, logs will be exported to the configured export destination in Stackdriver. Logs may be exported to BigQuery or Pub/Sub. Note: you cannot enable logging on "goto_next" rules. + "kind": "compute#firewallPolicyRule", # [Output only] Type of the resource. Always compute#firewallPolicyRule for firewall policy rules + "match": { # Represents a match condition that incoming traffic is evaluated against. Exactly one field must be specified. # A match condition that incoming traffic is evaluated against. If it evaluates to true, the corresponding 'action' is enforced. + "destAddressGroups": [ # Address groups which should be matched against the traffic destination. Maximum number of destination address groups is 10. + "A String", + ], + "destFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic destination. Maximum number of destination fqdn allowed is 100. + "A String", + ], + "destIpRanges": [ # CIDR IP address range. Maximum number of destination CIDR IP ranges allowed is 5000. + "A String", + ], + "destRegionCodes": [ # Region codes whose IP addresses will be used to match for destination of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of dest region codes allowed is 5000. + "A String", + ], + "destThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic destination. + "A String", + ], + "layer4Configs": [ # Pairs of IP protocols and ports that the rule should match. + { + "ipProtocol": "A String", # The IP protocol to which this rule applies. The protocol type is required when creating a firewall rule. This value can either be one of the following well known protocol strings (tcp, udp, icmp, esp, ah, ipip, sctp), or the IP protocol number. + "ports": [ # An optional list of ports to which this rule applies. This field is only applicable for UDP or TCP protocol. Each entry must be either an integer or a range. If not specified, this rule applies to connections through any port. Example inputs include: ["22"], ["80","443"], and ["12345-12349"]. + "A String", + ], + }, + ], + "srcAddressGroups": [ # Address groups which should be matched against the traffic source. Maximum number of source address groups is 10. + "A String", + ], + "srcFqdns": [ # Fully Qualified Domain Name (FQDN) which should be matched against traffic source. Maximum number of source fqdn allowed is 100. + "A String", + ], + "srcIpRanges": [ # CIDR IP address range. Maximum number of source CIDR IP ranges allowed is 5000. + "A String", + ], + "srcRegionCodes": [ # Region codes whose IP addresses will be used to match for source of traffic. Should be specified as 2 letter country code defined as per ISO 3166 alpha-2 country codes. ex."US" Maximum number of source region codes allowed is 5000. + "A String", + ], + "srcSecureTags": [ # List of secure tag values, which should be matched at the source of the traffic. For INGRESS rule, if all the srcSecureTag are INEFFECTIVE, and there is no srcIpRange, this rule will be ignored. Maximum number of source tag values allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "srcThreatIntelligences": [ # Names of Network Threat Intelligence lists. The IPs in these lists will be matched against traffic source. + "A String", + ], + }, + "priority": 42, # An integer indicating the priority of a rule in the list. The priority must be a positive value between 0 and 2147483647. Rules are evaluated from highest to lowest priority where 0 is the highest priority and 2147483647 is the lowest prority. + "ruleName": "A String", # An optional name for the rule. This field is not a unique identifier and can be updated. + "ruleTupleCount": 42, # [Output Only] Calculation of the complexity of a single firewall policy rule. + "securityProfileGroup": "A String", # A fully-qualified URL of a SecurityProfile resource instance. Example: https://networksecurity.googleapis.com/v1/projects/{project}/locations/{location}/securityProfileGroups/my-security-profile-group Must be specified if action = 'apply_security_profile_group' and cannot be specified for other actions. + "targetResources": [ # A list of network resource URLs to which this rule applies. This field allows you to control which network's VMs get this rule. If this field is left blank, all VMs within the organization will receive the rule. + "A String", + ], + "targetSecureTags": [ # A list of secure tags that controls which instances the firewall rule applies to. If targetSecureTag are specified, then the firewall rule applies only to instances in the VPC network that have one of those EFFECTIVE secure tags, if all the target_secure_tag are in INEFFECTIVE state, then this rule will be ignored. targetSecureTag may not be set at the same time as targetServiceAccounts. If neither targetServiceAccounts nor targetSecureTag are specified, the firewall rule applies to all instances on the specified network. Maximum number of target label tags allowed is 256. + { + "name": "A String", # Name of the secure tag, created with TagManager's TagValue API. + "state": "A String", # [Output Only] State of the secure tag, either `EFFECTIVE` or `INEFFECTIVE`. A secure tag is `INEFFECTIVE` when it is deleted or its network is deleted. + }, + ], + "targetServiceAccounts": [ # A list of service accounts indicating the sets of instances that are applied with this rule. + "A String", + ], + "tlsInspect": True or False, # Boolean flag indicating if the traffic should be TLS decrypted. Can be set only if action = 'apply_security_profile_group' and cannot be set for other actions. + }, + ], "parent": "A String", # [Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies. "region": "A String", # [Output Only] URL of the region where the regional firewall policy resides. This field is not applicable to global firewall policies. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body. "ruleTupleCount": 42, # [Output Only] Total count of all firewall policy rule tuples. A firewall policy can not exceed a set number of tuples. diff --git a/docs/dyn/compute_beta.regions.html b/docs/dyn/compute_beta.regions.html index 1795ca28e46..885d113c409 100644 --- a/docs/dyn/compute_beta.regions.html +++ b/docs/dyn/compute_beta.regions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

get(project, region, x__xgafv=None)

-

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.

+

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

@@ -94,7 +94,7 @@

Method Details

get(project, region, x__xgafv=None) -
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.
+  
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_beta.vpnGateways.html b/docs/dyn/compute_beta.vpnGateways.html
index 622abb43047..1979bd1bc24 100644
--- a/docs/dyn/compute_beta.vpnGateways.html
+++ b/docs/dyn/compute_beta.vpnGateways.html
@@ -148,7 +148,7 @@ 

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -364,7 +364,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -439,7 +439,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -604,7 +604,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. diff --git a/docs/dyn/compute_v1.backendServices.html b/docs/dyn/compute_v1.backendServices.html index c7c81e807ec..764a37e9971 100644 --- a/docs/dyn/compute_v1.backendServices.html +++ b/docs/dyn/compute_v1.backendServices.html @@ -485,9 +485,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -998,9 +998,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }
@@ -1352,9 +1352,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } @@ -1690,9 +1690,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -1927,9 +1927,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -2180,9 +2180,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } @@ -3002,9 +3002,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } diff --git a/docs/dyn/compute_v1.instanceGroupManagers.html b/docs/dyn/compute_v1.instanceGroupManagers.html index ea71371d261..0d228c9f076 100644 --- a/docs/dyn/compute_v1.instanceGroupManagers.html +++ b/docs/dyn/compute_v1.instanceGroupManagers.html @@ -330,7 +330,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1228,7 +1228,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1374,7 +1374,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1649,7 +1649,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -2132,7 +2132,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_v1.instanceTemplates.html b/docs/dyn/compute_v1.instanceTemplates.html index 654b97e9f6e..e2db4b5214d 100644 --- a/docs/dyn/compute_v1.instanceTemplates.html +++ b/docs/dyn/compute_v1.instanceTemplates.html @@ -345,6 +345,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -805,6 +806,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1189,6 +1191,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1602,6 +1605,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.instances.html b/docs/dyn/compute_v1.instances.html index 8b70b0354af..9db32736a46 100644 --- a/docs/dyn/compute_v1.instances.html +++ b/docs/dyn/compute_v1.instances.html @@ -775,6 +775,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1329,6 +1330,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -2157,6 +2159,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -2844,6 +2847,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -3293,6 +3297,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -5251,6 +5256,7 @@

Method Details

{ # Sets the scheduling options for an Instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -6865,6 +6871,7 @@

Method Details

"satisfiesPzs": True or False, # [Output Only] Reserved for future use. "scheduling": { # Sets the scheduling options for an Instance. # Sets the scheduling options for this instance. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.machineImages.html b/docs/dyn/compute_v1.machineImages.html index 10d19b4f4c1..3b4c6ccaffe 100644 --- a/docs/dyn/compute_v1.machineImages.html +++ b/docs/dyn/compute_v1.machineImages.html @@ -456,6 +456,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -649,6 +650,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1019,6 +1021,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1212,6 +1215,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1612,6 +1616,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1805,6 +1810,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from this machine image. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.regionBackendServices.html b/docs/dyn/compute_v1.regionBackendServices.html index 779efce6e59..2c33e970eb3 100644 --- a/docs/dyn/compute_v1.regionBackendServices.html +++ b/docs/dyn/compute_v1.regionBackendServices.html @@ -458,9 +458,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }
@@ -815,9 +815,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } @@ -1154,9 +1154,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -1392,9 +1392,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], }, @@ -1646,9 +1646,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } @@ -2341,9 +2341,9 @@

Method Details

"policy": "A String", }, "timeoutSec": 42, # The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. - "usedBy": [ + "usedBy": [ # [Output Only] List of resources referencing given backend service. { - "reference": "A String", + "reference": "A String", # [Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule. }, ], } diff --git a/docs/dyn/compute_v1.regionInstanceGroupManagers.html b/docs/dyn/compute_v1.regionInstanceGroupManagers.html index d545c66f463..66404ebf405 100644 --- a/docs/dyn/compute_v1.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_v1.regionInstanceGroupManagers.html @@ -1016,7 +1016,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1162,7 +1162,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1437,7 +1437,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. @@ -1920,7 +1920,7 @@

Method Details

"initialDelaySec": 42, # The initial delay is the number of seconds that a new VM takes to initialize and run its startup script. During a VM's initial delay period, the MIG ignores unsuccessful health checks because the VM might be in the startup process. This prevents the MIG from prematurely recreating a VM. If the health check receives a healthy response during the initial delay, it indicates that the startup process is complete and the VM is ready. The value of initial delay must be between 0 and 3600 seconds. The default value is 0. }, ], - "baseInstanceName": "A String", # The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035. + "baseInstanceName": "A String", # The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of "vm-###" results in "vm-001" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\[[0-9]{1,10}\\])?)) "creationTimestamp": "A String", # [Output Only] The creation timestamp for this managed instance group in RFC3339 text format. "currentActions": { # [Output Only] The list of instance actions and the number of instances in this managed instance group that are scheduled for each of those actions. "abandoning": 42, # [Output Only] The total number of instances in the managed instance group that are scheduled to be abandoned. Abandoning an instance removes it from the managed instance group without deleting it. diff --git a/docs/dyn/compute_v1.regionInstanceTemplates.html b/docs/dyn/compute_v1.regionInstanceTemplates.html index d1e5dbe7f64..e140e892c59 100644 --- a/docs/dyn/compute_v1.regionInstanceTemplates.html +++ b/docs/dyn/compute_v1.regionInstanceTemplates.html @@ -450,6 +450,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -735,6 +736,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. @@ -1149,6 +1151,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.regionInstances.html b/docs/dyn/compute_v1.regionInstances.html index 426b6aa0aa0..a0a18d9d9fc 100644 --- a/docs/dyn/compute_v1.regionInstances.html +++ b/docs/dyn/compute_v1.regionInstances.html @@ -298,6 +298,7 @@

Method Details

], "scheduling": { # Sets the scheduling options for an Instance. # Specifies the scheduling options for the instances that are created from these properties. "automaticRestart": True or False, # Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. + "availabilityDomain": 42, # Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance. "instanceTerminationAction": "A String", # Specifies the termination action for the instance. "localSsdRecoveryTimeout": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour. "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive. diff --git a/docs/dyn/compute_v1.regions.html b/docs/dyn/compute_v1.regions.html index 48ac2d032b3..b471d6aadf9 100644 --- a/docs/dyn/compute_v1.regions.html +++ b/docs/dyn/compute_v1.regions.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

get(project, region, x__xgafv=None)

-

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.

+

Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

list(project, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `items.quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

@@ -94,7 +94,7 @@

Method Details

get(project, region, x__xgafv=None) -
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.
+  
Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.
 
 Args:
   project: string, Project ID for this request. (required)
diff --git a/docs/dyn/compute_v1.vpnGateways.html b/docs/dyn/compute_v1.vpnGateways.html
index 74efc22d514..7c9b23380e9 100644
--- a/docs/dyn/compute_v1.vpnGateways.html
+++ b/docs/dyn/compute_v1.vpnGateways.html
@@ -148,7 +148,7 @@ 

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -364,7 +364,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -439,7 +439,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. @@ -604,7 +604,7 @@

Method Details

"network": "A String", # URL of the network to which this VPN gateway is attached. Provided by the client when the VPN gateway is created. "region": "A String", # [Output Only] URL of the region where the VPN gateway resides. "selfLink": "A String", # [Output Only] Server-defined URL for the resource. - "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used. + "stackType": "A String", # The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6. "vpnInterfaces": [ # The list of VPN interfaces associated with this VPN gateway. { # A VPN gateway interface. "id": 42, # [Output Only] Numeric identifier for this VPN interface associated with the VPN gateway. diff --git a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html index 0f7828d7f76..43a80086ffc 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.connectionSchemaMetadata.html @@ -272,6 +272,7 @@

Method Details

"resultMetadata": [ # Output only. List of result field metadata. { # Metadata of result field. "dataType": "A String", # The data type of the field. + "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the field. "field": "A String", # Name of the result field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result @@ -293,6 +294,7 @@

Method Details

"A String", ], }, + "nullable": True or False, # Specifies whether a null value is allowed. }, ], }, diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index a2f1cc3d8b0..0739667e877 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -2122,6 +2122,7 @@

Method Details

"resultMetadata": [ # Output only. List of result field metadata. { # Metadata of result field. "dataType": "A String", # The data type of the field. + "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the field. "field": "A String", # Name of the result field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result @@ -2143,6 +2144,7 @@

Method Details

"A String", ], }, + "nullable": True or False, # Specifies whether a null value is allowed. }, ], }, diff --git a/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html b/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html index 921a9428bf5..9b37f45fd2b 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.runtimeActionSchemas.html @@ -182,6 +182,7 @@

Method Details

"resultMetadata": [ # Output only. List of result field metadata. { # Metadata of result field. "dataType": "A String", # The data type of the field. + "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the field. "field": "A String", # Name of the result field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema representation of this action's result @@ -203,6 +204,7 @@

Method Details

"A String", ], }, + "nullable": True or False, # Specifies whether a null value is allowed. }, ], }, diff --git a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html index 09e7733e513..5d9c2069592 100644 --- a/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html +++ b/docs/dyn/connectors_v1.projects.locations.global_.customConnectors.customConnectorVersions.html @@ -203,7 +203,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -407,7 +407,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -586,7 +586,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. 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 1bc5d9dd8b6..c098918d86e 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -154,7 +154,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -226,7 +226,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -345,7 +345,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -416,7 +416,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -488,7 +488,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -561,7 +561,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -660,7 +660,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -763,7 +763,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -879,7 +879,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -951,7 +951,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1070,7 +1070,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1141,7 +1141,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1213,7 +1213,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1286,7 +1286,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1385,7 +1385,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. @@ -1488,7 +1488,7 @@

Method Details

"preselected": True or False, # Optional. Indicates if the option is preselected. }, ], - "valueSeparator": "A String", # Required. Value separator. + "valueSeparator": "A String", # Required. Value separator. Only "," can be used for OAuth auth code flow scope field. }, "required": True or False, # Flag represents that this `ConfigVariable` must be provided for a connection. "requiredCondition": { # Struct for representing boolean expressions. # Condition under which a field would be required. The condition can be represented in the form of a logical expression. diff --git a/docs/dyn/connectors_v2.projects.locations.connections.actions.html b/docs/dyn/connectors_v2.projects.locations.connections.actions.html index 245cbeb0304..8634b99dae2 100644 --- a/docs/dyn/connectors_v2.projects.locations.connections.actions.html +++ b/docs/dyn/connectors_v2.projects.locations.connections.actions.html @@ -226,6 +226,7 @@

Method Details

"resultMetadata": [ # List containing the metadata of result fields. { # Result Metadata message contains metadata about the result returned after executing an Action. "dataType": "A String", # The data type of the metadata field + "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the metadata field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the result, applicable only if parameter is of type `STRUCT` "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema @@ -250,6 +251,7 @@

Method Details

], }, "name": "A String", # Name of the metadata field. + "nullable": True or False, # Specifies whether a null value is allowed. }, ], }
@@ -363,6 +365,7 @@

Method Details

"resultMetadata": [ # List containing the metadata of result fields. { # Result Metadata message contains metadata about the result returned after executing an Action. "dataType": "A String", # The data type of the metadata field + "defaultValue": "", # The following field specifies the default value of the Parameter provided by the external system if a value is not provided. "description": "A String", # A brief description of the metadata field. "jsonSchema": { # JsonSchema representation of schema metadata # JsonSchema of the result, applicable only if parameter is of type `STRUCT` "additionalDetails": { # Additional details apart from standard json schema fields, this gives flexibility to store metadata about the schema @@ -387,6 +390,7 @@

Method Details

], }, "name": "A String", # Name of the metadata field. + "nullable": True or False, # Specifies whether a null value is allowed. }, ], }, diff --git a/docs/dyn/css_v1.accounts.cssProductInputs.html b/docs/dyn/css_v1.accounts.cssProductInputs.html new file mode 100644 index 00000000000..a4eb2da60a5 --- /dev/null +++ b/docs/dyn/css_v1.accounts.cssProductInputs.html @@ -0,0 +1,362 @@ + + + +

CSS API . accounts . cssProductInputs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(name, supplementalFeedId=None, x__xgafv=None)

+

Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.

+

+ insert(parent, body=None, feedId=None, x__xgafv=None)

+

Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(name, supplementalFeedId=None, x__xgafv=None) +
Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.
+
+Args:
+  name: string, Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input} (required)
+  supplementalFeedId: string, The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.
+  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); }
+}
+
+ +
+ insert(parent, body=None, feedId=None, x__xgafv=None) +
Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.
+
+Args:
+  parent: string, Required. The account where this CSS Product will be inserted. Format: accounts/{account} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.
+  "attributes": { # Attributes for CSS Product. # A list of CSS Product attributes.
+    "additionalImageLinks": [ # Additional URL of images of the item.
+      "A String",
+    ],
+    "adult": True or False, # Set to true if the item is targeted towards adults.
+    "ageGroup": "A String", # Target age group of the item.
+    "brand": "A String", # Product Related Attributes.[14-36] Brand of the item.
+    "certifications": [ # A list of certificates claimed by the CSS for the given product.
+      { # The certification for the product.
+        "authority": "A String", # Name of the certification body.
+        "code": "A String", # A unique code to identify the certification.
+        "name": "A String", # Name of the certification.
+      },
+    ],
+    "color": "A String", # Color of the item.
+    "cppAdsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
+    "cppLink": "A String", # URL directly linking to your the Product Detail Page of the CSS.
+    "cppMobileLink": "A String", # URL for the mobile-optimized version of the Product Detail Page of the CSS.
+    "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
+    "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
+    "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
+    "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
+    "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
+    "description": "A String", # Description of the item.
+    "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
+      "A String",
+    ],
+    "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
+    "gender": "A String", # Target gender of the item.
+    "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
+    "gtin": "A String", # Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.
+    "headlineOfferCondition": "A String", # Condition of the headline offer.
+    "headlineOfferLink": "A String", # Link to the headline offer.
+    "headlineOfferMobileLink": "A String", # Mobile Link to the headline offer.
+    "headlineOfferPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "headlineOfferShippingPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "highPrice": { # The price represented as a number and currency. # High Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "imageLink": "A String", # URL of an image of the item.
+    "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
+      "A String",
+    ],
+    "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
+    "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+    "lowPrice": { # The price represented as a number and currency. # Low Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "material": "A String", # The material of which the item is made.
+    "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
+    "multipack": "A String", # The number of identical products in a merchant-defined multipack.
+    "numberOfOffers": "A String", # The number of aggregate offers.
+    "pattern": "A String", # The item's pattern (e.g. polka dots).
+    "pause": "A String", # Publication of this item will be temporarily paused.
+    "productDetails": [ # Technical specification or additional product details.
+      { # The product details.
+        "attributeName": "A String", # The name of the product detail.
+        "attributeValue": "A String", # The value of the product detail.
+        "sectionName": "A String", # The section header used to group a set of product details.
+      },
+    ],
+    "productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+    },
+    "productHighlights": [ # Bullet points describing the most relevant highlights of a product.
+      "A String",
+    ],
+    "productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+    },
+    "productTypes": [ # Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).
+      "A String",
+    ],
+    "productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
+      "unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
+      "value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
+    },
+    "productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+    },
+    "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).
+    "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
+    "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
+      "A String",
+    ],
+    "title": "A String", # Title of the item.
+  },
+  "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product.
+  "customAttributes": [ # A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
+    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+        # Object with schema name: CustomAttribute
+      ],
+      "name": "A String", # The name of the attribute.
+      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+    },
+  ],
+  "feedLabel": "A String", # Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.
+  "finalName": "A String", # Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` "
+  "freshnessTime": "A String", # Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.
+  "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`
+  "rawProvidedId": "A String", # Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details.
+}
+
+  feedId: string, Required. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet.
+  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 input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.
+  "attributes": { # Attributes for CSS Product. # A list of CSS Product attributes.
+    "additionalImageLinks": [ # Additional URL of images of the item.
+      "A String",
+    ],
+    "adult": True or False, # Set to true if the item is targeted towards adults.
+    "ageGroup": "A String", # Target age group of the item.
+    "brand": "A String", # Product Related Attributes.[14-36] Brand of the item.
+    "certifications": [ # A list of certificates claimed by the CSS for the given product.
+      { # The certification for the product.
+        "authority": "A String", # Name of the certification body.
+        "code": "A String", # A unique code to identify the certification.
+        "name": "A String", # Name of the certification.
+      },
+    ],
+    "color": "A String", # Color of the item.
+    "cppAdsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
+    "cppLink": "A String", # URL directly linking to your the Product Detail Page of the CSS.
+    "cppMobileLink": "A String", # URL for the mobile-optimized version of the Product Detail Page of the CSS.
+    "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
+    "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
+    "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
+    "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
+    "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
+    "description": "A String", # Description of the item.
+    "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
+      "A String",
+    ],
+    "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
+    "gender": "A String", # Target gender of the item.
+    "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
+    "gtin": "A String", # Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.
+    "headlineOfferCondition": "A String", # Condition of the headline offer.
+    "headlineOfferLink": "A String", # Link to the headline offer.
+    "headlineOfferMobileLink": "A String", # Mobile Link to the headline offer.
+    "headlineOfferPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "headlineOfferShippingPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "highPrice": { # The price represented as a number and currency. # High Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "imageLink": "A String", # URL of an image of the item.
+    "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
+      "A String",
+    ],
+    "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
+    "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+    "lowPrice": { # The price represented as a number and currency. # Low Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "material": "A String", # The material of which the item is made.
+    "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
+    "multipack": "A String", # The number of identical products in a merchant-defined multipack.
+    "numberOfOffers": "A String", # The number of aggregate offers.
+    "pattern": "A String", # The item's pattern (e.g. polka dots).
+    "pause": "A String", # Publication of this item will be temporarily paused.
+    "productDetails": [ # Technical specification or additional product details.
+      { # The product details.
+        "attributeName": "A String", # The name of the product detail.
+        "attributeValue": "A String", # The value of the product detail.
+        "sectionName": "A String", # The section header used to group a set of product details.
+      },
+    ],
+    "productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+    },
+    "productHighlights": [ # Bullet points describing the most relevant highlights of a product.
+      "A String",
+    ],
+    "productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+    },
+    "productTypes": [ # Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).
+      "A String",
+    ],
+    "productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
+      "unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
+      "value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
+    },
+    "productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+    },
+    "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).
+    "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
+    "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
+      "A String",
+    ],
+    "title": "A String", # Title of the item.
+  },
+  "contentLanguage": "A String", # Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product.
+  "customAttributes": [ # A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
+    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+        # Object with schema name: CustomAttribute
+      ],
+      "name": "A String", # The name of the attribute.
+      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+    },
+  ],
+  "feedLabel": "A String", # Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to "target country" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.
+  "finalName": "A String", # Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` "
+  "freshnessTime": "A String", # Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.
+  "name": "A String", # The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`
+  "rawProvidedId": "A String", # Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/css_v1.accounts.cssProducts.html b/docs/dyn/css_v1.accounts.cssProducts.html new file mode 100644 index 00000000000..a6a59944490 --- /dev/null +++ b/docs/dyn/css_v1.accounts.cssProducts.html @@ -0,0 +1,442 @@ + + + +

CSS API . accounts . cssProducts

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.

+

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

+

Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.
+
+Args:
+  name: string, Required. The name of the CSS product to retrieve. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The processed CSS Product(a.k.a Aggregate Offer internally).
+  "attributes": { # Attributes for CSS Product. # Output only. A list of product attributes.
+    "additionalImageLinks": [ # Additional URL of images of the item.
+      "A String",
+    ],
+    "adult": True or False, # Set to true if the item is targeted towards adults.
+    "ageGroup": "A String", # Target age group of the item.
+    "brand": "A String", # Product Related Attributes.[14-36] Brand of the item.
+    "certifications": [ # A list of certificates claimed by the CSS for the given product.
+      { # The certification for the product.
+        "authority": "A String", # Name of the certification body.
+        "code": "A String", # A unique code to identify the certification.
+        "name": "A String", # Name of the certification.
+      },
+    ],
+    "color": "A String", # Color of the item.
+    "cppAdsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
+    "cppLink": "A String", # URL directly linking to your the Product Detail Page of the CSS.
+    "cppMobileLink": "A String", # URL for the mobile-optimized version of the Product Detail Page of the CSS.
+    "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
+    "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
+    "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
+    "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
+    "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
+    "description": "A String", # Description of the item.
+    "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
+      "A String",
+    ],
+    "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
+    "gender": "A String", # Target gender of the item.
+    "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
+    "gtin": "A String", # Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.
+    "headlineOfferCondition": "A String", # Condition of the headline offer.
+    "headlineOfferLink": "A String", # Link to the headline offer.
+    "headlineOfferMobileLink": "A String", # Mobile Link to the headline offer.
+    "headlineOfferPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "headlineOfferShippingPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "highPrice": { # The price represented as a number and currency. # High Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "imageLink": "A String", # URL of an image of the item.
+    "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
+      "A String",
+    ],
+    "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
+    "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+    "lowPrice": { # The price represented as a number and currency. # Low Price of the aggregate offer.
+      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+    },
+    "material": "A String", # The material of which the item is made.
+    "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
+    "multipack": "A String", # The number of identical products in a merchant-defined multipack.
+    "numberOfOffers": "A String", # The number of aggregate offers.
+    "pattern": "A String", # The item's pattern (e.g. polka dots).
+    "pause": "A String", # Publication of this item will be temporarily paused.
+    "productDetails": [ # Technical specification or additional product details.
+      { # The product details.
+        "attributeName": "A String", # The name of the product detail.
+        "attributeValue": "A String", # The value of the product detail.
+        "sectionName": "A String", # The section header used to group a set of product details.
+      },
+    ],
+    "productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+    },
+    "productHighlights": [ # Bullet points describing the most relevant highlights of a product.
+      "A String",
+    ],
+    "productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+    },
+    "productTypes": [ # Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).
+      "A String",
+    ],
+    "productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
+      "unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
+      "value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
+    },
+    "productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+      "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+      "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+    },
+    "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).
+    "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
+    "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
+      "A String",
+    ],
+    "title": "A String", # Title of the item.
+  },
+  "contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
+  "cssProductStatus": { # The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
+    "creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+    "destinationStatuses": [ # The intended destinations for the product.
+      { # The destination status of the product status.
+        "approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved.
+          "A String",
+        ],
+        "destination": "A String", # The name of the destination
+        "disapprovedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved.
+          "A String",
+        ],
+        "pendingCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval.
+          "A String",
+        ],
+      },
+    ],
+    "googleExpirationDate": "A String", # Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+    "itemLevelIssues": [ # A list of all issues associated with the product.
+      { # The ItemLevelIssue of the product status.
+        "applicableCountries": [ # List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer.
+          "A String",
+        ],
+        "attribute": "A String", # The attribute's name, if the issue is caused by a single attribute.
+        "code": "A String", # The error code of the issue.
+        "description": "A String", # A short issue description in English.
+        "destination": "A String", # The destination the issue applies to.
+        "detail": "A String", # A detailed issue description in English.
+        "documentation": "A String", # The URL of a web page to help with resolving this issue.
+        "resolution": "A String", # Whether the issue can be resolved by the merchant.
+        "servability": "A String", # How this issue affects serving of the aggregate offer.
+      },
+    ],
+    "lastUpdateDate": "A String", # Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+  },
+  "customAttributes": [ # Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
+    { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+      "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+        # Object with schema name: CustomAttribute
+      ],
+      "name": "A String", # The name of the attribute.
+      "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+    },
+  ],
+  "feedLabel": "A String", # Output only. The feed label for the product.
+  "name": "A String", # The name of the CSS Product. Format: `"accounts/{account}/cssProducts/{css_product}"`
+  "rawProvidedId": "A String", # Output only. Your unique raw identifier for the product.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.
+
+Args:
+  parent: string, Required. The account/domain to list processed CSS Products for. Format: accounts/{account} (required)
+  pageSize: integer, The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned.
+  pageToken: string, A page token, received from a previous `ListCssProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCssProducts` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the ListCssProducts method.
+  "cssProducts": [ # The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds.
+    { # The processed CSS Product(a.k.a Aggregate Offer internally).
+      "attributes": { # Attributes for CSS Product. # Output only. A list of product attributes.
+        "additionalImageLinks": [ # Additional URL of images of the item.
+          "A String",
+        ],
+        "adult": True or False, # Set to true if the item is targeted towards adults.
+        "ageGroup": "A String", # Target age group of the item.
+        "brand": "A String", # Product Related Attributes.[14-36] Brand of the item.
+        "certifications": [ # A list of certificates claimed by the CSS for the given product.
+          { # The certification for the product.
+            "authority": "A String", # Name of the certification body.
+            "code": "A String", # A unique code to identify the certification.
+            "name": "A String", # Name of the certification.
+          },
+        ],
+        "color": "A String", # Color of the item.
+        "cppAdsRedirect": "A String", # Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
+        "cppLink": "A String", # URL directly linking to your the Product Detail Page of the CSS.
+        "cppMobileLink": "A String", # URL for the mobile-optimized version of the Product Detail Page of the CSS.
+        "customLabel0": "A String", # Custom label 0 for custom grouping of items in a Shopping campaign.
+        "customLabel1": "A String", # Custom label 1 for custom grouping of items in a Shopping campaign.
+        "customLabel2": "A String", # Custom label 2 for custom grouping of items in a Shopping campaign.
+        "customLabel3": "A String", # Custom label 3 for custom grouping of items in a Shopping campaign.
+        "customLabel4": "A String", # Custom label 4 for custom grouping of items in a Shopping campaign.
+        "description": "A String", # Description of the item.
+        "excludedDestinations": [ # The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
+          "A String",
+        ],
+        "expirationDate": "A String", # Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
+        "gender": "A String", # Target gender of the item.
+        "googleProductCategory": "A String", # Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
+        "gtin": "A String", # Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.
+        "headlineOfferCondition": "A String", # Condition of the headline offer.
+        "headlineOfferLink": "A String", # Link to the headline offer.
+        "headlineOfferMobileLink": "A String", # Mobile Link to the headline offer.
+        "headlineOfferPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
+          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+        },
+        "headlineOfferShippingPrice": { # The price represented as a number and currency. # Headline Price of the aggregate offer.
+          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+        },
+        "highPrice": { # The price represented as a number and currency. # High Price of the aggregate offer.
+          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+        },
+        "imageLink": "A String", # URL of an image of the item.
+        "includedDestinations": [ # The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.
+          "A String",
+        ],
+        "isBundle": True or False, # Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
+        "itemGroupId": "A String", # Shared identifier for all variants of the same product.
+        "lowPrice": { # The price represented as a number and currency. # Low Price of the aggregate offer.
+          "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+          "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+        },
+        "material": "A String", # The material of which the item is made.
+        "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.
+        "multipack": "A String", # The number of identical products in a merchant-defined multipack.
+        "numberOfOffers": "A String", # The number of aggregate offers.
+        "pattern": "A String", # The item's pattern (e.g. polka dots).
+        "pause": "A String", # Publication of this item will be temporarily paused.
+        "productDetails": [ # Technical specification or additional product details.
+          { # The product details.
+            "attributeName": "A String", # The name of the product detail.
+            "attributeValue": "A String", # The value of the product detail.
+            "sectionName": "A String", # The section header used to group a set of product details.
+          },
+        ],
+        "productHeight": { # The dimension of the product. # The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+          "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+          "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+        },
+        "productHighlights": [ # Bullet points describing the most relevant highlights of a product.
+          "A String",
+        ],
+        "productLength": { # The dimension of the product. # The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+          "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+          "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+        },
+        "productTypes": [ # Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).
+          "A String",
+        ],
+        "productWeight": { # The weight of the product. # The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
+          "unit": "A String", # Required. The weight unit. Acceptable values are: * "`g`" * "`kg`" * "`oz`" * "`lb`"
+          "value": 3.14, # Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.
+        },
+        "productWidth": { # The dimension of the product. # The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
+          "unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`"
+          "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.
+        },
+        "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).
+        "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items.
+        "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).
+          "A String",
+        ],
+        "title": "A String", # Title of the item.
+      },
+      "contentLanguage": "A String", # Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.
+      "cssProductStatus": { # The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
+        "creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+        "destinationStatuses": [ # The intended destinations for the product.
+          { # The destination status of the product status.
+            "approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved.
+              "A String",
+            ],
+            "destination": "A String", # The name of the destination
+            "disapprovedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved.
+              "A String",
+            ],
+            "pendingCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval.
+              "A String",
+            ],
+          },
+        ],
+        "googleExpirationDate": "A String", # Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+        "itemLevelIssues": [ # A list of all issues associated with the product.
+          { # The ItemLevelIssue of the product status.
+            "applicableCountries": [ # List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer.
+              "A String",
+            ],
+            "attribute": "A String", # The attribute's name, if the issue is caused by a single attribute.
+            "code": "A String", # The error code of the issue.
+            "description": "A String", # A short issue description in English.
+            "destination": "A String", # The destination the issue applies to.
+            "detail": "A String", # A detailed issue description in English.
+            "documentation": "A String", # The URL of a web page to help with resolving this issue.
+            "resolution": "A String", # Whether the issue can be resolved by the merchant.
+            "servability": "A String", # How this issue affects serving of the aggregate offer.
+          },
+        ],
+        "lastUpdateDate": "A String", # Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
+      },
+      "customAttributes": [ # Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ "name": "size type", "value": "regular" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.
+        { # A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.
+          "groupValues": [ # Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.
+            # Object with schema name: CustomAttribute
+          ],
+          "name": "A String", # The name of the attribute.
+          "value": "A String", # The value of the attribute. If `value` is not empty, `group_values` must be empty.
+        },
+      ],
+      "feedLabel": "A String", # Output only. The feed label for the product.
+      "name": "A String", # The name of the CSS Product. Format: `"accounts/{account}/cssProducts/{css_product}"`
+      "rawProvidedId": "A String", # Output only. Your unique raw identifier for the product.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/css_v1.accounts.html b/docs/dyn/css_v1.accounts.html new file mode 100644 index 00000000000..d91a5b74714 --- /dev/null +++ b/docs/dyn/css_v1.accounts.html @@ -0,0 +1,237 @@ + + + +

CSS API . accounts

+

Instance Methods

+

+ cssProductInputs() +

+

Returns the cssProductInputs Resource.

+ +

+ cssProducts() +

+

Returns the cssProducts Resource.

+ +

+ labels() +

+

Returns the labels Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ get(name, parent=None, x__xgafv=None)

+

Retrieves a single CSS/MC account by ID.

+

+ listChildAccounts(parent, fullName=None, labelId=None, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.

+

+ listChildAccounts_next()

+

Retrieves the next page of results.

+

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

+

Updates labels assigned to CSS/MC accounts by a CSS domain.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, parent=None, x__xgafv=None) +
Retrieves a single CSS/MC account by ID.
+
+Args:
+  name: string, Required. The name of the managed CSS/MC account. Format: accounts/{account} (required)
+  parent: string, Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about CSS/MC account.
+  "accountType": "A String", # Output only. The type of this account.
+  "automaticLabelIds": [ # Automatically created label IDs assigned to the MC account by CSS Center.
+    "A String",
+  ],
+  "displayName": "A String", # The CSS/MC account's short display name.
+  "fullName": "A String", # Output only. Immutable. The CSS/MC account's full name.
+  "homepageUri": "A String", # Output only. Immutable. The CSS/MC account's homepage.
+  "labelIds": [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
+    "A String",
+  ],
+  "name": "A String", # The label resource name. Format: accounts/{account}
+  "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.
+}
+
+ +
+ listChildAccounts(parent, fullName=None, labelId=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.
+
+Args:
+  parent: string, Required. The parent account. Must be a CSS group or domain. Format: accounts/{account} (required)
+  fullName: string, If set, only the MC accounts with the given name (case sensitive) will be returned.
+  labelId: string, If set, only the MC accounts with the given label ID will be returned.
+  pageSize: integer, Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the `ListChildAccounts` method.
+  "accounts": [ # The CSS/MC accounts returned for the specified CSS parent account.
+    { # Information about CSS/MC account.
+      "accountType": "A String", # Output only. The type of this account.
+      "automaticLabelIds": [ # Automatically created label IDs assigned to the MC account by CSS Center.
+        "A String",
+      ],
+      "displayName": "A String", # The CSS/MC account's short display name.
+      "fullName": "A String", # Output only. Immutable. The CSS/MC account's full name.
+      "homepageUri": "A String", # Output only. Immutable. The CSS/MC account's homepage.
+      "labelIds": [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
+        "A String",
+      ],
+      "name": "A String", # The label resource name. Format: accounts/{account}
+      "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listChildAccounts_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.
+        
+
+ +
+ updateLabels(name, body=None, x__xgafv=None) +
Updates labels assigned to CSS/MC accounts by a CSS domain.
+
+Args:
+  name: string, Required. The label resource name. Format: accounts/{account} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request message for the `UpdateLabels` method.
+  "labelIds": [ # The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.
+    "A String",
+  ],
+  "parent": "A String", # Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Information about CSS/MC account.
+  "accountType": "A String", # Output only. The type of this account.
+  "automaticLabelIds": [ # Automatically created label IDs assigned to the MC account by CSS Center.
+    "A String",
+  ],
+  "displayName": "A String", # The CSS/MC account's short display name.
+  "fullName": "A String", # Output only. Immutable. The CSS/MC account's full name.
+  "homepageUri": "A String", # Output only. Immutable. The CSS/MC account's homepage.
+  "labelIds": [ # Manually created label IDs assigned to the CSS/MC account by a CSS parent account.
+    "A String",
+  ],
+  "name": "A String", # The label resource name. Format: accounts/{account}
+  "parent": "A String", # The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/css_v1.accounts.labels.html b/docs/dyn/css_v1.accounts.labels.html new file mode 100644 index 00000000000..85e7753e100 --- /dev/null +++ b/docs/dyn/css_v1.accounts.labels.html @@ -0,0 +1,236 @@ + + + +

CSS API . accounts . labels

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new label, not assigned to any account.

+

+ delete(name, x__xgafv=None)

+

Deletes a label and removes it from all accounts to which it was assigned.

+

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

+

Lists the labels assigned to an account.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a label.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new label, not assigned to any account.
+
+Args:
+  parent: string, Required. The parent account. Format: accounts/{account} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
+  "accountId": "A String", # Output only. The ID of account this label belongs to.
+  "description": "A String", # The description of this label.
+  "displayName": "A String", # The display name of this label.
+  "labelId": "A String", # Output only. The ID of the label.
+  "labelType": "A String", # Output only. The type of this label.
+  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
+  "accountId": "A String", # Output only. The ID of account this label belongs to.
+  "description": "A String", # The description of this label.
+  "displayName": "A String", # The display name of this label.
+  "labelId": "A String", # Output only. The ID of the label.
+  "labelType": "A String", # Output only. The type of this label.
+  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a label and removes it from all accounts to which it was assigned.
+
+Args:
+  name: string, Required. The name of the label to delete. Format: accounts/{account}/labels/{label} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists the labels assigned to an account.
+
+Args:
+  parent: string, Required. The parent account. Format: accounts/{account} (required)
+  pageSize: integer, The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the `ListAccountLabels` method.
+  "accountLabels": [ # The labels from the specified account.
+    { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
+      "accountId": "A String", # Output only. The ID of account this label belongs to.
+      "description": "A String", # The description of this label.
+      "displayName": "A String", # The display name of this label.
+      "labelId": "A String", # Output only. The ID of the label.
+      "labelType": "A String", # Output only. The type of this label.
+      "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
+    },
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, x__xgafv=None) +
Updates a label.
+
+Args:
+  name: string, The resource name of the label. Format: accounts/{account}/labels/{label} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Label assigned by CSS domain or CSS group to one of its sub-accounts.
+  "accountId": "A String", # Output only. The ID of account this label belongs to.
+  "description": "A String", # The description of this label.
+  "displayName": "A String", # The display name of this label.
+  "labelId": "A String", # Output only. The ID of the label.
+  "labelType": "A String", # Output only. The type of this label.
+  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Label assigned by CSS domain or CSS group to one of its sub-accounts.
+  "accountId": "A String", # Output only. The ID of account this label belongs to.
+  "description": "A String", # The description of this label.
+  "displayName": "A String", # The display name of this label.
+  "labelId": "A String", # Output only. The ID of the label.
+  "labelType": "A String", # Output only. The type of this label.
+  "name": "A String", # The resource name of the label. Format: accounts/{account}/labels/{label}
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/css_v1.html b/docs/dyn/css_v1.html new file mode 100644 index 00000000000..e84ee3786b8 --- /dev/null +++ b/docs/dyn/css_v1.html @@ -0,0 +1,111 @@ + + + +

CSS API

+

Instance Methods

+

+ accounts() +

+

Returns the accounts 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/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index 4a27a21b9f5..0ba0fc29ca3 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -322,7 +322,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -513,7 +520,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -729,7 +743,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -931,7 +952,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1141,7 +1169,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1333,7 +1368,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index a5f3e3b088f..db4c5bcc0c5 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -322,7 +322,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -513,7 +520,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -729,7 +743,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -931,7 +952,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1141,7 +1169,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1333,7 +1368,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2.projects.locations.encryptionSpec.html b/docs/dyn/dialogflow_v2.projects.locations.encryptionSpec.html new file mode 100644 index 00000000000..80b689aa789 --- /dev/null +++ b/docs/dyn/dialogflow_v2.projects.locations.encryptionSpec.html @@ -0,0 +1,134 @@ + + + +

Dialogflow API . projects . locations . encryptionSpec

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ initialize(name, body=None, x__xgafv=None) +
Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
+
+Args:
+  name: string, Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to initialize a location-level encryption specification.
+  "encryptionSpec": { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). # Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced.
+    "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
+    "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
+  },
+}
+
+  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/dialogflow_v2.projects.locations.html b/docs/dyn/dialogflow_v2.projects.locations.html index 11b9e7ab32f..7a82f7a8c98 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.html @@ -104,6 +104,11 @@

Instance Methods

Returns the conversations Resource.

+

+ encryptionSpec() +

+

Returns the encryptionSpec Resource.

+

generators()

@@ -141,6 +146,9 @@

Instance Methods

getAgent(parent, x__xgafv=None)

Retrieves the specified agent.

+

+ getEncryptionSpec(name, x__xgafv=None)

+

Gets location-level encryption key specification.

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

Lists information about the supported locations for this service.

@@ -233,6 +241,26 @@

Method Details

}
+
+ getEncryptionSpec(name, x__xgafv=None) +
Gets location-level encryption key specification.
+
+Args:
+  name: string, Required. The name of the encryption spec resource to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
+  "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
+  "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
+}
+
+
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service.
diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
index a971b5d5614..10ac769932c 100644
--- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
+++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html
@@ -262,7 +262,14 @@ 

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index 4152dd652bc..d77cfce5485 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -262,7 +262,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index e86cdfd3a64..eadbc55ced6 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -322,7 +322,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -513,7 +520,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -729,7 +743,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -931,7 +952,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1141,7 +1169,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1333,7 +1368,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html index c91af537164..fb3d6d52399 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.messages.html @@ -116,6 +116,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. @@ -156,6 +188,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. @@ -209,6 +273,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index c3935c1e89b..26259690bbb 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -4585,6 +4585,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index 5b283fa9e86..32cdb1c8327 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -322,7 +322,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -513,7 +520,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -729,7 +743,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -931,7 +952,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1141,7 +1169,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -1333,7 +1368,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html index 75d6ad4e170..e5c821c7e3b 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.messages.html @@ -116,6 +116,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. @@ -156,6 +188,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. @@ -209,6 +273,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index 79f806031f5..e8bec902700 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -4585,6 +4585,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.encryptionSpec.html b/docs/dyn/dialogflow_v2beta1.projects.locations.encryptionSpec.html new file mode 100644 index 00000000000..7c18d48ab1d --- /dev/null +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.encryptionSpec.html @@ -0,0 +1,134 @@ + + + +

Dialogflow API . projects . locations . encryptionSpec

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ initialize(name, body=None, x__xgafv=None) +
Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
+
+Args:
+  name: string, Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to initialize a location-level encryption specification.
+  "encryptionSpec": { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). # Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced.
+    "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
+    "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
+  },
+}
+
+  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/dialogflow_v2beta1.projects.locations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.html index ea91938d5ad..4d9ebe608b3 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.html @@ -94,6 +94,11 @@

Instance Methods

Returns the conversations Resource.

+

+ encryptionSpec() +

+

Returns the encryptionSpec Resource.

+

generators()

@@ -131,6 +136,9 @@

Instance Methods

getAgent(parent, x__xgafv=None)

Retrieves the specified agent.

+

+ getEncryptionSpec(name, x__xgafv=None)

+

Gets location-level encryption key specification.

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

Lists information about the supported locations for this service.

@@ -223,6 +231,26 @@

Method Details

}
+
+ getEncryptionSpec(name, x__xgafv=None) +
Gets location-level encryption key specification.
+
+Args:
+  name: string, Required. The name of the encryption spec resource to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
+  "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
+  "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
+}
+
+
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service.
diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
index b05fde7165a..55767346106 100644
--- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
+++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html
@@ -262,7 +262,14 @@ 

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -302,6 +309,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index 9d723c6d831..207e2beb9a8 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -262,7 +262,14 @@

Method Details

}, "securitySettings": "A String", # Name of the CX SecuritySettings reference for the agent. Format: `projects//locations//securitySettings/`. "sttConfig": { # Configures speech transcription for ConversationProfile. # Settings for speech transcription. + "alternativeLanguageCodes": [ # Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. + "A String", + ], + "audioEncoding": "A String", # Audio encoding of the audio content to process. + "enableWordInfo": True or False, # If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. + "languageCode": "A String", # The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. "model": "A String", # Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. + "sampleRateHertz": 42, # Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. "speechModelVariant": "A String", # The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. "useTimeoutBasedEndpointing": True or False, # Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. }, @@ -302,6 +309,38 @@

Method Details

"name": "A String", # Optional. The unique identifier of the message. Format: `projects//locations//conversations//messages/`. "participant": "A String", # Output only. The participant that sends this message. "participantRole": "A String", # Output only. The role of the participant. + "responseMessages": [ # Optional. Automated agent responses. + { # Response messages from an automated agent. + "endInteraction": { # Indicates that interaction with the Dialogflow agent has ended. # A signal that indicates the interaction with the Dialogflow agent has ended. + }, + "liveAgentHandoff": { # Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human. # Hands off conversation to a live agent. + "metadata": { # Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this. + "a_key": "", # Properties of the object. + }, + }, + "mixedAudio": { # Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs. # An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client. + "segments": [ # Segments this audio response is composed of. + { # Represents one segment of audio. + "allowPlaybackInterruption": True or False, # Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request. + "audio": "A String", # Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request. + "uri": "A String", # Client-specific URI that points to an audio clip accessible to the client. + }, + ], + }, + "payload": { # Returns a response containing a custom, platform-specific payload. + "a_key": "", # Properties of the object. + }, + "telephonyTransferCall": { # Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint. # A signal that the client should transfer the phone call connected to this agent to a third-party endpoint. + "phoneNumber": "A String", # Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164). + "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. + "A String", + ], + }, + }, + ], "sendTime": "A String", # Optional. The time when the message was sent. "sentimentAnalysis": { # The result of sentiment analysis. Sentiment analysis inspects user input and identifies the prevailing subjective opinion, especially to determine a user's attitude as positive, negative, or neutral. For Participants.DetectIntent, it needs to be configured in DetectIntentRequest.query_params. For Participants.StreamingDetectIntent, it needs to be configured in StreamingDetectIntentRequest.query_params. And for Participants.AnalyzeContent and Participants.StreamingAnalyzeContent, it needs to be configured in ConversationProfile.human_agent_assistant_config # Output only. The sentiment analysis result for the message. "queryTextSentiment": { # The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result. # The sentiment analysis result for `query_text`. 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 b215ff76f33..9b21237cb8f 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html @@ -466,6 +466,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -801,6 +802,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1283,6 +1285,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1309,6 +1312,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1894,6 +1898,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2229,6 +2234,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2711,6 +2717,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2737,6 +2744,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -3221,6 +3229,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3556,6 +3565,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4449,6 +4459,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4784,6 +4795,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5266,6 +5278,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -5292,6 +5305,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html index f56af6a979d..88a395ec5d5 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html @@ -173,6 +173,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -699,6 +700,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1294,6 +1296,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1915,6 +1918,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2459,6 +2463,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2986,6 +2991,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level 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 04bcb82fb12..a92bfda41d8 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html @@ -291,6 +291,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -626,6 +627,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1296,6 +1298,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1631,6 +1634,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2327,6 +2331,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2662,6 +2667,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3344,6 +3350,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3679,6 +3686,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4366,6 +4374,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4701,6 +4710,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5372,6 +5382,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5707,6 +5718,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html index 502eb2ab9cc..f2442a1d2ed 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html @@ -469,6 +469,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -804,6 +805,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1286,6 +1288,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1312,6 +1315,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1897,6 +1901,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2232,6 +2237,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2714,6 +2720,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2740,6 +2747,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -3224,6 +3232,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3559,6 +3568,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4452,6 +4462,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4787,6 +4798,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5269,6 +5281,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -5295,6 +5308,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html index 64486e551ff..233cef3cda8 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html @@ -560,6 +560,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -744,6 +745,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1408,6 +1410,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1743,6 +1746,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2257,6 +2261,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2921,6 +2926,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3256,6 +3262,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4142,6 +4149,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4477,6 +4485,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5254,6 +5263,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5589,6 +5599,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6131,8 +6142,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -6377,6 +6388,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6712,6 +6724,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7489,6 +7502,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7824,6 +7838,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8366,8 +8381,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -8663,6 +8678,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8998,6 +9014,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -9775,6 +9792,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10110,6 +10128,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10652,8 +10671,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -10958,6 +10977,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -11293,6 +11313,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12070,6 +12091,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12405,6 +12427,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12947,8 +12970,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -13211,6 +13234,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -13546,6 +13570,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -14323,6 +14348,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -14658,6 +14684,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -15200,8 +15227,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -15447,6 +15474,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -15782,6 +15810,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -16559,6 +16588,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -16894,6 +16924,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -17436,8 +17467,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "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 fd26293be46..ad02f8d0928 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html @@ -333,6 +333,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -668,6 +669,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1463,6 +1465,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1798,6 +1801,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index 1dd4b87b981..f25beb9569b 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -249,6 +249,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -887,6 +888,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1599,6 +1601,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1958,6 +1961,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2476,6 +2480,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2502,6 +2507,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2987,6 +2993,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3699,6 +3706,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4058,6 +4066,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4576,6 +4585,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4602,6 +4612,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -5093,6 +5104,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5452,6 +5464,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6114,6 +6127,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6752,6 +6766,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7464,6 +7479,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7823,6 +7839,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8341,6 +8358,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -8367,6 +8385,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -8852,6 +8871,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -9564,6 +9584,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -9923,6 +9944,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10441,6 +10463,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -10467,6 +10490,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -10958,6 +10982,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -11317,6 +11342,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level 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 ee31241b7de..f00406f9338 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -334,6 +334,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1046,6 +1047,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1405,6 +1407,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1923,6 +1926,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1949,6 +1953,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2492,6 +2497,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3204,6 +3210,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3563,6 +3570,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4081,6 +4089,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4107,6 +4116,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4709,6 +4719,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5068,6 +5079,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5865,6 +5877,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6577,6 +6590,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6936,6 +6950,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7454,6 +7469,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -7480,6 +7496,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html index 9b57f9f76c4..c2fced11d96 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html @@ -173,6 +173,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -735,6 +736,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1366,6 +1368,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2023,6 +2026,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2603,6 +2607,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3166,6 +3171,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level 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 bc450131c72..5ab69e0a597 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html @@ -303,6 +303,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -662,6 +663,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1380,6 +1382,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1739,6 +1742,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2483,6 +2487,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2842,6 +2847,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3572,6 +3578,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3931,6 +3938,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4666,6 +4674,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5025,6 +5034,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5744,6 +5754,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6103,6 +6114,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html index 5a50b5e8863..09a57263bdf 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html @@ -337,6 +337,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1049,6 +1050,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1408,6 +1410,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1926,6 +1929,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -1952,6 +1956,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -2495,6 +2500,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3207,6 +3213,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3566,6 +3573,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4084,6 +4092,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4110,6 +4119,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -4712,6 +4722,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5071,6 +5082,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5868,6 +5880,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6580,6 +6593,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6939,6 +6953,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7457,6 +7472,7 @@

Method Details

"dataStoreConnectionSignals": { # Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ... # Optional. Data store connection feature output signals. Filled only when data stores are involved in serving the query and DetectIntentRequest.populate data_store_connection_quality_signals is set to true in the request. "answer": "A String", # Optional. The final compiled answer. "answerGenerationModelCallSignals": { # Diagnostic info related to the answer generation model call. # Optional. Diagnostic info related to the answer generation model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, @@ -7483,6 +7499,7 @@

Method Details

"score": "A String", # Grounding score bucket setting. }, "rewriterModelCallSignals": { # Diagnostic info related to the rewriter model call. # Optional. Diagnostic info related to the rewriter model call. + "model": "A String", # Name of the generative model. For example, "gemini-ultra", "gemini-pro", "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown. "modelOutput": "A String", # Output of the generative model. "renderedPrompt": "A String", # Prompt as sent to the model. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html index 6441e5e8850..1a60d6b5b28 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html @@ -584,6 +584,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -780,6 +781,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1492,6 +1494,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1851,6 +1854,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -2401,6 +2405,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3113,6 +3118,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -3472,6 +3478,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4428,6 +4435,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -4787,6 +4795,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5622,6 +5631,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -5981,6 +5991,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -6559,8 +6570,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -6827,6 +6838,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -7186,6 +7198,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8021,6 +8034,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8380,6 +8394,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -8958,8 +8973,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -9277,6 +9292,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -9636,6 +9652,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10471,6 +10488,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -10830,6 +10848,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -11408,8 +11427,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -11736,6 +11755,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12095,6 +12115,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -12930,6 +12951,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -13289,6 +13311,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -13867,8 +13890,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -14153,6 +14176,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -14512,6 +14536,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -15347,6 +15372,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -15706,6 +15732,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -16284,8 +16311,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "A String", ], @@ -16553,6 +16580,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -16912,6 +16940,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -17747,6 +17776,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -18106,6 +18136,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -18684,8 +18715,8 @@

Method Details

}, ], "testConfig": { # Represents configurations for a test case. # Config for the test case. - "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. - "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. + "flow": "A String", # Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. + "page": "A String", # The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. "trackingParameters": [ # Session parameters to be compared when calculating differences. "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 29ee57e02b2..eca1910f4d4 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html @@ -355,6 +355,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -714,6 +715,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1567,6 +1569,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level @@ -1926,6 +1929,7 @@

Method Details

"name": "A String", # Output only. The unique identifier of this event handler. "targetFlow": "A String", # The target flow to transition to. Format: `projects//locations//agents//flows/`. "targetPage": "A String", # The target page to transition to. Format: `projects//locations//agents//flows//pages/`. + "targetPlaybook": "A String", # The target playbook to transition to. Format: `projects//locations//agents//playbooks/`. "triggerFulfillment": { # A fulfillment can do one or more of the following actions at the same time: * Generate rich message responses. * Set parameter values. * Call the webhook. Fulfillments can be called at various stages in the Page or Form lifecycle. For example, when a DetectIntentRequest drives a session to enter a new page, the page's entry fulfillment can add a static response to the QueryResult in the returning DetectIntentResponse, call the webhook (for example, to load user data from a database), or both. # The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks. "advancedSettings": { # Hierarchical advanced settings for agent/flow/page/fulfillment/parameter. Settings exposed at lower level overrides the settings exposed at higher level. Overriding occurs at the sub-setting level. For example, the playback_interruption_settings at fulfillment level only overrides the playback_interruption_settings at the agent level, leaving other settings at the agent level unchanged. DTMF settings does not override each other. DTMF settings set at different levels define DTMF detections running in parallel. Hierarchy: Agent->Flow->Page->Fulfillment/Parameter. # Hierarchical advanced settings for this fulfillment. The settings exposed at the lower level overrides the settings exposed at the higher level. "audioExportGcsDestination": { # Google Cloud Storage location for a Dialogflow operation that writes or exports objects (e.g. exported agent or transcripts) outside of Dialogflow. # If present, incoming audio is exported by Dialogflow to the configured Google Cloud Storage destination. Exposed at the following levels: - Agent level - Flow level diff --git a/docs/dyn/discovery_v1.apis.html b/docs/dyn/discovery_v1.apis.html index 09281a9f25d..093b67e18be 100644 --- a/docs/dyn/discovery_v1.apis.html +++ b/docs/dyn/discovery_v1.apis.html @@ -117,14 +117,6 @@

Method Details

"description": "A String", # The description of this API. "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. "documentationLink": "A String", # A link to human readable documentation for the API. - "endpoints": [ # A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status. - { # A single endpoint object - "deprecated": True or False, # Whether this endpoint is deprecated - "description": "A String", # A string describing the host designated by the URL - "endpointUrl": "A String", # The URL of the endpoint target host - "location": "A String", # The location of the endpoint - }, - ], "etag": "A String", # The ETag for this response. "exponentialBackoffDefault": True or False, # Enable exponential backoff for suitable methods in the generated clients. "features": [ # A list of supported features for this API. @@ -141,8 +133,6 @@

Method Details

], "methods": { # API-level methods for this API. "a_key": { # An individual method description. - "apiVersion": "A String", # The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter. - "deprecated": True or False, # Whether this method is deprecated. "description": "A String", # Description of this method. "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. "flatPath": "A String", # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property. @@ -177,14 +167,10 @@

Method Details

], }, "default": "A String", # The default value of this property (if one exists). - "deprecated": True or False, # Whether the parameter is deprecated. "description": "A String", # A description of this object. "enum": [ # Values this parameter may take (if it is an enum). "A String", ], - "enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. - True or False, - ], "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. "A String", ], @@ -244,14 +230,10 @@

Method Details

], }, "default": "A String", # The default value of this property (if one exists). - "deprecated": True or False, # Whether the parameter is deprecated. "description": "A String", # A description of this object. "enum": [ # Values this parameter may take (if it is an enum). "A String", ], - "enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. - True or False, - ], "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. "A String", ], @@ -283,11 +265,8 @@

Method Details

"protocol": "rest", # The protocol described by this document. "resources": { # The resources in this API. "a_key": { # An individual resource description. Contains methods and sub-resources related to this resource. - "deprecated": True or False, # Whether this resource is deprecated. "methods": { # Methods on this resource. "a_key": { # Description for any methods on this resource. - "apiVersion": "A String", # The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter. - "deprecated": True or False, # Whether this method is deprecated. "description": "A String", # Description of this method. "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. "flatPath": "A String", # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property. @@ -322,14 +301,10 @@

Method Details

], }, "default": "A String", # The default value of this property (if one exists). - "deprecated": True or False, # Whether the parameter is deprecated. "description": "A String", # A description of this object. "enum": [ # Values this parameter may take (if it is an enum). "A String", ], - "enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. - True or False, - ], "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. "A String", ], @@ -392,14 +367,10 @@

Method Details

], }, "default": "A String", # The default value of this property (if one exists). - "deprecated": True or False, # Whether the parameter is deprecated. "description": "A String", # A description of this object. "enum": [ # Values this parameter may take (if it is an enum). "A String", ], - "enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. - True or False, - ], "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. "A String", ], diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 014a5ec2a36..1902cb81a80 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -126,6 +126,7 @@

Method Details

}, "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification. "disable": True or False, # Disable query rephraser. + "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. }, }, "relatedQuestionsSpec": { # Related questions specification. # Related questions specification. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index 9f57c958e4b..c1e3772091c 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -126,6 +126,7 @@

Method Details

}, "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification. "disable": True or False, # Disable query rephraser. + "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. }, }, "relatedQuestionsSpec": { # Related questions specification. # Related questions specification. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index a1001f39a47..26cdb02fa76 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -126,6 +126,7 @@

Method Details

}, "queryRephraserSpec": { # Query rephraser specification. # Query rephraser specification. "disable": True or False, # Disable query rephraser. + "maxRephraseSteps": 42, # Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default. }, }, "relatedQuestionsSpec": { # Related questions specification. # Related questions specification. diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html index 3e4b6271e9c..271ff97d6d1 100644 --- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html @@ -166,7 +166,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -382,7 +382,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -622,7 +622,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -849,7 +849,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -1084,7 +1084,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -1301,7 +1301,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index 69af753d38f..ceac9043216 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -161,7 +161,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -220,7 +220,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -734,7 +734,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -793,7 +793,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index b0bcb06a6f7..e511be106c4 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -161,7 +161,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -220,7 +220,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -678,7 +678,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -737,7 +737,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html index 988b0ed7b32..7b3d8c81b4a 100644 --- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html +++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html @@ -166,7 +166,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -382,7 +382,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -622,7 +622,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -849,7 +849,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -1084,7 +1084,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -1301,7 +1301,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index 7f79fb107ab..fda2894196b 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -161,7 +161,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -220,7 +220,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -734,7 +734,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -793,7 +793,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index 4e1441ac5e5..b4dc2193769 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -161,7 +161,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -220,7 +220,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -678,7 +678,7 @@

Method Details

"A String", ], "location": { # The data that will be profiled. # The data to scan. - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. @@ -737,7 +737,7 @@

Method Details

"name": "A String", # Unique resource name for the DiscoveryConfig, assigned by the service when the DiscoveryConfig is created, for example `projects/dlp-test-project/locations/global/discoveryConfigs/53234423`. "orgConfig": { # Project and scan location information. Only set when the parent is an org. # Only set when the parent is an org. "location": { # The location to begin a discovery scan. Denotes an organization ID or folder ID within an organization. # The data to scan: folder, org, or project - "folderId": "A String", # The ID of the Folder within an organization to scan. + "folderId": "A String", # The ID of the folder within an organization to scan. "organizationId": "A String", # The ID of an organization to scan. }, "projectId": "A String", # The project that will run the scan. The DLP service account that exists within this project must have access to all resources that are profiled, and the Cloud DLP API must be enabled. diff --git a/docs/dyn/essentialcontacts_v1.folders.contacts.html b/docs/dyn/essentialcontacts_v1.folders.contacts.html index a2c69092fa5..9a7773fd3bc 100644 --- a/docs/dyn/essentialcontacts_v1.folders.contacts.html +++ b/docs/dyn/essentialcontacts_v1.folders.contacts.html @@ -147,7 +147,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -185,7 +185,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } x__xgafv: string, V1 error format. @@ -204,7 +204,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
@@ -248,7 +248,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
@@ -278,7 +278,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -316,7 +316,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -336,7 +336,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
diff --git a/docs/dyn/essentialcontacts_v1.organizations.contacts.html b/docs/dyn/essentialcontacts_v1.organizations.contacts.html index 607c849a3b5..294ce730264 100644 --- a/docs/dyn/essentialcontacts_v1.organizations.contacts.html +++ b/docs/dyn/essentialcontacts_v1.organizations.contacts.html @@ -147,7 +147,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -185,7 +185,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } x__xgafv: string, V1 error format. @@ -204,7 +204,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
@@ -248,7 +248,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
@@ -278,7 +278,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -316,7 +316,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -336,7 +336,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
diff --git a/docs/dyn/essentialcontacts_v1.projects.contacts.html b/docs/dyn/essentialcontacts_v1.projects.contacts.html index 2a858c29e80..dcfe58917a4 100644 --- a/docs/dyn/essentialcontacts_v1.projects.contacts.html +++ b/docs/dyn/essentialcontacts_v1.projects.contacts.html @@ -147,7 +147,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -185,7 +185,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } x__xgafv: string, V1 error format. @@ -204,7 +204,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }
@@ -248,7 +248,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } @@ -278,7 +278,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. }, ], "nextPageToken": "A String", # If there are more results than those appearing in this response, then `next_page_token` is included. To get the next set of results, call this method again using the value of `next_page_token` as `page_token` and the rest of the parameters the same as the original request. @@ -316,7 +316,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } updateMask: string, Optional. The update mask applied to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -336,7 +336,7 @@

Method Details

"A String", ], "validateTime": "A String", # The last time the validation_state was updated, either manually or automatically. A contact is considered stale if its validation state was updated more than 1 year ago. - "validationState": "A String", # The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. + "validationState": "A String", # Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource. } diff --git a/docs/dyn/file_v1beta1.projects.locations.backups.html b/docs/dyn/file_v1beta1.projects.locations.backups.html index 598879bfc27..ed1bdab6891 100644 --- a/docs/dyn/file_v1beta1.projects.locations.backups.html +++ b/docs/dyn/file_v1beta1.projects.locations.backups.html @@ -115,6 +115,7 @@

Method Details

"createTime": "A String", # Output only. The time when the backup was created. "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored + "fileSystemProtocol": "A String", # Output only. The file system protocol of the source Filestore instance that this backup is created from. "kmsKeyName": "A String", # Immutable. KMS key name used for data encryption. "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", @@ -216,6 +217,7 @@

Method Details

"createTime": "A String", # Output only. The time when the backup was created. "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored + "fileSystemProtocol": "A String", # Output only. The file system protocol of the source Filestore instance that this backup is created from. "kmsKeyName": "A String", # Immutable. KMS key name used for data encryption. "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", @@ -259,6 +261,7 @@

Method Details

"createTime": "A String", # Output only. The time when the backup was created. "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored + "fileSystemProtocol": "A String", # Output only. The file system protocol of the source Filestore instance that this backup is created from. "kmsKeyName": "A String", # Immutable. KMS key name used for data encryption. "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", @@ -311,6 +314,7 @@

Method Details

"createTime": "A String", # Output only. The time when the backup was created. "description": "A String", # A description of the backup with 2048 characters or less. Requests with longer descriptions will be rejected. "downloadBytes": "A String", # Output only. Amount of bytes that will be downloaded if the backup is restored + "fileSystemProtocol": "A String", # Output only. The file system protocol of the source Filestore instance that this backup is created from. "kmsKeyName": "A String", # Immutable. KMS key name used for data encryption. "labels": { # Resource labels to represent user provided metadata. "a_key": "A String", diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index a727ab2d81a..84f3c3e86f1 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -117,6 +117,15 @@

Method Details

"createTime": "A String", # Output only. Timestamp when the test was run. "deviceExecutions": [ # Required. The results of the test on each device. { # The results of running an automated test on a particular device. + "aiStepResults": [ # Output only. Results of the AI steps if passed in + { # Captures the results of an AiStep + "state": "A String", # Output only. The current state of the step + "step": { # A step to be accomplished by the AI # Required. The step performed by the AI + "assertion": "A String", # An assertion to be checked by the AI + "goal": "A String", # A goal to be accomplished by the AI + }, + }, + ], "appCrash": { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test. "message": "A String", # Output only. The message associated with the crash. "stackTrace": "A String", # Output only. The raw stack trace. @@ -178,6 +187,15 @@

Method Details

"createTime": "A String", # Output only. Timestamp when the test was run. "deviceExecutions": [ # Required. The results of the test on each device. { # The results of running an automated test on a particular device. + "aiStepResults": [ # Output only. Results of the AI steps if passed in + { # Captures the results of an AiStep + "state": "A String", # Output only. The current state of the step + "step": { # A step to be accomplished by the AI # Required. The step performed by the AI + "assertion": "A String", # An assertion to be checked by the AI + "goal": "A String", # A goal to be accomplished by the AI + }, + }, + ], "appCrash": { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test. "message": "A String", # Output only. The message associated with the crash. "stackTrace": "A String", # Output only. The raw stack trace. @@ -245,6 +263,15 @@

Method Details

"createTime": "A String", # Output only. Timestamp when the test was run. "deviceExecutions": [ # Required. The results of the test on each device. { # The results of running an automated test on a particular device. + "aiStepResults": [ # Output only. Results of the AI steps if passed in + { # Captures the results of an AiStep + "state": "A String", # Output only. The current state of the step + "step": { # A step to be accomplished by the AI # Required. The step performed by the AI + "assertion": "A String", # An assertion to be checked by the AI + "goal": "A String", # A goal to be accomplished by the AI + }, + }, + ], "appCrash": { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test. "message": "A String", # Output only. The message associated with the crash. "stackTrace": "A String", # Output only. The raw stack trace. @@ -317,6 +344,15 @@

Method Details

"createTime": "A String", # Output only. Timestamp when the test was run. "deviceExecutions": [ # Required. The results of the test on each device. { # The results of running an automated test on a particular device. + "aiStepResults": [ # Output only. Results of the AI steps if passed in + { # Captures the results of an AiStep + "state": "A String", # Output only. The current state of the step + "step": { # A step to be accomplished by the AI # Required. The step performed by the AI + "assertion": "A String", # An assertion to be checked by the AI + "goal": "A String", # A goal to be accomplished by the AI + }, + }, + ], "appCrash": { # An app crash that occurred during an automated test. # Output only. An app crash, if any occurred during the test. "message": "A String", # Output only. The message associated with the crash. "stackTrace": "A String", # Output only. The raw stack trace. diff --git a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html index 2d4801bf3a6..11ad3023ad7 100644 --- a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html +++ b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html @@ -118,7 +118,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -150,7 +150,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -207,7 +207,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -248,7 +248,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -284,7 +284,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. @@ -317,7 +317,7 @@

Method Details

}, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. diff --git a/docs/dyn/gkehub_v1.projects.locations.features.html b/docs/dyn/gkehub_v1.projects.locations.features.html index 834b94ccf7a..5752333b10b 100644 --- a/docs/dyn/gkehub_v1.projects.locations.features.html +++ b/docs/dyn/gkehub_v1.projects.locations.features.html @@ -254,7 +254,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -451,7 +451,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -549,7 +549,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -588,11 +590,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -1187,7 +1191,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1384,7 +1388,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -1482,7 +1486,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -1521,11 +1527,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -2108,7 +2116,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -2305,7 +2313,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -2403,7 +2411,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -2442,11 +2452,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -2985,7 +2997,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -3182,7 +3194,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -3280,7 +3292,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -3319,11 +3333,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, diff --git a/docs/dyn/gkehub_v1.projects.locations.memberships.rbacrolebindings.html b/docs/dyn/gkehub_v1.projects.locations.memberships.rbacrolebindings.html index 63e047a130c..13a46da8c33 100644 --- a/docs/dyn/gkehub_v1.projects.locations.memberships.rbacrolebindings.html +++ b/docs/dyn/gkehub_v1.projects.locations.memberships.rbacrolebindings.html @@ -77,18 +77,202 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a Membership RBACRoleBinding.

+

+ delete(name, x__xgafv=None)

+

Deletes a Membership RBACRoleBinding.

+

+ generateMembershipRBACRoleBindingYAML(parent, body=None, rbacrolebindingId=None, x__xgafv=None)

+

Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.

+

+ get(name, x__xgafv=None)

+

Returns the details of a Membership RBACRoleBinding.

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

Lists all Membership RBACRoleBindings.

list_next()

Retrieves the next page of results.

+

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

+

Updates a Membership RBACRoleBinding.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, rbacrolebindingId=None, x__xgafv=None) +
Creates a Membership RBACRoleBinding.
+
+Args:
+  parent: string, Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RBACRoleBinding represents a rbacrolebinding across the Fleet
+  "createTime": "A String", # Output only. When the rbacrolebinding was created.
+  "deleteTime": "A String", # Output only. When the rbacrolebinding was deleted.
+  "group": "A String", # group is the group, as seen by the kubernetes cluster.
+  "labels": { # Optional. Labels for this RBACRolebinding.
+    "a_key": "A String",
+  },
+  "name": "A String", # The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
+  "role": { # Role is the type for Kubernetes roles # Required. Role to bind to the principal
+    "predefinedRole": "A String", # predefined_role is the Kubernetes default role to use
+  },
+  "state": { # RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. # Output only. State of the rbacrolebinding resource.
+    "code": "A String", # Output only. The current state of the rbacrolebinding resource.
+  },
+  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid.
+  "updateTime": "A String", # Output only. When the rbacrolebinding was last updated.
+  "user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
+}
+
+  rbacrolebindingId: string, Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
+  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, x__xgafv=None) +
Deletes a Membership RBACRoleBinding.
+
+Args:
+  name: string, Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`. (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.
+  },
+}
+
+ +
+ generateMembershipRBACRoleBindingYAML(parent, body=None, rbacrolebindingId=None, x__xgafv=None) +
Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.
+
+Args:
+  parent: string, Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RBACRoleBinding represents a rbacrolebinding across the Fleet
+  "createTime": "A String", # Output only. When the rbacrolebinding was created.
+  "deleteTime": "A String", # Output only. When the rbacrolebinding was deleted.
+  "group": "A String", # group is the group, as seen by the kubernetes cluster.
+  "labels": { # Optional. Labels for this RBACRolebinding.
+    "a_key": "A String",
+  },
+  "name": "A String", # The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
+  "role": { # Role is the type for Kubernetes roles # Required. Role to bind to the principal
+    "predefinedRole": "A String", # predefined_role is the Kubernetes default role to use
+  },
+  "state": { # RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. # Output only. State of the rbacrolebinding resource.
+    "code": "A String", # Output only. The current state of the rbacrolebinding resource.
+  },
+  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid.
+  "updateTime": "A String", # Output only. When the rbacrolebinding was last updated.
+  "user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
+}
+
+  rbacrolebindingId: string, Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for GenerateRBACRoleBindingYAML.
+  "roleBindingsYaml": "A String", # a yaml text blob including the RBAC policies.
+}
+
+ +
+ get(name, x__xgafv=None) +
Returns the details of a Membership RBACRoleBinding.
+
+Args:
+  name: string, Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # RBACRoleBinding represents a rbacrolebinding across the Fleet
+  "createTime": "A String", # Output only. When the rbacrolebinding was created.
+  "deleteTime": "A String", # Output only. When the rbacrolebinding was deleted.
+  "group": "A String", # group is the group, as seen by the kubernetes cluster.
+  "labels": { # Optional. Labels for this RBACRolebinding.
+    "a_key": "A String",
+  },
+  "name": "A String", # The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
+  "role": { # Role is the type for Kubernetes roles # Required. Role to bind to the principal
+    "predefinedRole": "A String", # predefined_role is the Kubernetes default role to use
+  },
+  "state": { # RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. # Output only. State of the rbacrolebinding resource.
+    "code": "A String", # Output only. The current state of the rbacrolebinding resource.
+  },
+  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid.
+  "updateTime": "A String", # Output only. When the rbacrolebinding was last updated.
+  "user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
+}
+
+
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all Membership RBACRoleBindings.
@@ -147,4 +331,62 @@ 

Method Details

+
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a Membership RBACRoleBinding.
+
+Args:
+  name: string, The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # RBACRoleBinding represents a rbacrolebinding across the Fleet
+  "createTime": "A String", # Output only. When the rbacrolebinding was created.
+  "deleteTime": "A String", # Output only. When the rbacrolebinding was deleted.
+  "group": "A String", # group is the group, as seen by the kubernetes cluster.
+  "labels": { # Optional. Labels for this RBACRolebinding.
+    "a_key": "A String",
+  },
+  "name": "A String", # The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`
+  "role": { # Role is the type for Kubernetes roles # Required. Role to bind to the principal
+    "predefinedRole": "A String", # predefined_role is the Kubernetes default role to use
+  },
+  "state": { # RBACRoleBindingLifecycleState describes the state of a RbacRoleBinding resource. # Output only. State of the rbacrolebinding resource.
+    "code": "A String", # Output only. The current state of the rbacrolebinding resource.
+  },
+  "uid": "A String", # Output only. Google-generated UUID for this resource. This is unique across all rbacrolebinding resources. If a rbacrolebinding resource is deleted and another resource with the same name is created, it gets a different uid.
+  "updateTime": "A String", # Output only. When the rbacrolebinding was last updated.
+  "user": "A String", # user is the name of the user as seen by the kubernetes cluster, example "alice" or "alice@domain.tld"
+}
+
+  updateMask: string, Required. The fields to be updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.features.html b/docs/dyn/gkehub_v1alpha.projects.locations.features.html index 99d11c5a4ee..21bf67f3c32 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.features.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.features.html @@ -256,9 +256,10 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec + "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -466,9 +467,10 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec + "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "namespaceactuation": { # **Namespace Actuation**: The membership-specific input for NamespaceActuation feature. # FNS Actuation membership spec }, @@ -580,7 +582,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -619,11 +623,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -1350,9 +1356,10 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec + "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1560,9 +1567,10 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec + "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "namespaceactuation": { # **Namespace Actuation**: The membership-specific input for NamespaceActuation feature. # FNS Actuation membership spec }, @@ -1674,7 +1682,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -1713,11 +1723,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -2432,9 +2444,10 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec + "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -2642,9 +2655,10 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec + "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "namespaceactuation": { # **Namespace Actuation**: The membership-specific input for NamespaceActuation feature. # FNS Actuation membership spec }, @@ -2756,7 +2770,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -2795,11 +2811,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -3470,9 +3488,10 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec + "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -3680,9 +3699,10 @@

Method Details

}, }, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec + "configApi": "A String", # Optional. Specifies the API that will be used for configuring the mesh workloads. "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. "defaultChannel": "A String", # Determines which release channel to use for default injection and service mesh APIs. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "namespaceactuation": { # **Namespace Actuation**: The membership-specific input for NamespaceActuation feature. # FNS Actuation membership spec }, @@ -3794,7 +3814,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -3833,11 +3855,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, diff --git a/docs/dyn/gkehub_v1beta.projects.locations.features.html b/docs/dyn/gkehub_v1beta.projects.locations.features.html index d724f1f72a9..7894d571171 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.features.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.features.html @@ -257,7 +257,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -466,7 +466,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -570,7 +570,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -609,11 +611,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -1226,7 +1230,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -1435,7 +1439,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -1539,7 +1543,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -1578,11 +1584,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -2183,7 +2191,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -2392,7 +2400,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -2496,7 +2504,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -2535,11 +2545,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, @@ -3096,7 +3108,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "policycontroller": { # **Policy Controller**: Configuration for a single cluster. Intended to parallel the PolicyController CR. # Policy Controller spec. "policyControllerHubConfig": { # Configuration for Policy Controller # Policy Controller configuration for the cluster. @@ -3305,7 +3317,7 @@

Method Details

}, "mesh": { # **Service Mesh**: Spec for a single Membership for the servicemesh feature # Anthos Service Mesh-specific spec "controlPlane": "A String", # Deprecated: use `management` instead Enables automatic control plane management. - "management": "A String", # Enables automatic Service Mesh management. + "management": "A String", # Optional. Enables automatic Service Mesh management. }, "origin": { # Origin defines where this MembershipFeatureSpec originated from. # Whether this per-Membership spec was inherited from a fleet-level default. This field can be updated by users by either overriding a Membership config (updated to USER implicitly) or setting to FLEET explicitly. "type": "A String", # Type specifies which type of origin is set. @@ -3409,7 +3421,9 @@

Method Details

"gitSync": "A String", # Deployment state of the git-sync pod "importer": "A String", # Deployment state of the importer pod "monitor": "A String", # Deployment state of the monitor pod + "otelCollector": "A String", # Deployment state of otel-collector "reconcilerManager": "A String", # Deployment state of reconciler-manager pod + "resourceGroupControllerManager": "A String", # Deployment state of resource-group-controller-manager "rootReconciler": "A String", # Deployment state of root-reconciler "syncer": "A String", # Deployment state of the syncer pod }, @@ -3448,11 +3462,13 @@

Method Details

"syncToken": "A String", # Token indicating the state of the syncer. }, "version": { # Specific versioning information pertaining to ConfigSync's Pods # The version of ConfigSync deployed - "admissionWebhook": "A String", # Version of the deployed admission_webhook pod + "admissionWebhook": "A String", # Version of the deployed admission-webhook pod "gitSync": "A String", # Version of the deployed git-sync pod "importer": "A String", # Version of the deployed importer pod "monitor": "A String", # Version of the deployed monitor pod + "otelCollector": "A String", # Version of the deployed otel-collector pod "reconcilerManager": "A String", # Version of the deployed reconciler-manager pod + "resourceGroupControllerManager": "A String", # Version of the deployed resource-group-controller-manager pod "rootReconciler": "A String", # Version of the deployed reconciler container in root-reconciler pod "syncer": "A String", # Version of the deployed syncer pod }, diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 4adf2c7fb67..059ad88ad4f 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -49,6 +49,10 @@ * [v4.1](http://googleapis.github.io/google-api-python-client/docs/dyn/adsensehost_v4_1.html) +## adsenseplatform +* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/adsenseplatform_v1alpha.html) + + ## advisorynotifications * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/advisorynotifications_v1.html) @@ -410,6 +414,10 @@ * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/contentwarehouse_v1.html) +## css +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/css_v1.html) + + ## customsearch * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/customsearch_v1.html) diff --git a/docs/dyn/integrations_v1.projects.locations.templates.html b/docs/dyn/integrations_v1.projects.locations.templates.html index 36c3679e2f4..c16221890c7 100644 --- a/docs/dyn/integrations_v1.projects.locations.templates.html +++ b/docs/dyn/integrations_v1.projects.locations.templates.html @@ -6546,77 +6546,14 @@

Method Details

The object takes the form of: { # Request to Import template - "configParameters": [ # Optional. Config parameters which would be used to configure template bundles. - { # Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes. - "parameter": { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition. # Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables. - "containsLargeData": True or False, # Indicates whether this variable contains large data and need to be uploaded to Cloud Storage. - "dataType": "A String", # Type of the parameter. - "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object. - "booleanArray": { # This message only contains a field of boolean array. # Boolean Array. - "booleanValues": [ # Boolean array. - True or False, - ], - }, - "booleanValue": True or False, # Boolean. - "doubleArray": { # This message only contains a field of double number array. # Double Number Array. - "doubleValues": [ # Double number array. - 3.14, - ], - }, - "doubleValue": 3.14, # Double Number. - "intArray": { # This message only contains a field of integer array. # Integer Array. - "intValues": [ # Integer array. - "A String", - ], - }, - "intValue": "A String", # Integer. - "jsonValue": "A String", # Json. - "stringArray": { # This message only contains a field of string array. # String Array. - "stringValues": [ # String array. - "A String", - ], - }, - "stringValue": "A String", # String. - }, - "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. - "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter. - "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition. - "masked": True or False, # True if this parameter should be masked in the logs - "producer": "A String", # The identifier of the node (TaskConfig/TriggerConfig) this parameter was produced by, if it is a transient param or a copy of an input param. - "searchable": True or False, # Searchable in the execution log or not. - }, - "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object. - "booleanArray": { # This message only contains a field of boolean array. # Boolean Array. - "booleanValues": [ # Boolean array. - True or False, - ], - }, - "booleanValue": True or False, # Boolean. - "doubleArray": { # This message only contains a field of double number array. # Double Number Array. - "doubleValues": [ # Double number array. - 3.14, - ], - }, - "doubleValue": 3.14, # Double Number. - "intArray": { # This message only contains a field of integer array. # Integer Array. - "intValues": [ # Integer array. - "A String", - ], - }, - "intValue": "A String", # Integer. - "jsonValue": "A String", # Json. - "stringArray": { # This message only contains a field of string array. # String Array. - "stringValues": [ # String array. - "A String", - ], - }, - "stringValue": "A String", # String. - }, - }, - ], "integration": "A String", # Required. Name of the integration where template needs to be imported. + "integrationRegion": "A String", # Required. The region of the Integration to be created. + "subIntegrations": { # Optional. Sub Integration which would be created via templates. + "a_key": { # Sub Integration which would be created via templates. + "integration": "A String", # Required. Name of the sub integration which would be created via templates. + "integrationDescription": "A String", # Optional. Description of the sub integration which would be created via templates. + }, + }, } x__xgafv: string, V1 error format. diff --git a/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html b/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html index 5ed7f9d922d..a16cf51d337 100644 --- a/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html +++ b/docs/dyn/logging_v2.billingAccounts.locations.savedQueries.html @@ -87,7 +87,7 @@

Instance Methods

get(name, x__xgafv=None)

Returns all data associated with the requested query.

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

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

Lists the SavedQueries that were created by the user making the request.

list_next()

@@ -220,11 +220,12 @@

Method Details

- list(parent, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the SavedQueries that were created by the user making the request.
 
 Args:
   parent: string, Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-"  (required)
+  filter: string, Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED
   pageSize: integer, Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/logging_v2.folders.html b/docs/dyn/logging_v2.folders.html
index 1b66347b404..a691dc9e063 100644
--- a/docs/dyn/logging_v2.folders.html
+++ b/docs/dyn/logging_v2.folders.html
@@ -177,7 +177,7 @@ 

Method Details

Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.UpdateSettings fails when any of the following are true: The value of storage_location either isn't supported by Logging or violates the location OrgPolicy. The default_sink_config field is set, but it has an unspecified filter write mode. The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Configure default settings for organizations and folders (https://cloud.google.com/logging/docs/default-settings) for more information.
 
 Args:
-  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" (required)
+  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/logging_v2.folders.locations.savedQueries.html b/docs/dyn/logging_v2.folders.locations.savedQueries.html
index 48b0adf2ddc..a72dc4c39d4 100644
--- a/docs/dyn/logging_v2.folders.locations.savedQueries.html
+++ b/docs/dyn/logging_v2.folders.locations.savedQueries.html
@@ -87,7 +87,7 @@ 

Instance Methods

get(name, x__xgafv=None)

Returns all data associated with the requested query.

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

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

Lists the SavedQueries that were created by the user making the request.

list_next()

@@ -220,11 +220,12 @@

Method Details

- list(parent, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the SavedQueries that were created by the user making the request.
 
 Args:
   parent: string, Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-"  (required)
+  filter: string, Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED
   pageSize: integer, Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/logging_v2.organizations.html b/docs/dyn/logging_v2.organizations.html
index 40bf00de094..eb8ceba9a80 100644
--- a/docs/dyn/logging_v2.organizations.html
+++ b/docs/dyn/logging_v2.organizations.html
@@ -213,7 +213,7 @@ 

Method Details

Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.UpdateSettings fails when any of the following are true: The value of storage_location either isn't supported by Logging or violates the location OrgPolicy. The default_sink_config field is set, but it has an unspecified filter write mode. The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Configure default settings for organizations and folders (https://cloud.google.com/logging/docs/default-settings) for more information.
 
 Args:
-  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" (required)
+  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/logging_v2.organizations.locations.savedQueries.html b/docs/dyn/logging_v2.organizations.locations.savedQueries.html
index 48d7ba47e9a..ddd0afb28c7 100644
--- a/docs/dyn/logging_v2.organizations.locations.savedQueries.html
+++ b/docs/dyn/logging_v2.organizations.locations.savedQueries.html
@@ -87,7 +87,7 @@ 

Instance Methods

get(name, x__xgafv=None)

Returns all data associated with the requested query.

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

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

Lists the SavedQueries that were created by the user making the request.

list_next()

@@ -220,11 +220,12 @@

Method Details

- list(parent, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the SavedQueries that were created by the user making the request.
 
 Args:
   parent: string, Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-"  (required)
+  filter: string, Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED
   pageSize: integer, Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/logging_v2.projects.locations.savedQueries.html b/docs/dyn/logging_v2.projects.locations.savedQueries.html
index d596c676c16..2c885c08053 100644
--- a/docs/dyn/logging_v2.projects.locations.savedQueries.html
+++ b/docs/dyn/logging_v2.projects.locations.savedQueries.html
@@ -87,7 +87,7 @@ 

Instance Methods

get(name, x__xgafv=None)

Returns all data associated with the requested query.

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

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

Lists the SavedQueries that were created by the user making the request.

list_next()

@@ -220,11 +220,12 @@

Method Details

- list(parent, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists the SavedQueries that were created by the user making the request.
 
 Args:
   parent: string, Required. The resource to which the listed queries belong. "projects/[PROJECT_ID]/locations/[LOCATION_ID]" "organizations/[ORGANIZATION_ID]/locations/[LOCATION_ID]" "billingAccounts/[BILLING_ACCOUNT_ID]/locations/[LOCATION_ID]" "folders/[FOLDER_ID]/locations/[LOCATION_ID]" For example: "projects/my-project/locations/us-central1" Note: The locations portion of the resource must be specified. To get a list of all saved queries, a wildcard character - can be used for LOCATION_ID, for example: "projects/my-project/locations/-"  (required)
+  filter: string, Optional. Specifies the type ("Logging" or "OpsAnalytics") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type("Logging") type("OpsAnalytics")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type("Logging") AND visibility = PRIVATE visibility=SHARED type("OpsAnalytics") type("OpsAnalytics)" visibility = PRIVATE visibility = SHARED
   pageSize: integer, Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.
   pageToken: string, Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/logging_v2.v2.html b/docs/dyn/logging_v2.v2.html
index 0e46f8aa473..dd8429b5ae7 100644
--- a/docs/dyn/logging_v2.v2.html
+++ b/docs/dyn/logging_v2.v2.html
@@ -193,7 +193,7 @@ 

Method Details

Updates the settings for the given resource. This method applies to all feature configurations for organization and folders.UpdateSettings fails when any of the following are true: The value of storage_location either isn't supported by Logging or violates the location OrgPolicy. The default_sink_config field is set, but it has an unspecified filter write mode. The value of kms_key_name is invalid. The associated service account doesn't have the required roles/cloudkms.cryptoKeyEncrypterDecrypter role assigned for the key. Access to the key is disabled.See Configure default settings for organizations and folders (https://cloud.google.com/logging/docs/default-settings) for more information.
 
 Args:
-  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" For example:"organizations/12345/settings" (required)
+  name: string, Required. The resource name for the settings to update. "organizations/[ORGANIZATION_ID]/settings" "folders/[FOLDER_ID]/settings" For example:"organizations/12345/settings" (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html
new file mode 100644
index 00000000000..5094ee14455
--- /dev/null
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessIdentity.html
@@ -0,0 +1,186 @@
+
+
+
+

Merchant API . accounts . businessIdentity

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getBusinessIdentity(name, x__xgafv=None)

+

Retrieves the business identity of an account.

+

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

+

Updates the business identity of an account. Executing this method requires admin access.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getBusinessIdentity(name, x__xgafv=None) +
Retrieves the business identity of an account.
+
+Args:
+  name: string, Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
+  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
+  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
+  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+}
+
+ +
+ updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None) +
Updates the business identity of an account. Executing this method requires admin access.
+
+Args:
+  name: string, Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
+  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
+  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
+  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+}
+
+  updateMask: string, Required. List of fields being updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
+  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
+  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
+  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
+    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html new file mode 100644 index 00000000000..3e031b011e9 --- /dev/null +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.businessInfo.html @@ -0,0 +1,252 @@ + + + +

Merchant API . accounts . businessInfo

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getBusinessInfo(name, x__xgafv=None)

+

Retrieves the business info of an account.

+

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

+

Updates the business info of an account. Executing this method requires admin access.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getBusinessInfo(name, x__xgafv=None) +
Retrieves the business info of an account.
+
+Args:
+  name: string, Required. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of information related to a business.
+  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+  },
+  "customerService": { # Customer service information. # Optional. The customer service of the business.
+    "email": "A String", # Optional. The email address where customer service may be reached.
+    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
+      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+      },
+    },
+    "uri": "A String", # Optional. The URI where customer service may be found.
+  },
+  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
+  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
+    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+    },
+  },
+  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
+}
+
+ +
+ updateBusinessInfo(name, body=None, updateMask=None, x__xgafv=None) +
Updates the business info of an account. Executing this method requires admin access.
+
+Args:
+  name: string, Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Collection of information related to a business.
+  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+  },
+  "customerService": { # Customer service information. # Optional. The customer service of the business.
+    "email": "A String", # Optional. The email address where customer service may be reached.
+    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
+      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+      },
+    },
+    "uri": "A String", # Optional. The URI where customer service may be found.
+  },
+  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
+  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
+    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+    },
+  },
+  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
+}
+
+  updateMask: string, Required. List of fields being updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Collection of information related to a business.
+  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
+    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
+      "A String",
+    ],
+    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
+    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
+    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
+    "organization": "A String", # Optional. The name of the organization at the address.
+    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
+    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
+      "A String",
+    ],
+    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
+    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
+    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
+    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
+  },
+  "customerService": { # Customer service information. # Optional. The customer service of the business.
+    "email": "A String", # Optional. The email address where customer service may be reached.
+    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
+      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+      },
+    },
+    "uri": "A String", # Optional. The URI where customer service may be found.
+  },
+  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
+  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
+    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
+    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
+    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
+      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
+      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
+    },
+  },
+  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.emailpreferences.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.emailpreferences.html new file mode 100644 index 00000000000..daa5e117b22 --- /dev/null +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.emailpreferences.html @@ -0,0 +1,141 @@ + + + +

Merchant API . accounts . emailpreferences

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ getEmailPreferences(name, x__xgafv=None)

+

Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

+

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

+

Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getEmailPreferences(name, x__xgafv=None) +
Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
+
+Args:
+  name: string, Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
+  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
+  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
+}
+
+ +
+ updateEmailPreferences(name, body=None, updateMask=None, x__xgafv=None) +
Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.
+
+Args:
+  name: string, Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
+  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
+  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
+}
+
+  updateMask: string, Required. List of fields being updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
+  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
+  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html index d0ed0259382..fc15b04da3c 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.homepage.html @@ -80,9 +80,15 @@

Instance Methods

close()

Close httplib2 connections.

+

+ getHomepage(name, x__xgafv=None)

+

Retrieves a store's homepage.

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

Unclaims a store's homepage. Executing this method requires admin access.

+

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

+

Updates a store's homepage. Executing this method requires admin access.

Method Details

claim(name, body=None, x__xgafv=None) @@ -116,6 +122,27 @@

Method Details

Close httplib2 connections.
+
+ getHomepage(name, x__xgafv=None) +
Retrieves a store's homepage.
+
+Args:
+  name: string, Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A store's homepage.
+  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
+  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
+  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
+}
+
+
unclaim(name, body=None, x__xgafv=None)
Unclaims a store's homepage. Executing this method requires admin access.
@@ -143,4 +170,35 @@ 

Method Details

}
+
+ updateHomepage(name, body=None, updateMask=None, x__xgafv=None) +
Updates a store's homepage. Executing this method requires admin access.
+
+Args:
+  name: string, Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A store's homepage.
+  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
+  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
+  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
+}
+
+  updateMask: string, Required. List of fields being updated.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A store's homepage.
+  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
+  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
+  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.html index fc6bd5833a4..5e4448c974a 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.html @@ -79,6 +79,21 @@

Instance Methods

Returns the accounttax Resource.

+

+ businessIdentity() +

+

Returns the businessIdentity Resource.

+ +

+ businessInfo() +

+

Returns the businessInfo Resource.

+ +

+ emailpreferences() +

+

Returns the emailpreferences Resource.

+

homepage()

@@ -131,18 +146,6 @@

Instance Methods

get(name, x__xgafv=None)

Retrieves an account from your Merchant Center account. After inserting, updating, or deleting an account, it may take several minutes before changes take effect.

-

- getBusinessIdentity(name, x__xgafv=None)

-

Retrieves the business identity of an account.

-

- getBusinessInfo(name, x__xgafv=None)

-

Retrieves the business info of an account.

-

- getHomepage(name, x__xgafv=None)

-

Retrieves a store's homepage.

-

- getShippingSettings(name, x__xgafv=None)

-

Retrieve shipping setting information.

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

Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.

@@ -158,15 +161,6 @@

Instance Methods

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

Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.

-

- updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None)

-

Updates the business identity of an account. Executing this method requires admin access.

-

- updateBusinessInfo(name, body=None, updateMask=None, x__xgafv=None)

-

Updates the business info of an account. Executing this method requires admin access.

-

- updateHomepage(name, body=None, updateMask=None, x__xgafv=None)

-

Updates a store's homepage. Executing this method requires admin access.

Method Details

close() @@ -288,442 +282,6 @@

Method Details

}
-
- getBusinessIdentity(name, x__xgafv=None) -
Retrieves the business identity of an account.
-
-Args:
-  name: string, Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
-  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
-  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
-  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-}
-
- -
- getBusinessInfo(name, x__xgafv=None) -
Retrieves the business info of an account.
-
-Args:
-  name: string, Required. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Collection of information related to a business.
-  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
-    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
-      "A String",
-    ],
-    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
-    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
-    "organization": "A String", # Optional. The name of the organization at the address.
-    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
-    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
-      "A String",
-    ],
-    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
-    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
-    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
-  },
-  "customerService": { # Customer service information. # Optional. The customer service of the business.
-    "email": "A String", # Optional. The email address where customer service may be reached.
-    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
-      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-      },
-    },
-    "uri": "A String", # Optional. The URI where customer service may be found.
-  },
-  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
-  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
-    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-    },
-  },
-  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
-}
-
- -
- getHomepage(name, x__xgafv=None) -
Retrieves a store's homepage.
-
-Args:
-  name: string, Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A store's homepage.
-  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
-  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
-  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
-}
-
- -
- getShippingSettings(name, x__xgafv=None) -
Retrieve shipping setting information.
-
-Args:
-  name: string, Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284).
-  "etag": "A String", # Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps: 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.
-  "name": "A String", # Identifier. The resource name of the shipping setting. Format: `accounts/{account}/shippingSetting`
-  "services": [ # Optional. The target account's list of services.
-    { # Shipping service.
-      "active": True or False, # Required. A boolean exposing the active status of the shipping service.
-      "currencyCode": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
-      "deliveryCountries": [ # Required. The CLDR territory code of the countries to which the service applies.
-        "A String",
-      ],
-      "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. # Required. Time spent in various aspects from order to the delivery of the product.
-        "cutoffTime": { # Business days cutoff time definition. # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
-          "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.
-          "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.
-          "timeZone": "A String", # Required. [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example "Europe/Zurich".
-        },
-        "handlingBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
-          "businessDays": [ # Required. Regular business days. May not be empty.
-            "A String",
-          ],
-        },
-        "maxHandlingDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`.
-        "maxTransitDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `min_transit_days`.
-        "minHandlingDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
-        "minTransitDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `min_transit_days`, `max_transit_days` or `transit_time_table` must be set, but not both.
-        "transitBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
-          "businessDays": [ # Required. Regular business days. May not be empty.
-            "A String",
-          ],
-        },
-        "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both. # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both.
-          "postalCodeGroupNames": [ # Required. A list of region names Region.name . The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
-            "A String",
-          ],
-          "rows": [ # Required. If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
-            { # If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
-              "values": [ # Required. Transit time range (min-max) in business days.
-                { # Transit time range (min-max) in business days.
-                  "maxTransitDays": 42, # Must be greater than or equal to `min_transit_days`.
-                  "minTransitDays": 42, # Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery.
-                },
-              ],
-            },
-          ],
-          "transitTimeLabels": [ # Required. A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
-            "A String",
-          ],
-        },
-        "warehouseBasedDeliveryTimes": [ # Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery time should be set.
-          { # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in `delivery_time` should be set.
-            "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`.
-            "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The name of the service must be in the eddSupportedServices list.
-            "warehouse": "A String", # Required. Warehouse name. This should match warehouse
-          },
-        ],
-      },
-      "loyaltyPrograms": [ # Optional. Loyalty programs that this shipping service is limited to.
-        { # [Loyalty program](https://support.google.com/merchants/answer/12922446) provided by a merchant.
-          "loyaltyProgramTiers": [ # Optional. Loyalty program tier of this shipping service.
-            { # Subset of a merchants loyalty program.
-              "tierLabel": "A String", # The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier.
-            },
-          ],
-          "programLabel": "A String", # This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers.
-        },
-      ],
-      "minimumOrderValue": { # The price represented as a number and currency. # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
-        "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-        "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-      },
-      "minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
-        "storeCodeSetWithMovs": [ # Required. A list of store code sets sharing the same minimum order value (MOV). At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
-          { # A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
-            "storeCodes": [ # Optional. A list of unique store codes or empty for the catch all.
-              "A String",
-            ],
-            "value": { # The price represented as a number and currency. # The minimum order value for the given stores.
-              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-            },
-          },
-        ],
-      },
-      "rateGroups": [ # Optional. Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
-        { # Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
-          "applicableShippingLabels": [ # Required. A list of [shipping labels](https://support.google.com/merchants/answer/6324504) defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service.
-            "A String",
-          ],
-          "carrierRates": [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
-            { # A list of carrier rates that can be referred to by `main_table` or `single_value`.
-              "carrier": "A String", # Required. Carrier service, such as `"UPS"` or `"Fedex"`.
-              "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`.
-              "flatAdjustment": { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ "amount_micros": 1, "currency_code" : "USD" }` adds $1 to the rate, `{ "amount_micros": -3, "currency_code" : "USD" }` removes $3 from the rate.
-                "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-              },
-              "name": "A String", # Required. Name of the carrier rate. Must be unique per rate group.
-              "originPostalCode": "A String", # Required. Shipping origin for this carrier rate.
-              "percentageAdjustment": "A String", # Optional. Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%.
-            },
-          ],
-          "mainTable": { # A table defining the rate group, when `single_value` is not expressive enough. # A table defining the rate group, when `single_value` is not expressive enough. Can only be set if `single_value` is not set.
-            "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
-              "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                  "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
-                    "A String",
-                  ],
-                },
-              ],
-              "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
-                "A String",
-              ],
-              "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
-                "A String",
-              ],
-              "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                { # The price represented as a number and currency.
-                  "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                  "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                },
-              ],
-              "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                { # The weight represented as the value in string and the unit.
-                  "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
-                  "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
-                },
-              ],
-            },
-            "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
-            "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
-              "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                  "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
-                    "A String",
-                  ],
-                },
-              ],
-              "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
-                "A String",
-              ],
-              "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
-                "A String",
-              ],
-              "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                { # The price represented as a number and currency.
-                  "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                  "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                },
-              ],
-              "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                { # The weight represented as the value in string and the unit.
-                  "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
-                  "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
-                },
-              ],
-            },
-            "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
-              { # Include a list of cells.
-                "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables.
-                  { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
-                    "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
-                    "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
-                      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                    },
-                    "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
-                    "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
-                    "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
-                  },
-                ],
-              },
-            ],
-          },
-          "name": "A String", # Optional. Name of the rate group. If set has to be unique within shipping service.
-          "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. # The value of the rate group (For example flat rate $10). Can only be set if `main_table` and `subtables` are not set.
-            "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
-            "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
-              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-            },
-            "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
-            "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
-            "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
-          },
-          "subtables": [ # Optional. A list of subtables referred to by `main_table`. Can only be set if `main_table` is set.
-            { # A table defining the rate group, when `single_value` is not expressive enough.
-              "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
-                "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                  { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                    "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
-                      "A String",
-                    ],
-                  },
-                ],
-                "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
-                  "A String",
-                ],
-                "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
-                  "A String",
-                ],
-                "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                  { # The price represented as a number and currency.
-                    "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                    "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                  },
-                ],
-                "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                  { # The weight represented as the value in string and the unit.
-                    "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
-                    "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
-                  },
-                ],
-              },
-              "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
-              "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
-                "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                  { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
-                    "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
-                      "A String",
-                    ],
-                  },
-                ],
-                "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
-                  "A String",
-                ],
-                "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
-                  "A String",
-                ],
-                "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                  { # The price represented as a number and currency.
-                    "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                    "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                  },
-                ],
-                "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
-                  { # The weight represented as the value in string and the unit.
-                    "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
-                    "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
-                  },
-                ],
-              },
-              "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
-                { # Include a list of cells.
-                  "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables.
-                    { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
-                      "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
-                      "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
-                        "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
-                        "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
-                      },
-                      "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
-                      "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
-                      "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
-                    },
-                  ],
-                },
-              ],
-            },
-          ],
-        },
-      ],
-      "serviceName": "A String", # Required. Free-form name of the service. Must be unique within target account.
-      "shipmentType": "A String", # Type of locations this service ships orders to.
-      "storeConfig": { # A list of stores your products are delivered from. This is only valid for the local delivery shipment type. # A list of stores your products are delivered from. This is only valid for the local delivery shipment type.
-        "cutoffConfig": { # Configs related to local delivery ends for the day. # Configs related to local delivery ends for the day.
-          "localCutoffTime": { # Time that local delivery ends for the day. # Time that local delivery ends for the day.
-            "hour": "A String", # Hour local delivery orders must be placed by to process the same day.
-            "minute": "A String", # Minute local delivery orders must be placed by to process the same day.
-          },
-          "noDeliveryPostCutoff": True or False, # Merchants can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery.
-          "storeCloseOffsetHours": "A String", # Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with `local_cutoff_time`.
-        },
-        "serviceRadius": { # Maximum delivery radius. This is only required for the local delivery shipment type. # Maximum delivery radius. This is only required for the local delivery shipment type.
-          "unit": "A String", # Unit can differ based on country, it is parameterized to include miles and kilometers.
-          "value": "A String", # Integer value of distance.
-        },
-        "storeCodes": [ # Optional. A list of store codes that provide local delivery. If empty, then `all_stores` must be true.
-          "A String",
-        ],
-        "storeServiceType": "A String", # Indicates whether all stores, or selected stores, listed by this merchant provide local delivery.
-      },
-    },
-  ],
-  "warehouses": [ # Optional. A list of warehouses which can be referred to in `services`.
-    { # A fulfillment warehouse, which stores and handles inventory. Next tag: 7
-      "businessDayConfig": { # Business days of the warehouse. # Business days of the warehouse. If not set, will be Monday to Friday by default.
-        "businessDays": [ # Required. Regular business days. May not be empty.
-          "A String",
-        ],
-      },
-      "cutoffTime": { # The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.
-        "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse.
-        "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse.
-      },
-      "handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item.
-      "name": "A String", # Required. The name of the warehouse. Must be unique within account.
-      "shippingAddress": { # Shipping address of the warehouse. # Required. Shipping address of the warehouse.
-        "administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
-        "city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).
-        "postalCode": "A String", # Required. Postal code or ZIP (For example "94043").
-        "regionCode": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (For example "US").
-        "streetAddress": "A String", # Street-level part of the address. For example: `111w 31st Street`.
-      },
-    },
-  ],
-}
-
-
list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.
@@ -867,197 +425,4 @@ 

Method Details

}
-
- updateBusinessIdentity(name, body=None, updateMask=None, x__xgafv=None) -
Updates the business identity of an account. Executing this method requires admin access.
-
-Args:
-  name: string, Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
-  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
-  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
-  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-}
-
-  updateMask: string, Required. List of fields being updated.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Collection of information related to the [identity of a business](https://support.google.com/merchants/answer/12564247).
-  "blackOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being black-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "latinoOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being latino-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "name": "A String", # Identifier. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`
-  "promotionsConsent": "A String", # Optional. Whether the identity attributes may be used for promotions.
-  "smallBusiness": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as a small business. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "veteranOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being veteran-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-  "womenOwned": { # All information related to an identity attribute. # Optional. Specifies whether the business identifies itself as being women-owned. This optional field will only be available for merchants with a business country set to `US`. It is also not applicable for marketplaces or marketplace sellers.
-    "identityDeclaration": "A String", # Required. The declaration of identity for this attribute.
-  },
-}
-
- -
- updateBusinessInfo(name, body=None, updateMask=None, x__xgafv=None) -
Updates the business info of an account. Executing this method requires admin access.
-
-Args:
-  name: string, Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Collection of information related to a business.
-  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
-    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
-      "A String",
-    ],
-    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
-    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
-    "organization": "A String", # Optional. The name of the organization at the address.
-    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
-    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
-      "A String",
-    ],
-    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
-    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
-    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
-  },
-  "customerService": { # Customer service information. # Optional. The customer service of the business.
-    "email": "A String", # Optional. The email address where customer service may be reached.
-    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
-      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-      },
-    },
-    "uri": "A String", # Optional. The URI where customer service may be found.
-  },
-  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
-  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
-    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-    },
-  },
-  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
-}
-
-  updateMask: string, Required. List of fields being updated.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Collection of information related to a business.
-  "address": { # Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains). In typical usage an address would be created via user input or from importing existing data, depending on the type of process. Advice on address input / editing: - Use an internationalization-ready address widget such as https://github.com/google/libaddressinput) - Users should not be presented with UI elements for input or editing of fields outside countries where that field is used. For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478 # Optional. The address of the business.
-    "addressLines": [ # Unstructured address lines describing the lower levels of an address. Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. "Austin, TX"), it is important that the line order is clear. The order of address lines should be "envelope order" for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. "ja" for large-to-small ordering and "ja-Latn" or "en" for small-to-large). This way, the most specific line of an address can be selected based on the language. The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved. Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).
-      "A String",
-    ],
-    "administrativeArea": "A String", # Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. "Barcelona" and not "Catalonia"). Many countries don't use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.
-    "languageCode": "A String", # Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address' country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations. If this value is not known, it should be omitted (rather than specifying a possibly incorrect default). Examples: "zh-Hant", "ja", "ja-Latn", "en".
-    "locality": "A String", # Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.
-    "organization": "A String", # Optional. The name of the organization at the address.
-    "postalCode": "A String", # Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).
-    "recipients": [ # Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain "care of" information.
-      "A String",
-    ],
-    "regionCode": "A String", # Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See https://cldr.unicode.org/ and https://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: "CH" for Switzerland.
-    "revision": 42, # The schema revision of the `PostalAddress`. This must be set to 0, which is the latest revision. All new revisions **must** be backward compatible with old revisions.
-    "sortingCode": "A String", # Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like "CEDEX", optionally followed by a number (e.g. "CEDEX 7"), or just a number alone, representing the "sector code" (Jamaica), "delivery area indicator" (Malawi) or "post office indicator" (e.g. Côte d'Ivoire).
-    "sublocality": "A String", # Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.
-  },
-  "customerService": { # Customer service information. # Optional. The customer service of the business.
-    "email": "A String", # Optional. The email address where customer service may be reached.
-    "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Optional. The phone number where customer service may be called.
-      "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-      "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-      "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-        "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-        "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-      },
-    },
-    "uri": "A String", # Optional. The URI where customer service may be found.
-  },
-  "name": "A String", # Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`
-  "phone": { # An object representing a phone number, suitable as an API wire format. This representation: - should not be used for locale-specific formatting of a phone number, such as "+1 (650) 253-0000 ext. 123" - is not designed for efficient storage - may not be suitable for dialing - specialized libraries (see references) should be used to parse the number for that purpose To do something meaningful with this number, such as format it for various use-cases, convert it to an `i18n.phonenumbers.PhoneNumber` object first. For instance, in Java this would be: com.google.type.PhoneNumber wireProto = com.google.type.PhoneNumber.newBuilder().build(); com.google.i18n.phonenumbers.Phonenumber.PhoneNumber phoneNumber = PhoneNumberUtil.getInstance().parse(wireProto.getE164Number(), "ZZ"); if (!wireProto.getExtension().isEmpty()) { phoneNumber.setExtension(wireProto.getExtension()); } Reference(s): - https://github.com/google/libphonenumber # Output only. The phone number of the business.
-    "e164Number": "A String", # The phone number, represented as a leading plus sign ('+'), followed by a phone number that uses a relaxed ITU E.164 format consisting of the country calling code (1 to 3 digits) and the subscriber number, with no additional spaces or formatting, e.g.: - correct: "+15552220123" - incorrect: "+1 (555) 222-01234 x123". The ITU E.164 format limits the latter to 12 digits, but in practice not all countries respect that, so we relax that restriction here. National-only numbers are not allowed. References: - https://www.itu.int/rec/T-REC-E.164-201011-I - https://en.wikipedia.org/wiki/E.164. - https://en.wikipedia.org/wiki/List_of_country_calling_codes
-    "extension": "A String", # The phone number's extension. The extension is not standardized in ITU recommendations, except for being defined as a series of numbers with a maximum length of 40 digits. Other than digits, some other dialing characters such as ',' (indicating a wait) or '#' may be stored here. Note that no regions currently use extensions with short codes, so this field is normally only set in conjunction with an E.164 number. It is held separately from the E.164 number to allow for short code extensions in the future.
-    "shortCode": { # An object representing a short code, which is a phone number that is typically much shorter than regular phone numbers and can be used to address messages in MMS and SMS systems, as well as for abbreviated dialing (e.g. "Text 611 to see how many minutes you have remaining on your plan."). Short codes are restricted to a region and are not internationally dialable, which means the same short code can exist in different regions, with different usage and pricing, even if those regions share the same country calling code (e.g. US and CA). # A short code. Reference(s): - https://en.wikipedia.org/wiki/Short_code
-      "number": "A String", # Required. The short code digits, without a leading plus ('+') or country calling code, e.g. "611".
-      "regionCode": "A String", # Required. The BCP-47 region code of the location where calls to this short code can be made, such as "US" and "BB". Reference(s): - http://www.unicode.org/reports/tr35/#unicode_region_subtag
-    },
-  },
-  "phoneVerificationState": "A String", # Output only. The phone verification state of the business.
-}
-
- -
- updateHomepage(name, body=None, updateMask=None, x__xgafv=None) -
Updates a store's homepage. Executing this method requires admin access.
-
-Args:
-  name: string, Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage` (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # A store's homepage.
-  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
-  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
-  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
-}
-
-  updateMask: string, Required. List of fields being updated.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A store's homepage.
-  "claimed": True or False, # Output only. Whether the homepage is claimed. See https://support.google.com/merchants/answer/176793.
-  "name": "A String", # Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`
-  "uri": "A String", # Required. The URI (typically a URL) of the store's homepage.
-}
-
- \ No newline at end of file diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html index 7409eb3ccd2..0b50e7dc2ee 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.shippingSettings.html @@ -77,6 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ getShippingSettings(name, x__xgafv=None)

+

Retrieve shipping setting information.

insert(parent, body=None, x__xgafv=None)

Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.

@@ -86,6 +89,329 @@

Method Details

Close httplib2 connections.
+
+ getShippingSettings(name, x__xgafv=None) +
Retrieve shipping setting information.
+
+Args:
+  name: string, Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The merchant account's [shipping setting]((https://support.google.com/merchants/answer/6069284).
+  "etag": "A String", # Required. This field is used for avoid async issue. Make sure shipping setting data didn't change between get call and insert call. The user should do following steps: 1. Set etag field as empty string for initial shipping setting creation. 2. After initial creation, call get method to obtain an etag and current shipping setting data before call insert. 3. Modify to wanted shipping setting information. 4. Call insert method with the wanted shipping setting information with the etag obtained from step 2. 5. If shipping setting data changed between step 2 and step 4. Insert request will fail because the etag changes every time the shipping setting data changes. User should repeate step 2-4 with the new etag.
+  "name": "A String", # Identifier. The resource name of the shipping setting. Format: `accounts/{account}/shippingSetting`
+  "services": [ # Optional. The target account's list of services.
+    { # Shipping service.
+      "active": True or False, # Required. A boolean exposing the active status of the shipping service.
+      "currencyCode": "A String", # The CLDR code of the currency to which this service applies. Must match that of the prices in rate groups.
+      "deliveryCountries": [ # Required. The CLDR territory code of the countries to which the service applies.
+        "A String",
+      ],
+      "deliveryTime": { # Time spent in various aspects from order to the delivery of the product. # Required. Time spent in various aspects from order to the delivery of the product.
+        "cutoffTime": { # Business days cutoff time definition. # Business days cutoff time definition. If not configured the cutoff time will be defaulted to 8AM PST.
+          "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day.
+          "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day.
+          "timeZone": "A String", # Required. [Timezone identifier](https://developers.google.com/adwords/api/docs/appendix/codes-formats#timezone-ids) For example "Europe/Zurich".
+        },
+        "handlingBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
+          "businessDays": [ # Required. Regular business days. May not be empty.
+            "A String",
+          ],
+        },
+        "maxHandlingDays": 42, # Maximum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped. Must be greater than or equal to `min_handling_days`.
+        "maxTransitDays": 42, # Maximum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Must be greater than or equal to `min_transit_days`.
+        "minHandlingDays": 42, # Minimum number of business days spent before an order is shipped. 0 means same day shipped, 1 means next day shipped.
+        "minTransitDays": 42, # Minimum number of business days that is spent in transit. 0 means same day delivery, 1 means next day delivery. Either `min_transit_days`, `max_transit_days` or `transit_time_table` must be set, but not both.
+        "transitBusinessDayConfig": { # Business days of the warehouse. # The business days during which orders can be in-transit. If not provided, Monday to Friday business days will be assumed.
+          "businessDays": [ # Required. Regular business days. May not be empty.
+            "A String",
+          ],
+        },
+        "transitTimeTable": { # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both. # Transit time table, number of business days spent in transit based on row and column dimensions. Either `min_transit_days`, `max_transit_days` or `transit_time_table` can be set, but not both.
+          "postalCodeGroupNames": [ # Required. A list of region names Region.name . The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service.
+            "A String",
+          ],
+          "rows": [ # Required. If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
+            { # If there's only one dimension set of `postal_code_group_names` or `transit_time_labels`, there are multiple rows each with one value for that dimension. If there are two dimensions, each row corresponds to a `postal_code_group_names`, and columns (values) to a `transit_time_labels`.
+              "values": [ # Required. Transit time range (min-max) in business days.
+                { # Transit time range (min-max) in business days.
+                  "maxTransitDays": 42, # Must be greater than or equal to `min_transit_days`.
+                  "minTransitDays": 42, # Minimum transit time range in business days. 0 means same day delivery, 1 means next day delivery.
+                },
+              ],
+            },
+          ],
+          "transitTimeLabels": [ # Required. A list of transit time labels. The last value can be `"all other labels"`. Example: `["food", "electronics", "all other labels"]`.
+            "A String",
+          ],
+        },
+        "warehouseBasedDeliveryTimes": [ # Optional. Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in delivery time should be set.
+          { # Indicates that the delivery time should be calculated per warehouse (shipping origin location) based on the settings of the selected carrier. When set, no other transit time related field in `delivery_time` should be set.
+            "carrier": "A String", # Required. Carrier, such as `"UPS"` or `"Fedex"`.
+            "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`. The name of the service must be in the eddSupportedServices list.
+            "warehouse": "A String", # Required. Warehouse name. This should match warehouse
+          },
+        ],
+      },
+      "loyaltyPrograms": [ # Optional. Loyalty programs that this shipping service is limited to.
+        { # [Loyalty program](https://support.google.com/merchants/answer/12922446) provided by a merchant.
+          "loyaltyProgramTiers": [ # Optional. Loyalty program tier of this shipping service.
+            { # Subset of a merchants loyalty program.
+              "tierLabel": "A String", # The tier label [tier_label] sub-attribute differentiates offer level benefits between each tier. This value is also set in your program settings in Merchant Center, and is required for data source changes even if your loyalty program only has 1 tier.
+            },
+          ],
+          "programLabel": "A String", # This is the loyalty program label set in your loyalty program settings in Merchant Center. This sub-attribute allows Google to map your loyalty program to eligible offers.
+        },
+      ],
+      "minimumOrderValue": { # The price represented as a number and currency. # Minimum order value for this service. If set, indicates that customers will have to spend at least this amount. All prices within a service must have the same currency. Cannot be set together with minimum_order_value_table.
+        "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+        "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+      },
+      "minimumOrderValueTable": { # Table of per store minimum order values for the pickup fulfillment type. # Table of per store minimum order values for the pickup fulfillment type. Cannot be set together with minimum_order_value.
+        "storeCodeSetWithMovs": [ # Required. A list of store code sets sharing the same minimum order value (MOV). At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
+          { # A list of store code sets sharing the same minimum order value. At least two sets are required and the last one must be empty, which signifies 'MOV for all other stores'. Each store code can only appear once across all the sets. All prices within a service must have the same currency.
+            "storeCodes": [ # Optional. A list of unique store codes or empty for the catch all.
+              "A String",
+            ],
+            "value": { # The price represented as a number and currency. # The minimum order value for the given stores.
+              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+            },
+          },
+        ],
+      },
+      "rateGroups": [ # Optional. Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
+        { # Shipping rate group definitions. Only the last one is allowed to have an empty `applicable_shipping_labels`, which means "everything else". The other `applicable_shipping_labels` must not overlap.
+          "applicableShippingLabels": [ # Required. A list of [shipping labels](https://support.google.com/merchants/answer/6324504) defining the products to which this rate group applies to. This is a disjunction: only one of the labels has to match for the rate group to apply. May only be empty for the last rate group of a service.
+            "A String",
+          ],
+          "carrierRates": [ # Optional. A list of carrier rates that can be referred to by `main_table` or `single_value`.
+            { # A list of carrier rates that can be referred to by `main_table` or `single_value`.
+              "carrier": "A String", # Required. Carrier service, such as `"UPS"` or `"Fedex"`.
+              "carrierService": "A String", # Required. Carrier service, such as `"ground"` or `"2 days"`.
+              "flatAdjustment": { # The price represented as a number and currency. # Optional. Additive shipping rate modifier. Can be negative. For example `{ "amount_micros": 1, "currency_code" : "USD" }` adds $1 to the rate, `{ "amount_micros": -3, "currency_code" : "USD" }` removes $3 from the rate.
+                "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+              },
+              "name": "A String", # Required. Name of the carrier rate. Must be unique per rate group.
+              "originPostalCode": "A String", # Required. Shipping origin for this carrier rate.
+              "percentageAdjustment": "A String", # Optional. Multiplicative shipping rate modifier as a number in decimal notation. Can be negative. For example `"5.4"` increases the rate by 5.4%, `"-3"` decreases the rate by 3%.
+            },
+          ],
+          "mainTable": { # A table defining the rate group, when `single_value` is not expressive enough. # A table defining the rate group, when `single_value` is not expressive enough. Can only be set if `single_value` is not set.
+            "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
+              "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                  "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
+                    "A String",
+                  ],
+                },
+              ],
+              "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
+                "A String",
+              ],
+              "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
+                "A String",
+              ],
+              "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                { # The price represented as a number and currency.
+                  "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                  "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                },
+              ],
+              "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                { # The weight represented as the value in string and the unit.
+                  "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
+                  "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
+                },
+              ],
+            },
+            "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
+            "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
+              "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                  "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
+                    "A String",
+                  ],
+                },
+              ],
+              "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
+                "A String",
+              ],
+              "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
+                "A String",
+              ],
+              "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                { # The price represented as a number and currency.
+                  "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                  "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                },
+              ],
+              "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                { # The weight represented as the value in string and the unit.
+                  "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
+                  "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
+                },
+              ],
+            },
+            "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
+              { # Include a list of cells.
+                "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables.
+                  { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
+                    "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
+                    "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
+                      "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                      "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                    },
+                    "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
+                    "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
+                    "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
+                  },
+                ],
+              },
+            ],
+          },
+          "name": "A String", # Optional. Name of the rate group. If set has to be unique within shipping service.
+          "singleValue": { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set. # The value of the rate group (For example flat rate $10). Can only be set if `main_table` and `subtables` are not set.
+            "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
+            "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
+              "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+              "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+            },
+            "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
+            "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
+            "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
+          },
+          "subtables": [ # Optional. A list of subtables referred to by `main_table`. Can only be set if `main_table` is set.
+            { # A table defining the rate group, when `single_value` is not expressive enough.
+              "columnHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Headers of the table's columns. Optional: if not set then the table has only one dimension.
+                "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                  { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                    "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
+                      "A String",
+                    ],
+                  },
+                ],
+                "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
+                  "A String",
+                ],
+                "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
+                  "A String",
+                ],
+                "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                  { # The price represented as a number and currency.
+                    "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                    "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                  },
+                ],
+                "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                  { # The weight represented as the value in string and the unit.
+                    "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
+                    "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
+                  },
+                ],
+              },
+              "name": "A String", # Name of the table. Required for subtables, ignored for the main table.
+              "rowHeaders": { # A non-empty list of row or column headers for a table. Exactly one of `prices`, `weights`, `num_items`, `postal_code_group_names`, or `location` must be set. # Required. Headers of the table's rows.
+                "locations": [ # Required. A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                  { # A list of location ID sets. Must be non-empty. Can only be set if all other fields are not set.
+                    "locationIds": [ # Required. A non-empty list of [location IDs](https://developers.google.com/adwords/api/docs/appendix/geotargeting). They must all be of the same location type (For example, state).
+                      "A String",
+                    ],
+                  },
+                ],
+                "numberOfItems": [ # Required. A list of inclusive number of items upper bounds. The last value can be `"infinity"`. For example `["10", "50", "infinity"]` represents the headers "<= 10 items", "<= 50 items", and "> 50 items". Must be non-empty. Can only be set if all other fields are not set.
+                  "A String",
+                ],
+                "postalCodeGroupNames": [ # Required. A list of postal group names. The last value can be `"all other locations"`. Example: `["zone 1", "zone 2", "all other locations"]`. The referred postal code groups must match the delivery country of the service. Must be non-empty. Can only be set if all other fields are not set.
+                  "A String",
+                ],
+                "prices": [ # Required. A list of inclusive order price upper bounds. The last price's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "currency_code": "USD"}, {"amount_micros": 500000000, "currency_code": "USD"}, {"amount_micros": -1, "currency_code": "USD"}]` represents the headers "<= $10", "<= $500", and "> $500". All prices within a service must have the same currency. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                  { # The price represented as a number and currency.
+                    "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                    "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                  },
+                ],
+                "weights": [ # Required. A list of inclusive order weight upper bounds. The last weight's value can be infinity by setting price amount_micros = -1. For example `[{"amount_micros": 10000000, "unit": "kg"}, {"amount_micros": 50000000, "unit": "kg"}, {"amount_micros": -1, "unit": "kg"}]` represents the headers "<= 10kg", "<= 50kg", and "> 50kg". All weights within a service must have the same unit. Must be non-empty. Must be positive except -1. Can only be set if all other fields are not set.
+                  { # The weight represented as the value in string and the unit.
+                    "amountMicros": "A String", # Required. The weight represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 kg = 1000000 micros). This field can also be set as infinity by setting to -1. This field only support -1 and positive value.
+                    "unit": "A String", # Required. The weight unit. Acceptable values are: kg and lb
+                  },
+                ],
+              },
+              "rows": [ # Required. The list of rows that constitute the table. Must have the same length as `row_headers`.
+                { # Include a list of cells.
+                  "cells": [ # Required. The list of cells that constitute the row. Must have the same length as `columnHeaders` for two-dimensional tables, a length of 1 for one-dimensional tables.
+                    { # The single value of a rate group or the value of a rate group table's cell. Exactly one of `no_shipping`, `flat_rate`, `price_percentage`, `carrier_rateName`, `subtable_name` must be set.
+                      "carrierRate": "A String", # The name of a carrier rate referring to a carrier rate defined in the same rate group. Can only be set if all other fields are not set.
+                      "flatRate": { # The price represented as a number and currency. # A flat rate. Can only be set if all other fields are not set.
+                        "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+                        "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+                      },
+                      "noShipping": True or False, # If true, then the product can't be shipped. Must be true when set, can only be set if all other fields are not set.
+                      "pricePercentage": "A String", # A percentage of the price represented as a number in decimal notation (For example, `"5.4"`). Can only be set if all other fields are not set.
+                      "subtable": "A String", # The name of a subtable. Can only be set in table cells (For example, not for single values), and only if all other fields are not set.
+                    },
+                  ],
+                },
+              ],
+            },
+          ],
+        },
+      ],
+      "serviceName": "A String", # Required. Free-form name of the service. Must be unique within target account.
+      "shipmentType": "A String", # Type of locations this service ships orders to.
+      "storeConfig": { # A list of stores your products are delivered from. This is only valid for the local delivery shipment type. # A list of stores your products are delivered from. This is only valid for the local delivery shipment type.
+        "cutoffConfig": { # Configs related to local delivery ends for the day. # Configs related to local delivery ends for the day.
+          "localCutoffTime": { # Time that local delivery ends for the day. # Time that local delivery ends for the day.
+            "hour": "A String", # Hour local delivery orders must be placed by to process the same day.
+            "minute": "A String", # Minute local delivery orders must be placed by to process the same day.
+          },
+          "noDeliveryPostCutoff": True or False, # Merchants can opt-out of showing n+1 day local delivery when they have a shipping service configured to n day local delivery. For example, if the shipping service defines same-day delivery, and it's past the cut-off, setting this field to `true` results in the calculated shipping service rate returning `NO_DELIVERY_POST_CUTOFF`. In the same example, setting this field to `false` results in the calculated shipping time being one day. This is only for local delivery.
+          "storeCloseOffsetHours": "A String", # Only valid with local delivery fulfillment. Represents cutoff time as the number of hours before store closing. Mutually exclusive with `local_cutoff_time`.
+        },
+        "serviceRadius": { # Maximum delivery radius. This is only required for the local delivery shipment type. # Maximum delivery radius. This is only required for the local delivery shipment type.
+          "unit": "A String", # Unit can differ based on country, it is parameterized to include miles and kilometers.
+          "value": "A String", # Integer value of distance.
+        },
+        "storeCodes": [ # Optional. A list of store codes that provide local delivery. If empty, then `all_stores` must be true.
+          "A String",
+        ],
+        "storeServiceType": "A String", # Indicates whether all stores, or selected stores, listed by this merchant provide local delivery.
+      },
+    },
+  ],
+  "warehouses": [ # Optional. A list of warehouses which can be referred to in `services`.
+    { # A fulfillment warehouse, which stores and handles inventory. Next tag: 7
+      "businessDayConfig": { # Business days of the warehouse. # Business days of the warehouse. If not set, will be Monday to Friday by default.
+        "businessDays": [ # Required. Regular business days. May not be empty.
+          "A String",
+        ],
+      },
+      "cutoffTime": { # The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code. # Required. The latest time of day that an order can be accepted and begin processing. Later orders will be processed in the next day. The time is based on the warehouse postal code.
+        "hour": 42, # Required. Hour of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Hour is based on the timezone of warehouse.
+        "minute": 42, # Required. Minute of the cutoff time until which an order has to be placed to be processed in the same day by the warehouse. Minute is based on the timezone of warehouse.
+      },
+      "handlingDays": "A String", # Required. The number of days it takes for this warehouse to pack up and ship an item. This is on the warehouse level, but can be overridden on the offer level based on the attributes of an item.
+      "name": "A String", # Required. The name of the warehouse. Must be unique within account.
+      "shippingAddress": { # Shipping address of the warehouse. # Required. Shipping address of the warehouse.
+        "administrativeArea": "A String", # Required. Top-level administrative subdivision of the country. For example, a state like California ("CA") or a province like Quebec ("QC").
+        "city": "A String", # Required. City, town or commune. May also include dependent localities or sublocalities (For example neighborhoods or suburbs).
+        "postalCode": "A String", # Required. Postal code or ZIP (For example "94043").
+        "regionCode": "A String", # Required. [CLDR country code](http://www.unicode.org/repos/cldr/tags/latest/common/main/en.xml) (For example "US").
+        "streetAddress": "A String", # Street-level part of the address. For example: `111w 31st Street`.
+      },
+    },
+  ],
+}
+
+
insert(parent, body=None, x__xgafv=None)
Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html
index 90d23dfe607..004831fec66 100644
--- a/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html
+++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.users.html
@@ -86,9 +86,6 @@ 

Instance Methods

get(name, x__xgafv=None)

Retrieves a Merchant Center account user.

-

- getEmailPreferences(name, x__xgafv=None)

-

Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.

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

Lists all users of a Merchant Center account.

@@ -98,9 +95,6 @@

Instance Methods

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

Updates a Merchant Center account user. Executing this method requires admin access.

-

- updateEmailPreferences(name, body=None, updateMask=None, x__xgafv=None)

-

Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.

Method Details

close() @@ -183,26 +177,6 @@

Method Details

}
-
- getEmailPreferences(name, x__xgafv=None) -
Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.
-
-Args:
-  name: string, Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences` (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
-  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
-  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists all users of a Merchant Center account.
@@ -282,33 +256,4 @@ 

Method Details

}
-
- updateEmailPreferences(name, body=None, updateMask=None, x__xgafv=None) -
Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.
-
-Args:
-  name: string, Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
-  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
-  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
-}
-
-  updateMask: string, Required. List of fields being updated.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # The categories of notifications the user opted into / opted out of. The email preferences do not include mandatory announcements as users can't opt out of them.
-  "name": "A String", # Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.
-  "newsAndTips": "A String", # Optional. Updates on new features, tips and best practices.
-}
-
- \ No newline at end of file diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html index ef9db821e35..f8f1d6769c9 100644 --- a/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html +++ b/docs/dyn/metastore_v1alpha.projects.locations.services.backups.html @@ -206,6 +206,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -428,6 +444,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -638,6 +670,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. diff --git a/docs/dyn/metastore_v1alpha.projects.locations.services.html b/docs/dyn/metastore_v1alpha.projects.locations.services.html index 512cb874a8a..39d831814c6 100644 --- a/docs/dyn/metastore_v1alpha.projects.locations.services.html +++ b/docs/dyn/metastore_v1alpha.projects.locations.services.html @@ -422,6 +422,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -678,6 +694,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -879,6 +911,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -1083,6 +1131,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.backups.html b/docs/dyn/metastore_v1beta.projects.locations.services.backups.html index 4777840b24a..e08c36112c7 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.services.backups.html +++ b/docs/dyn/metastore_v1beta.projects.locations.services.backups.html @@ -206,6 +206,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -428,6 +444,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -638,6 +670,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. diff --git a/docs/dyn/metastore_v1beta.projects.locations.services.html b/docs/dyn/metastore_v1beta.projects.locations.services.html index 7f46f24a75e..b5b648630d6 100644 --- a/docs/dyn/metastore_v1beta.projects.locations.services.html +++ b/docs/dyn/metastore_v1beta.projects.locations.services.html @@ -422,6 +422,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -678,6 +694,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -879,6 +911,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. @@ -1083,6 +1131,22 @@

Method Details

}, ], }, + "multiRegionConfig": { # The multi-region config for the Dataproc Metastore service. # Optional. Specifies the multi-region configuration information for the Hive metastore service. + "certificates": [ # Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service. + { # A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover. + "certificate": "A String", # The root CA certificate in PEM format. The maximum length is 65536 bytes. + "expirationTime": "A String", # The certificate expiration time in timestamp format. + }, + ], + "customRegionConfig": { # Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region. + "readOnlyRegions": [ # Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + "readWriteRegions": [ # Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region. + "A String", + ], + }, + }, "name": "A String", # Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}. "network": "A String", # Immutable. The relative resource name of the VPC network on which the instance can be accessed. It is specified in the following form:projects/{project_number}/global/networks/{network_id}. "networkConfig": { # Network configuration for the Dataproc Metastore service. # The configuration specifying the network settings for the Dataproc Metastore service. diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html index 608e6c4f7ba..4487d8d0463 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html @@ -176,19 +176,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -220,19 +220,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, @@ -393,19 +393,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -437,19 +437,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, @@ -550,19 +550,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -594,19 +594,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, @@ -715,19 +715,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -759,19 +759,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html index e65c71379de..c8f77e4d0a8 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html @@ -405,19 +405,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -449,19 +449,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, @@ -579,19 +579,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -623,19 +623,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, @@ -1156,19 +1156,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -1200,19 +1200,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, @@ -1330,19 +1330,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -1374,19 +1374,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, @@ -1848,19 +1848,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -1892,19 +1892,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, @@ -2022,19 +2022,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, "persistentDiskType": "A String", # Persistent disk type to use. If unspecified (default), all types are considered, based on available usage data. @@ -2066,19 +2066,19 @@

Method Details

"osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "sles": { # Pricing options of an OS image. # Optional. Pricing options for SLES images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "slesForSap": { # Pricing options of an OS image. # Optional. Pricing options for SLES for SAP images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, "windows": { # Pricing options of an OS image. # Optional. Pricing options for Windows images. No commitment plans are available, set it to unspecified. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). - "licenseType": "A String", # Optional. License type of the OS image. + "licenseType": "A String", # Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server). }, }, }, diff --git a/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html b/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html index cea5dc763c5..ff98d807eb8 100644 --- a/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html +++ b/docs/dyn/networkservices_v1.projects.locations.endpointPolicies.html @@ -86,9 +86,6 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single EndpointPolicy.

-

- 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.

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

Lists EndpointPolicies in a given project and location.

@@ -98,12 +95,6 @@

Instance Methods

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

Updates the parameters of a single EndpointPolicy.

-

- 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() @@ -259,54 +250,6 @@

Method Details

}
-
- 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).
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists EndpointPolicies in a given project and location.
@@ -442,119 +385,4 @@ 

Method Details

}
-
- 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/networkservices_v1.projects.locations.gateways.html b/docs/dyn/networkservices_v1.projects.locations.gateways.html index f0d653098d9..3c81899ebe9 100644 --- a/docs/dyn/networkservices_v1.projects.locations.gateways.html +++ b/docs/dyn/networkservices_v1.projects.locations.gateways.html @@ -86,9 +86,6 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Gateway.

-

- 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.

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

Lists Gateways in a given project and location.

@@ -98,12 +95,6 @@

Instance Methods

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

Updates the parameters of a single Gateway.

-

- 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() @@ -255,54 +246,6 @@

Method Details

}
-
- 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).
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Gateways in a given project and location.
@@ -437,119 +380,4 @@ 

Method Details

}
-
- 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/networkservices_v1.projects.locations.meshes.html b/docs/dyn/networkservices_v1.projects.locations.meshes.html index 34c2e6e57cb..d4b09936e66 100644 --- a/docs/dyn/networkservices_v1.projects.locations.meshes.html +++ b/docs/dyn/networkservices_v1.projects.locations.meshes.html @@ -86,9 +86,6 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Mesh.

-

- 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.

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

Lists Meshes in a given project and location.

@@ -98,12 +95,6 @@

Instance Methods

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

Updates the parameters of a single Mesh.

-

- 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() @@ -225,54 +216,6 @@

Method Details

}
-
- 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).
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Meshes in a given project and location.
@@ -374,119 +317,4 @@ 

Method Details

}
-
- 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/networkservices_v1.projects.locations.serviceBindings.html b/docs/dyn/networkservices_v1.projects.locations.serviceBindings.html index 9db0ca9c948..f96470b83c2 100644 --- a/docs/dyn/networkservices_v1.projects.locations.serviceBindings.html +++ b/docs/dyn/networkservices_v1.projects.locations.serviceBindings.html @@ -86,21 +86,12 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single ServiceBinding.

-

- 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.

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

Lists ServiceBinding in a given project and location.

list_next()

Retrieves the next page of results.

-

- 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() @@ -220,54 +211,6 @@

Method Details

}
-
- 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).
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists ServiceBinding in a given project and location.
@@ -316,119 +259,4 @@ 

Method Details

-
- 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/networkservices_v1beta1.projects.locations.endpointPolicies.html b/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html index 8f6f510d65f..367a133c97a 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.endpointPolicies.html @@ -86,9 +86,6 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single EndpointPolicy.

-

- 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.

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

Lists EndpointPolicies in a given project and location.

@@ -98,12 +95,6 @@

Instance Methods

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

Updates the parameters of a single EndpointPolicy.

-

- 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() @@ -259,54 +250,6 @@

Method Details

}
-
- 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).
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists EndpointPolicies in a given project and location.
@@ -442,119 +385,4 @@ 

Method Details

}
-
- 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/networkservices_v1beta1.projects.locations.gateways.html b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html index 78a329154e0..008fd4f7caa 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.gateways.html @@ -86,9 +86,6 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Gateway.

-

- 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.

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

Lists Gateways in a given project and location.

@@ -98,12 +95,6 @@

Instance Methods

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

Updates the parameters of a single Gateway.

-

- 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() @@ -255,54 +246,6 @@

Method Details

}
-
- 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).
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Gateways in a given project and location.
@@ -437,119 +380,4 @@ 

Method Details

}
-
- 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/networkservices_v1beta1.projects.locations.meshes.html b/docs/dyn/networkservices_v1beta1.projects.locations.meshes.html index 0f96c6fe493..a55dcfa173c 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.meshes.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.meshes.html @@ -86,9 +86,6 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single Mesh.

-

- 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.

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

Lists Meshes in a given project and location.

@@ -98,12 +95,6 @@

Instance Methods

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

Updates the parameters of a single Mesh.

-

- 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() @@ -225,54 +216,6 @@

Method Details

}
-
- 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).
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists Meshes in a given project and location.
@@ -374,119 +317,4 @@ 

Method Details

}
-
- 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/networkservices_v1beta1.projects.locations.serviceBindings.html b/docs/dyn/networkservices_v1beta1.projects.locations.serviceBindings.html index aff85683d41..f21a85d2175 100644 --- a/docs/dyn/networkservices_v1beta1.projects.locations.serviceBindings.html +++ b/docs/dyn/networkservices_v1beta1.projects.locations.serviceBindings.html @@ -86,21 +86,12 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single ServiceBinding.

-

- 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.

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

Lists ServiceBinding in a given project and location.

list_next()

Retrieves the next page of results.

-

- 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() @@ -220,54 +211,6 @@

Method Details

}
-
- 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).
-}
-
-
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists ServiceBinding in a given project and location.
@@ -316,119 +259,4 @@ 

Method Details

-
- 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/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html index b94ed1dfdcb..7a4e3309c90 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.vulnerabilities.html @@ -545,11 +545,6 @@

Method Details

"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was. "sbomState": "A String", # The progress of the SBOM generation. }, - "vulnerabilityAttestation": { # The status of an vulnerability attestation generation. # The status of an vulnerability attestation generation. - "error": "A String", # If failure, the error reason for why the attestation generation failed. - "lastAttemptTime": "A String", # The last time we attempted to generate an attestation. - "state": "A String", # The success/failure state of the latest attestation attempt. - }, }, "dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse. "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html index bdbb6fe687d..0b8e033cdeb 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.vulnerabilities.html @@ -545,11 +545,6 @@

Method Details

"error": "A String", # If there was an error generating an SBOM, this will indicate what that error was. "sbomState": "A String", # The progress of the SBOM generation. }, - "vulnerabilityAttestation": { # The status of an vulnerability attestation generation. # The status of an vulnerability attestation generation. - "error": "A String", # If failure, the error reason for why the attestation generation failed. - "lastAttemptTime": "A String", # The last time we attempted to generate an attestation. - "state": "A String", # The success/failure state of the latest attestation attempt. - }, }, "dsseAttestation": { # Deprecated. Prefer to use a regular Occurrence, and populate the Envelope at the top level of the Occurrence. # Describes an attestation of an artifact using dsse. "envelope": { # MUST match https://github.com/secure-systems-lab/dsse/blob/master/envelope.proto. An authenticated message of arbitrary type. # If doing something security critical, make sure to verify the signatures in this metadata. diff --git a/docs/dyn/playintegrity_v1.deviceRecall.html b/docs/dyn/playintegrity_v1.deviceRecall.html new file mode 100644 index 00000000000..7de25202f97 --- /dev/null +++ b/docs/dyn/playintegrity_v1.deviceRecall.html @@ -0,0 +1,119 @@ + + + +

Google Play Integrity API . deviceRecall

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ write(packageName, body=None, x__xgafv=None)

+

Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP).

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ write(packageName, body=None, x__xgafv=None) +
Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP).
+
+Args:
+  packageName: string, Required. Package name of the app the attached integrity token belongs to. (required)
+  body: object, The request body.
+    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.
+  "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.
+    "bitThird": True or False, # Required. Third recall bit value.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for the Write Device Recall action. Currently empty.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/playintegrity_v1.html b/docs/dyn/playintegrity_v1.html index 9463e229481..d04b6287ee9 100644 --- a/docs/dyn/playintegrity_v1.html +++ b/docs/dyn/playintegrity_v1.html @@ -74,6 +74,11 @@

Google Play Integrity API

Instance Methods

+

+ deviceRecall() +

+

Returns the deviceRecall Resource.

+

v1()

diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html index e66a6c125af..97a9a896f73 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.attributesConfig.html @@ -120,14 +120,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -187,14 +179,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -275,14 +259,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -344,14 +320,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -412,14 +380,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.html b/docs/dyn/retail_v2.projects.locations.catalogs.html index f9e75738e57..35c504818ea 100644 --- a/docs/dyn/retail_v2.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2.projects.locations.catalogs.html @@ -203,7 +203,7 @@

Method Details

}, ], "recentSearchResults": [ # Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens. - { # Recent search of this user. + { # Deprecated: Recent search of this user. "recentSearch": "A String", # The recent search query. }, ], @@ -302,14 +302,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -571,14 +563,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -641,14 +625,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html index cfb1907f379..59b262049aa 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.attributesConfig.html @@ -123,14 +123,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -191,14 +183,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -313,14 +297,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -383,14 +359,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -452,14 +420,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html index 6b42b1e244b..c9bc22895f3 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.branches.html @@ -136,9 +136,6 @@

Method Details

"scope": "A String", # [ProductCountScope] of the [counts]. }, ], - "productCounts": { # Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view. - "a_key": "A String", - }, "qualityMetrics": [ # Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in BranchView.BASIC view. { # Metric measured on a group of Products against a certain quality requirement. Contains the number of products that pass the check and the number of products that don't. "qualifiedProductCount": 42, # Number of products passing the quality requirement check. We only check searchable products. @@ -350,9 +347,6 @@

Method Details

"scope": "A String", # [ProductCountScope] of the [counts]. }, ], - "productCounts": { # Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * "primary-in-stock", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * "primary-out-of-stock", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * "primary-preorder", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * "primary-backorder", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * "variant-in-stock", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * "variant-out-of-stock", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * "variant-preorder", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * "variant-backorder", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * "price-discounted", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view. - "a_key": "A String", - }, "qualityMetrics": [ # Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in BranchView.BASIC view. { # Metric measured on a group of Products against a certain quality requirement. Contains the number of products that pass the check and the number of products that don't. "qualifiedProductCount": 42, # Number of products passing the quality requirement check. We only check searchable products. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html index b6ed7003bda..604ad9b8bfc 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.html @@ -236,7 +236,7 @@

Method Details

}, ], "recentSearchResults": [ # Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens. - { # Recent search of this user. + { # Deprecated: Recent search of this user. "recentSearch": "A String", # The recent search query. }, ], @@ -335,14 +335,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -662,14 +654,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -733,14 +717,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html index 4821a3066cc..09eb2b74275 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.attributesConfig.html @@ -123,14 +123,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -191,14 +183,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -313,14 +297,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -383,14 +359,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -452,14 +420,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.html index c1e3e2ff801..3d0c44e06ab 100644 --- a/docs/dyn/retail_v2beta.projects.locations.catalogs.html +++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.html @@ -203,7 +203,7 @@

Method Details

}, ], "recentSearchResults": [ # Deprecated. Matched recent searches of this user. The maximum number of recent searches is 10. This field is a restricted feature. If you want to enable it, contact Retail Search support. This feature is only available when CompleteQueryRequest.visitor_id field is set and UserEvent is imported. The recent searches satisfy the follow rules: * They are ordered from latest to oldest. * They are matched with CompleteQueryRequest.query case insensitively. * They are transformed to lower case. * They are UTF-8 safe. Recent searches are deduplicated. More recent searches will be reserved when duplication happens. - { # Recent search of this user. + { # Deprecated: Recent search of this user. "recentSearch": "A String", # The recent search query. }, ], @@ -302,14 +302,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -629,14 +621,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. @@ -700,14 +684,6 @@

Method Details

], "mergedFacet": { # The current facet key (i.e. attribute config) maps into the merged_facet_key. A facet key can have at most one child. The current facet key and the merged facet key need both to be textual custom attributes or both numerical custom attributes (same type). # Use this field only if you want to merge a facet key into another facet key. "mergedFacetKey": "A String", # The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute. - "mergedFacetValues": [ # Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value. - { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. - "mergedValue": "A String", # All the previous values are replaced by this merged facet value. This merged_value must be non-empty and can have up to 128 characters. - "values": [ # All the facet values that are replaces by the same merged_value that follows. The maximum number of values per MergedFacetValue is 25. Each value can have up to 128 characters. - "A String", - ], - }, - ], }, "mergedFacetValues": [ # Each instance replaces a list of facet values by a merged facet value. If a facet value is not in any list, then it will stay the same. To avoid conflicts, only paths of length 1 are accepted. In other words, if "dark_blue" merged into "BLUE", then the latter can't merge into "blues" because this would create a path of length 2. The maximum number of instances of MergedFacetValue per CatalogAttribute is 100. This feature is available only for textual custom attributes. { # Replaces a set of textual facet values by the same (possibly different) merged facet value. Each facet value should appear at most once as a value per CatalogAttribute. This feature is available only for textual custom attributes. diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index 800009e2442..92c71f53320 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -238,7 +238,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -545,7 +545,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -767,7 +767,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index a1e199964e9..4fcdc845e6d 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -362,7 +362,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -584,7 +584,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html index 110c63bd3b4..1ee99e8e782 100644 --- a/docs/dyn/sheets_v4.spreadsheets.html +++ b/docs/dyn/sheets_v4.spreadsheets.html @@ -2152,7 +2152,7 @@

Method Details

], }, }, - "addDataSource": { # Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope. # Adds a data source. + "addDataSource": { # Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source. # Adds a data source. "dataSource": { # Information about an external data source in the spreadsheet. # The data source to add. "calculatedColumns": [ # All calculated columns in the data source. { # A column in a data source. @@ -3322,7 +3322,7 @@

Method Details

"startIndex": 42, # The start (inclusive) of the span, or not set if unbounded. }, }, - "cancelDataSourceRefresh": { # Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. # Cancels refreshes of one or multiple data sources and associated dbobjects. + "cancelDataSourceRefresh": { # Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source. # Cancels refreshes of one or multiple data sources and associated dbobjects. "dataSourceId": "A String", # Reference to a DataSource. If specified, cancels all associated data source object refreshes for this data source. "isAll": True or False, # Cancels all existing data source object refreshes for all data sources in the spreadsheet. "references": { # A list of references to data source objects. # References to data source objects whose refreshes are to be cancelled. @@ -3587,7 +3587,7 @@

Method Details

"startRowIndex": 42, # The start row (inclusive) of the range, or not set if unbounded. }, }, - "refreshDataSource": { # Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly. # Refreshes one or multiple data sources and associated dbobjects. + "refreshDataSource": { # Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly. # Refreshes one or multiple data sources and associated dbobjects. "dataSourceId": "A String", # Reference to a DataSource. If specified, refreshes all associated data source objects for the data source. "force": True or False, # Refreshes the data source objects regardless of the current state. If not set and a referenced data source object was in error state, the refresh will fail immediately. "isAll": True or False, # Refreshes all existing data source objects in the spreadsheet. @@ -7426,7 +7426,7 @@

Method Details

}, "sheetId": 42, # The sheet of the rule to move. Required if new_index is set, unused otherwise. }, - "updateDataSource": { # Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope. # Updates a data source. + "updateDataSource": { # Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source. # Updates a data source. "dataSource": { # Information about an external data source in the spreadsheet. # The data source to update. "calculatedColumns": [ # All calculated columns in the data source. { # A column in a data source. diff --git a/docs/dyn/slides_v1.presentations.html b/docs/dyn/slides_v1.presentations.html index 9cfedd5fff5..ad6b5fe0ecf 100644 --- a/docs/dyn/slides_v1.presentations.html +++ b/docs/dyn/slides_v1.presentations.html @@ -777,7 +777,1067 @@

Method Details

"isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + "notesPage": { # A page in a presentation. # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. + "layoutProperties": { # The properties of Page are only relevant for pages with page_type LAYOUT. # Layout specific properties. Only set if page_type = LAYOUT. + "displayName": "A String", # The human-readable name of the layout. + "masterObjectId": "A String", # The object ID of the master that this layout is based on. + "name": "A String", # The name of the layout. + }, + "masterProperties": { # The properties of Page that are only relevant for pages with page_type MASTER. # Master specific properties. Only set if page_type = MASTER. + "displayName": "A String", # The human-readable name of the master. + }, + "notesProperties": { # The properties of Page that are only relevant for pages with page_type NOTES. # Notes specific properties. Only set if page_type = NOTES. + "speakerNotesObjectId": "A String", # The object ID of the shape on this notes page that contains the speaker notes for the corresponding slide. The actual shape may not always exist on the notes page. Inserting text using this object ID will automatically create the shape. In this case, the actual shape may have different object ID. The `GetPresentation` or `GetPage` action will always return the latest object ID. + }, + "objectId": "A String", # The object ID for this page. Object IDs used by Page and PageElement share the same namespace. + "pageElements": [ # The page elements rendered on the page. + { # A visual element rendered on a page. + "description": "A String", # The description of the page element. Combined with title to display alt text. The field is not supported for Group elements. + "elementGroup": { # A PageElement kind representing a joined collection of PageElements. # A collection of page elements joined as a single unit. + "children": [ # The collection of elements in the group. The minimum size of a group is 2. + # Object with schema name: PageElement + ], + }, + "image": { # A PageElement kind representing an image. # An image page element. + "contentUrl": "A String", # An URL to an image with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. + "imageProperties": { # The properties of the Image. # The properties of the image. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "cropProperties": { # The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. # The crop properties of the image. If not set, the image is not cropped. This property is read-only. + "angle": 3.14, # The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. + "bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. + "leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. + "rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. + "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. + }, + "link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the image. If not set, the image has no outline. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored. This property is read-only. + "name": "A String", # The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. + "recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. + { # A color and position in a gradient band. + "alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. + "color": { # A themeable solid color value. # The color of the gradient stop. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "position": 3.14, # The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. + }, + ], + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow of the image. If not set, the image has no shadow. This property is read-only. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. + }, + "placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the image is a placeholder image and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. + "index": 42, # The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. + "parentObjectId": "A String", # The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. + "type": "A String", # The type of the placeholder. + }, + "sourceUrl": "A String", # The source URL is the URL used to insert the image. The source URL can be empty. + }, + "line": { # A PageElement kind representing a non-connector line, straight connector, curved connector, or bent connector. # A line page element. + "lineCategory": "A String", # The category of the line. It matches the `category` specified in CreateLineRequest, and can be updated with UpdateLineCategoryRequest. + "lineProperties": { # The properties of the Line. When unset, these fields default to values that match the appearance of new lines created in the Slides editor. # The properties of the line. + "dashStyle": "A String", # The dash style of the line. + "endArrow": "A String", # The style of the arrow at the end of the line. + "endConnection": { # The properties for one end of a Line connection. # The connection at the end of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have an `end_connection`. + "connectedObjectId": "A String", # The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. + "connectionSiteIndex": 42, # The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. + }, + "lineFill": { # The fill of the line. # The fill of the line. The default line fill matches the defaults for new lines created in the Slides editor. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "link": { # A hypertext link. # The hyperlink destination of the line. If unset, there is no link. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "startArrow": "A String", # The style of the arrow at the beginning of the line. + "startConnection": { # The properties for one end of a Line connection. # The connection at the beginning of the line. If unset, there is no connection. Only lines with a Type indicating it is a "connector" can have a `start_connection`. + "connectedObjectId": "A String", # The object ID of the connected page element. Some page elements, such as groups, tables, and lines do not have connection sites and therefore cannot be connected to a connector line. + "connectionSiteIndex": 42, # The index of the connection site on the connected page element. In most cases, it corresponds to the predefined connection site index from the ECMA-376 standard. More information on those connection sites can be found in the description of the "cnx" attribute in section 20.1.9.9 and Annex H. "Predefined DrawingML Shape and Text Geometries" of "Office Open XML File Formats-Fundamentals and Markup Language Reference", part 1 of [ECMA-376 5th edition] (http://www.ecma-international.org/publications/standards/Ecma-376.htm). The position of each connection site can also be viewed from Slides editor. + }, + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the line. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "lineType": "A String", # The type of the line. + }, + "objectId": "A String", # The object ID for this page element. Object IDs used by google.apps.slides.v1.Page and google.apps.slides.v1.PageElement share the same namespace. + "shape": { # A PageElement kind representing a generic shape that does not have a more specific classification. # A generic shape. + "placeholder": { # The placeholder information that uniquely identifies a placeholder shape. # Placeholders are page elements that inherit from corresponding placeholders on layouts and masters. If set, the shape is a placeholder shape and any inherited properties can be resolved by looking at the parent placeholder identified by the Placeholder.parent_object_id field. + "index": 42, # The index of the placeholder. If the same placeholder types are present in the same page, they would have different index values. + "parentObjectId": "A String", # The object ID of this shape's parent placeholder. If unset, the parent placeholder shape does not exist, so the shape does not inherit properties from any other shape. + "type": "A String", # The type of the placeholder. + }, + "shapeProperties": { # The properties of a Shape. If the shape is a placeholder shape as determined by the placeholder field, then these properties may be inherited from a parent placeholder shape. Determining the rendered value of the property depends on the corresponding property_state field value. Any text autofit settings on the shape are automatically deactivated by requests that can impact how text fits in the shape. # The properties of the shape. + "autofit": { # The autofit properties of a Shape. # The autofit properties of the shape. This property is only set for shapes that allow text. + "autofitType": "A String", # The autofit type of the shape. If the autofit type is AUTOFIT_TYPE_UNSPECIFIED, the autofit type is inherited from a parent placeholder if it exists. The field is automatically set to NONE if a request is made that might affect text fitting within its bounding text box. In this case the font_scale is applied to the font_size and the line_spacing_reduction is applied to the line_spacing. Both properties are also reset to default values. + "fontScale": 3.14, # The font scale applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 1. For TEXT_AUTOFIT, this value multiplied by the font_size gives the font size that is rendered in the editor. This property is read-only. + "lineSpacingReduction": 3.14, # The line spacing reduction applied to the shape. For shapes with autofit_type NONE or SHAPE_AUTOFIT, this value is the default value of 0. For TEXT_AUTOFIT, this value subtracted from the line_spacing gives the line spacing that is rendered in the editor. This property is read-only. + }, + "contentAlignment": "A String", # The alignment of the content in the shape. If unspecified, the alignment is inherited from a parent placeholder if it exists. If the shape has no parent, the default alignment matches the alignment for new shapes created in the Slides editor. + "link": { # A hypertext link. # The hyperlink destination of the shape. If unset, there is no link. Links are not inherited from parent placeholders. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the shape. If unset, the outline is inherited from a parent placeholder if it exists. If the shape has no parent, then the default outline depends on the shape type, matching the defaults for new shapes created in the Slides editor. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow properties of the shape. If unset, the shadow is inherited from a parent placeholder if it exists. If the shape has no parent, then the default shadow matches the defaults for new shapes created in the Slides editor. This property is read-only. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + "shapeBackgroundFill": { # The shape background fill. # The background fill of the shape. If unset, the background fill is inherited from a parent placeholder if it exists. If the shape has no parent, then the default background fill depends on the shape type, matching the defaults for new shapes created in the Slides editor. + "propertyState": "A String", # The background fill property state. Updating the fill on a shape will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a shape, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + }, + "shapeType": "A String", # The type of the shape. + "text": { # The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page. # The text content of the shape. + "lists": { # The bulleted lists contained in this text, keyed by list ID. + "a_key": { # A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. + "listId": "A String", # The ID of the list. + "nestingLevel": { # A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. + "a_key": { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The style of a bullet at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + }, + }, + "textElements": [ # The text contents broken down into its component parts, including styling information. This property is read-only. + { # A TextElement describes the content of a range of indices in the text content of a Shape or TableCell. + "autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. + "content": "A String", # The rendered content of this auto text, if available. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this auto text. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "type": "A String", # The type of this auto text. + }, + "endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code units. + "paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The paragraph specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "glyph": "A String", # The rendered bullet glyph for this paragraph. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + }, + "style": { # Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message. # The paragraph's style + "alignment": "A String", # The text alignment for this paragraph. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + }, + }, + "startIndex": 42, # The zero-based start index of this text element, in Unicode code units. + "textRun": { # A TextElement kind that represents a run of text that all has the same styling. # A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. + "content": "A String", # The text of this run. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + ], + }, + }, + "sheetsChart": { # A PageElement kind representing a linked chart embedded from Google Sheets. # A linked chart embedded from Google Sheets. Unlinked charts are represented as images. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that is embedded. + "contentUrl": "A String", # The URL of an image of the embedded chart, with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the image as the original requester. Access to the image may be lost if the presentation's sharing settings change. + "sheetsChartProperties": { # The properties of the SheetsChart. # The properties of the Sheets chart. + "chartImageProperties": { # The properties of the Image. # The properties of the embedded chart image. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. This property is read-only. + "cropProperties": { # The crop properties of an object enclosed in a container. For example, an Image. The crop properties is represented by the offsets of four edges which define a crop rectangle. The offsets are measured in percentage from the corresponding edges of the object's original bounding rectangle towards inside, relative to the object's original dimensions. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the object's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the object's original bounding rectangle. - If the left edge of the crop rectangle is on the right side of its right edge, the object will be flipped horizontally. - If the top edge of the crop rectangle is below its bottom edge, the object will be flipped vertically. - If all offsets and rotation angle is 0, the object is not cropped. After cropping, the content in the crop rectangle will be stretched to fit its container. # The crop properties of the image. If not set, the image is not cropped. This property is read-only. + "angle": 3.14, # The rotation angle of the crop window around its center, in radians. Rotation angle is applied after the offset. + "bottomOffset": 3.14, # The offset specifies the bottom edge of the crop rectangle that is located above the original bounding rectangle bottom edge, relative to the object's original height. + "leftOffset": 3.14, # The offset specifies the left edge of the crop rectangle that is located to the right of the original bounding rectangle left edge, relative to the object's original width. + "rightOffset": 3.14, # The offset specifies the right edge of the crop rectangle that is located to the left of the original bounding rectangle right edge, relative to the object's original width. + "topOffset": 3.14, # The offset specifies the top edge of the crop rectangle that is located below the original bounding rectangle top edge, relative to the object's original height. + }, + "link": { # A hypertext link. # The hyperlink destination of the image. If unset, there is no link. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the image. If not set, the image has no outline. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "recolor": { # A recolor effect applied on an image. # The recolor effect of the image. If not set, the image is not recolored. This property is read-only. + "name": "A String", # The name of the recolor effect. The name is determined from the `recolor_stops` by matching the gradient against the colors in the page's current color scheme. This property is read-only. + "recolorStops": [ # The recolor effect is represented by a gradient, which is a list of color stops. The colors in the gradient will replace the corresponding colors at the same position in the color palette and apply to the image. This property is read-only. + { # A color and position in a gradient band. + "alpha": 3.14, # The alpha value of this color in the gradient band. Defaults to 1.0, fully opaque. + "color": { # A themeable solid color value. # The color of the gradient stop. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "position": 3.14, # The relative position of the color stop in the gradient band measured in percentage. The value should be in the interval [0.0, 1.0]. + }, + ], + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow of the image. If not set, the image has no shadow. This property is read-only. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means completely transparent. This property is read-only. + }, + }, + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + "size": { # A width and height. # The size of the page element. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "speakerSpotlight": { # A PageElement kind representing a Speaker Spotlight. # A Speaker Spotlight. + "speakerSpotlightProperties": { # The properties of the SpeakerSpotlight. # The properties of the Speaker Spotlight. + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the Speaker Spotlight. If not set, it has no outline. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "shadow": { # The shadow properties of a page element. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The shadow of the Speaker Spotlight. If not set, it has no shadow. + "alignment": "A String", # The alignment point of the shadow, that sets the origin for translate, scale and skew of the shadow. This property is read-only. + "alpha": 3.14, # The alpha of the shadow's color, from 0.0 to 1.0. + "blurRadius": { # A magnitude in a single direction in the specified units. # The radius of the shadow blur. The larger the radius, the more diffuse the shadow becomes. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "color": { # A themeable solid color value. # The shadow color value. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + "propertyState": "A String", # The shadow property state. Updating the shadow on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no shadow on a page element, set this field to `NOT_RENDERED`. In this case, any other shadow fields set in the same request will be ignored. + "rotateWithShape": True or False, # Whether the shadow should rotate with the shape. This property is read-only. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # Transform that encodes the translate, scale, and skew of the shadow, relative to the alignment position. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "type": "A String", # The type of the shadow. This property is read-only. + }, + }, + }, + "table": { # A PageElement kind representing a table. # A table page element. + "columns": 42, # Number of columns in the table. + "horizontalBorderRows": [ # Properties of horizontal cell borders. A table's horizontal cell borders are represented as a grid. The grid has one more row than the number of rows in the table and the same number of columns as the table. For example, if the table is 3 x 3, its horizontal borders will be represented as a grid with 4 rows and 3 columns. + { # Contents of each border row in a table. + "tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. + { # The properties of each border cell. + "location": { # A location of a single table cell within a table. # The location of the border within the border table. + "columnIndex": 42, # The 0-based column index. + "rowIndex": 42, # The 0-based row index. + }, + "tableBorderProperties": { # The border styling properties of the TableBorderCell. # The border properties. + "dashStyle": "A String", # The dash style of the border. + "tableBorderFill": { # The fill of the border. # The fill of the table border. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + ], + }, + ], + "rows": 42, # Number of rows in the table. + "tableColumns": [ # Properties of each column. + { # Properties of each column in a table. + "columnWidth": { # A magnitude in a single direction in the specified units. # Width of a column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "tableRows": [ # Properties and contents of each row. Cells that span multiple rows are contained in only one of these rows and have a row_span greater than 1. + { # Properties and contents of each row in a table. + "rowHeight": { # A magnitude in a single direction in the specified units. # Height of a row. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "tableCells": [ # Properties and contents of each cell. Cells that span multiple columns are represented only once with a column_span greater than 1. As a result, the length of this collection does not always match the number of columns of the entire table. + { # Properties and contents of each table cell. + "columnSpan": 42, # Column span of the cell. + "location": { # A location of a single table cell within a table. # The location of the cell within the table. + "columnIndex": 42, # The 0-based column index. + "rowIndex": 42, # The 0-based row index. + }, + "rowSpan": 42, # Row span of the cell. + "tableCellProperties": { # The properties of the TableCell. # The properties of the table cell. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Slides editor. + "tableCellBackgroundFill": { # The table cell background fill. # The background fill of the table cell. The default fill matches the fill for newly created table cells in the Slides editor. + "propertyState": "A String", # The background fill property state. Updating the fill on a table cell will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a table cell, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + }, + "text": { # The general text content. The text must reside in a compatible shape (e.g. text box or rectangle) or a table cell in a page. # The text content of the cell. + "lists": { # The bulleted lists contained in this text, keyed by list ID. + "a_key": { # A List describes the look and feel of bullets belonging to paragraphs associated with a list. A paragraph that is part of a list has an implicit reference to that list's ID. + "listId": "A String", # The ID of the list. + "nestingLevel": { # A map of nesting levels to the properties of bullets at the associated level. A list has at most nine levels of nesting, so the possible values for the keys of this map are 0 through 8, inclusive. + "a_key": { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The style of a bullet at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + }, + }, + "textElements": [ # The text contents broken down into its component parts, including styling information. This property is read-only. + { # A TextElement describes the content of a range of indices in the text content of a Shape or TableCell. + "autoText": { # A TextElement kind that represents auto text. # A TextElement representing a spot in the text that is dynamically replaced with content that can change over time. + "content": "A String", # The rendered content of this auto text, if available. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this auto text. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "type": "A String", # The type of this auto text. + }, + "endIndex": 42, # The zero-based end index of this text element, exclusive, in Unicode code units. + "paragraphMarker": { # A TextElement kind that represents the beginning of a new paragraph. # A marker representing the beginning of a new paragraph. The `start_index` and `end_index` of this TextElement represent the range of the paragraph. Other TextElements with an index range contained inside this paragraph's range are considered to be part of this paragraph. The range of indices of two separate paragraphs will never overlap. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "bulletStyle": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The paragraph specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + "glyph": "A String", # The rendered bullet glyph for this paragraph. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + }, + "style": { # Styles that apply to a whole paragraph. If this text is contained in a shape with a parent placeholder, then these paragraph styles may be inherited from the parent. Which paragraph styles are inherited depend on the nesting level of lists: * A paragraph not in a list will inherit its paragraph style from the paragraph at the 0 nesting level of the list inside the parent placeholder. * A paragraph in a list will inherit its paragraph style from the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited paragraph styles are represented as unset fields in this message. # The paragraph's style + "alignment": "A String", # The text alignment for this paragraph. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since text direction is not inherited. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the end of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the start of the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount indentation for the paragraph on the side that corresponds to the start of the text, based on the current text direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + }, + }, + "startIndex": 42, # The zero-based start index of this text element, in Unicode code units. + "textRun": { # A TextElement kind that represents a run of text that all has the same styling. # A TextElement representing a run of text where all of the characters in the run have the same TextStyle. The `start_index` and `end_index` of TextRuns will always be fully contained in the index range of a single `paragraph_marker` TextElement. In other words, a TextRun will never span multiple paragraphs. + "content": "A String", # The text of this run. + "style": { # Represents the styling that can be applied to a TextRun. If this text is contained in a shape with a parent placeholder, then these text styles may be inherited from the parent. Which text styles are inherited depend on the nesting level of lists: * A text run in a paragraph that is not in a list will inherit its text style from the the newline character in the paragraph at the 0 nesting level of the list inside the parent placeholder. * A text run in a paragraph that is in a list will inherit its text style from the newline character in the paragraph at its corresponding nesting level of the list inside the parent placeholder. Inherited text styles are represented as unset fields in this message. If text is contained in a shape without a parent placeholder, unsetting these fields will revert the style to a value matching the defaults in the Slides editor. # The styling applied to this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. The `font_size` itself is not affected by changes in this field. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. Some fonts can affect the weight of the text. If an update request specifies values for both `font_family` and `bold`, the explicitly-set `bold` value is used. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. When read, the `font_size` will specified in points. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The color of the text itself. If set, the color is either opaque or transparent, depending on if the `opaque_color` field in it is set. + "opaqueColor": { # A themeable solid color value. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A hypertext link. # The hyperlink destination of the text. If unset, there is no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be set to ThemeColorType.HYPERLINK and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "pageObjectId": "A String", # If set, indicates this is a link to the specific page in this presentation with this ID. A page with this ID may not exist. + "relativeLink": "A String", # If set, indicates this is a link to a slide in this presentation, addressed by its position. + "slideIndex": 42, # If set, indicates this is a link to the slide at this zero-based index in the presentation. There may not be a slide at this index. + "url": "A String", # If set, indicates this is a link to the external web page at this URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight used to style a TextRun. # The font family and rendered weight of the text. This field is an extension of `font_family` meant to support explicit font weights without breaking backwards compatibility. As such, when reading the style of a range of text, the value of `weighted_font_family#font_family` will always be equal to that of `font_family`. However, when writing, if both fields are included in the field mask (either explicitly or through the wildcard `"*"`), their values are reconciled as follows: * If `font_family` is set and `weighted_font_family` is not, the value of `font_family` is applied with weight `400` ("normal"). * If both fields are set, the value of `font_family` must match that of `weighted_font_family#font_family`. If so, the font family and weight of `weighted_font_family` is applied. Otherwise, a 400 bad request error is returned. * If `weighted_font_family` is set and `font_family` is not, the font family and weight of `weighted_font_family` is applied. * If neither field is set, the font family and weight of the text inherit from the parent. Note that these properties cannot inherit separately from each other. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Slides or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The rendered weight of the text. This field can have any value that is a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. Weights greater than or equal to `700` are considered bold, and weights less than `700`are not bold. The default value is `400` ("normal"). + }, + }, + }, + }, + ], + }, + }, + ], + "tableRowProperties": { # Properties of each row in a table. # Properties of the row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # Minimum height of the row. The row will be rendered in the Slides editor at a height equal to or greater than this value in order to show all the text in the row's cell(s). + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + ], + "verticalBorderRows": [ # Properties of vertical cell borders. A table's vertical cell borders are represented as a grid. The grid has the same number of rows as the table and one more column than the number of columns in the table. For example, if the table is 3 x 3, its vertical borders will be represented as a grid with 3 rows and 4 columns. + { # Contents of each border row in a table. + "tableBorderCells": [ # Properties of each border cell. When a border's adjacent table cells are merged, it is not included in the response. + { # The properties of each border cell. + "location": { # A location of a single table cell within a table. # The location of the border within the border table. + "columnIndex": 42, # The 0-based column index. + "rowIndex": 42, # The 0-based row index. + }, + "tableBorderProperties": { # The border styling properties of the TableBorderCell. # The border properties. + "dashStyle": "A String", # The dash style of the border. + "tableBorderFill": { # The fill of the border. # The fill of the table border. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + ], + }, + ], + }, + "title": "A String", # The title of the page element. Combined with description to display alt text. The field is not supported for Group elements. + "transform": { # AffineTransform uses a 3x3 matrix with an implied last row of [ 0 0 1 ] to transform source coordinates (x,y) into destination coordinates (x', y') according to: x' x = shear_y scale_y translate_y 1 [ 1 ] After transformation, x' = scale_x * x + shear_x * y + translate_x; y' = scale_y * y + shear_y * x + translate_y; This message is therefore composed of these six matrix elements. # The transform of the page element. The visual appearance of the page element is determined by its absolute transform. To compute the absolute transform, preconcatenate a page element's transform with the transforms of all of its parent groups. If the page element is not in a group, its absolute transform is the same as the value in this field. The initial transform for the newly created Group is always the identity transform. + "scaleX": 3.14, # The X coordinate scaling element. + "scaleY": 3.14, # The Y coordinate scaling element. + "shearX": 3.14, # The X coordinate shearing element. + "shearY": 3.14, # The Y coordinate shearing element. + "translateX": 3.14, # The X coordinate translation element. + "translateY": 3.14, # The Y coordinate translation element. + "unit": "A String", # The units for translate elements. + }, + "video": { # A PageElement kind representing a video. # A video page element. + "id": "A String", # The video source's unique identifier for this video. + "source": "A String", # The video source. + "url": "A String", # An URL to a video. The URL is valid as long as the source video exists and sharing settings do not change. + "videoProperties": { # The properties of the Video. # The properties of the video. + "autoPlay": True or False, # Whether to enable video autoplay when the page is displayed in present mode. Defaults to false. + "end": 42, # The time at which to end playback, measured in seconds from the beginning of the video. If set, the end time should be after the start time. If not set or if you set this to a value that exceeds the video's length, the video will be played until its end. + "mute": True or False, # Whether to mute the audio during video playback. Defaults to false. + "outline": { # The outline of a PageElement. If these fields are unset, they may be inherited from a parent placeholder if it exists. If there is no parent, the fields will default to the value used for new page elements created in the Slides editor, which may depend on the page element kind. # The outline of the video. The default outline matches the defaults for new videos created in the Slides editor. + "dashStyle": "A String", # The dash style of the outline. + "outlineFill": { # The fill of the outline. # The fill of the outline. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + }, + "propertyState": "A String", # The outline property state. Updating the outline on a page element will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no outline on a page element, set this field to `NOT_RENDERED`. In this case, any other outline fields set in the same request will be ignored. + "weight": { # A magnitude in a single direction in the specified units. # The thickness of the outline. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "start": 42, # The time at which to start playback, measured in seconds from the beginning of the video. If set, the start time should be before the end time. If you set this to a value that exceeds the video's length in seconds, the video will be played from the last second. If not set, the video will be played from the beginning. + }, + }, + "wordArt": { # A PageElement kind representing word art. # A word art page element. + "renderedText": "A String", # The text rendered as word art. + }, + }, + ], + "pageProperties": { # The properties of the Page. The page will inherit properties from the parent page. Depending on the page type the hierarchy is defined in either SlideProperties or LayoutProperties. # The properties of the page. + "colorScheme": { # The palette of predefined colors for a page. # The color scheme of the page. If unset, the color scheme is inherited from a parent page. If the page has no parent, the color scheme uses a default Slides color scheme, matching the defaults in the Slides editor. Only the concrete colors of the first 12 ThemeColorTypes are editable. In addition, only the color scheme on `Master` pages can be updated. To update the field, a color scheme containing mappings from all the first 12 ThemeColorTypes to their concrete colors must be provided. Colors for the remaining ThemeColorTypes will be ignored. + "colors": [ # The ThemeColorType and corresponding concrete color pairs. + { # A pair mapping a theme color type to the concrete color it represents. + "color": { # An RGB color. # The concrete color corresponding to the theme color type above. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "type": "A String", # The type of the theme color. + }, + ], + }, + "pageBackgroundFill": { # The page background fill. # The background fill of the page. If unset, the background fill is inherited from a parent page if it exists. If the page has no parent, then the background fill defaults to the corresponding fill in the Slides editor. + "propertyState": "A String", # The background fill property state. Updating the fill on a page will implicitly update this field to `RENDERED`, unless another value is specified in the same request. To have no fill on a page, set this field to `NOT_RENDERED`. In this case, any other fill fields set in the same request will be ignored. + "solidFill": { # A solid color fill. The page or page element is filled entirely with the specified color value. If any field is unset, its value may be inherited from a parent placeholder if it exists. # Solid color fill. + "alpha": 3.14, # The fraction of this `color` that should be applied to the pixel. That is, the final pixel color is defined by the equation: pixel color = alpha * (color) + (1.0 - alpha) * (background color) This means that a value of 1.0 corresponds to a solid color, whereas a value of 0.0 corresponds to a completely transparent color. + "color": { # A themeable solid color value. # The color value of the solid fill. + "rgbColor": { # An RGB color. # An opaque RGB color. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "themeColor": "A String", # An opaque theme color. + }, + }, + "stretchedPictureFill": { # The stretched picture fill. The page or page element is filled entirely with the specified picture. The picture is stretched to fit its container. # Stretched picture fill. + "contentUrl": "A String", # Reading the content_url: An URL to a picture with a default lifetime of 30 minutes. This URL is tagged with the account of the requester. Anyone with the URL effectively accesses the picture as the original requester. Access to the picture may be lost if the presentation's sharing settings change. Writing the content_url: The picture is fetched once at insertion time and a copy is stored for display inside the presentation. Pictures must be less than 50MB in size, cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF format. The provided URL can be at most 2 kB in length. + "size": { # A width and height. # The original size of the picture fill. This field is read-only. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + }, + }, + "pageType": "A String", # The type of the page. + "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. + }, }, }, "updateSlidesPosition": { # Updates the position of slides in the presentation. # Updates the position of a set of slides in the presentation. @@ -2098,12 +3158,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -3167,12 +4222,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -4234,12 +5284,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -5313,12 +6358,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "title": "A String", # The title of the presentation. @@ -6393,12 +7433,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -7462,12 +8497,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -8529,12 +9559,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -9608,12 +10633,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "title": "A String", # The title of the presentation. @@ -10695,12 +11715,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "locale": "A String", # The locale of the presentation, as an IETF BCP 47 language tag. @@ -11764,12 +12779,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "notesMaster": { # A page in a presentation. # The notes master in the presentation. It serves three purposes: - Placeholder shapes on a notes master contain the default text styles and shape properties of all placeholder shapes on notes pages. Specifically, a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a `BODY` placeholder shape contains the speaker notes. - The notes master page properties define the common page properties inherited by all notes pages. - Any other shapes on the notes master appear on all notes pages. The notes master is read-only. @@ -12831,12 +13841,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, "pageSize": { # A width and height. # The size of pages in the presentation. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -13910,12 +14915,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. }, ], "title": "A String", # The title of the presentation. diff --git a/docs/dyn/slides_v1.presentations.pages.html b/docs/dyn/slides_v1.presentations.pages.html index c060e1d997b..494127feea5 100644 --- a/docs/dyn/slides_v1.presentations.pages.html +++ b/docs/dyn/slides_v1.presentations.pages.html @@ -1163,12 +1163,7 @@

Method Details

}, "pageType": "A String", # The type of the page. "revisionId": "A String", # Output only. The revision ID of the presentation. Can be used in update requests to assert the presentation revision hasn't changed since the last read operation. Only populated if the user has edit access to the presentation. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the presentation has not changed. Conversely, a changed ID (for the same presentation and user) usually means the presentation has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "slideProperties": { # The properties of Page that are only relevant for pages with page_type SLIDE. # Slide specific properties. Only set if page_type = SLIDE. - "isSkipped": True or False, # Whether the slide is skipped in the presentation mode. Defaults to false. - "layoutObjectId": "A String", # The object ID of the layout that this slide is based on. This property is read-only. - "masterObjectId": "A String", # The object ID of the master that this slide is based on. This property is read-only. - "notesPage": # Object with schema name: Page # The notes page that this slide is associated with. It defines the visual appearance of a notes page when printing or exporting slides with speaker notes. A notes page inherits properties from the notes master. The placeholder shape with type BODY on the notes page contains the speaker notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. The notes page is read-only except for the text content and styles of the speaker notes shape. This property is read-only. - }, + "slideProperties": # Object with schema name: SlideProperties # Slide specific properties. Only set if page_type = SLIDE. } diff --git a/docs/dyn/spanner_v1.projects.instanceConfigOperations.html b/docs/dyn/spanner_v1.projects.instanceConfigOperations.html index e8517aafc5a..5c1d002828c 100644 --- a/docs/dyn/spanner_v1.projects.instanceConfigOperations.html +++ b/docs/dyn/spanner_v1.projects.instanceConfigOperations.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.

+

Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.

list_next()

Retrieves the next page of results.

@@ -91,11 +91,11 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.
+  
Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.
 
 Args:
-  parent: string, Required. The project of the instance config operations. Values are of the form `projects/`. (required)
-  filter: string, An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
+  parent: string, Required. The project of the instance configuration operations. Values are of the form `projects/`. (required)
+  filter: string, An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \ `(metadata.instance_config.name:custom-config) AND` \ `(metadata.progress.start_time < \"2021-03-28T14:50:00Z\") AND` \ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance configuration name contains "custom-config". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.
   pageSize: integer, Number of operations to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
   pageToken: string, If non-empty, `page_token` should contain a next_page_token from a previous ListInstanceConfigOperationsResponse to the same `parent` and with the same `filter`.
   x__xgafv: string, V1 error format.
@@ -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 config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata. + "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. { # 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 f1fbb4a4df8..e6d69508237 100644 --- a/docs/dyn/spanner_v1.projects.instanceConfigs.html +++ b/docs/dyn/spanner_v1.projects.instanceConfigs.html @@ -89,22 +89,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.

+

Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.

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 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.

get(name, x__xgafv=None)

Gets information about a particular instance configuration.

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

-

Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.

+

Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.

list_next()

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 config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.

+

Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.

Method Details

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

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.
+  
Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.
 
 Args:
   parent: string, Required. The name of the project in which to create the instance config. Values are of the form `projects/`. (required)
@@ -121,11 +121,11 @@ 

Method Details

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. - "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 config is a Google or User Managed Configuration. + "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. "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 config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. + "etag": "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. "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", @@ -133,8 +133,8 @@

Method Details

"leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], - "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. - "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. + "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. { "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". @@ -142,18 +142,18 @@

Method Details

}, ], "quorumType": "A String", # Output only. The `QuorumType` of the instance configuration. - "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. - "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`. + "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. + "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". "type": "A String", # The type of replica. }, ], - "state": "A String", # Output only. The current instance config state. Applicable only for USER_MANAGED configs. + "state": "A String", # Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. "storageLimitPerProcessingUnit": "A String", # Output only. The storage limit in bytes per processing unit. }, - "instanceConfigId": "A String", # Required. The ID of the instance config to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google managed configurations. + "instanceConfigId": "A String", # 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. "validateOnly": True or False, # An option to validate, but not actually execute, a request, and provide the same response. } @@ -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 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.
 
 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 config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.
+  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.
   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
@@ -221,10 +221,10 @@ 

Method Details

An object of the form: { # 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 config is a Google or User Managed Configuration. + "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. "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 config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. + "etag": "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. "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", @@ -232,8 +232,8 @@

Method Details

"leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], - "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. - "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. + "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. { "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". @@ -241,22 +241,22 @@

Method Details

}, ], "quorumType": "A String", # Output only. The `QuorumType` of the instance configuration. - "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. - "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`. + "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. + "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". "type": "A String", # The type of replica. }, ], - "state": "A String", # Output only. The current instance config state. Applicable only for USER_MANAGED configs. + "state": "A String", # Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. "storageLimitPerProcessingUnit": "A String", # Output only. The storage limit in bytes per processing unit. }
list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.
+  
Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.
 
 Args:
   parent: string, Required. The name of the project for which a list of supported instance configurations is requested. Values are of the form `projects/`. (required)
@@ -273,10 +273,10 @@ 

Method Details

{ # The response for ListInstanceConfigs. "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 config is a Google or User Managed Configuration. + "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. "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 config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly. + "etag": "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. "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", @@ -284,8 +284,8 @@

Method Details

"leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], - "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. - "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. + "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. { "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". @@ -293,15 +293,15 @@

Method Details

}, ], "quorumType": "A String", # Output only. The `QuorumType` of the instance configuration. - "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. - "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`. + "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. + "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". "type": "A String", # The type of replica. }, ], - "state": "A String", # Output only. The current instance config state. Applicable only for USER_MANAGED configs. + "state": "A String", # Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. "storageLimitPerProcessingUnit": "A String", # Output only. The storage limit in bytes per processing unit. }, ], @@ -325,19 +325,19 @@

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 config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.
+  
Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.
 
 Args:
-  name: string, A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. (required)
+  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)
   body: object, The request body.
     The object takes the form of:
 
 { # 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 config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used.
-    "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 config is a Google or User Managed Configuration.
+  "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.
     "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 config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.
+    "etag": "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.
     "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",
@@ -345,8 +345,8 @@ 

Method Details

"leaderOptions": [ # Allowed values of the "default_leader" schema option for databases in instances that use this instance configuration. "A String", ], - "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`. - "optionalReplicas": [ # Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations. + "name": "A String", # A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`. + "optionalReplicas": [ # Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations. { "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". @@ -354,15 +354,15 @@

Method Details

}, ], "quorumType": "A String", # Output only. The `QuorumType` of the instance configuration. - "reconciling": True or False, # Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config. - "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`. + "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. + "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. "location": "A String", # The location of the serving resources, e.g., "us-central1". "type": "A String", # The type of replica. }, ], - "state": "A String", # Output only. The current instance config state. Applicable only for USER_MANAGED configs. + "state": "A String", # Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations. "storageLimitPerProcessingUnit": "A String", # Output only. The storage limit in bytes per processing unit. }, "updateMask": "A String", # Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated. diff --git a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html new file mode 100644 index 00000000000..076f6e0e5af --- /dev/null +++ b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html @@ -0,0 +1,226 @@ + + + +

Cloud Spanner API . projects . instances . databases . backupSchedules

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.

+

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

+

Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.

+

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

+

Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ getIamPolicy(resource, body=None, x__xgafv=None) +
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.
+
+Args:
+  resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `GetIamPolicy` method.
+  "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`.
+    "requestedPolicyVersion": 42, # 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/).
+  "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 a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.
+
+Args:
+  resource: string, REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources. (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.
+    "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).
+  },
+}
+
+  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/).
+  "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 the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.
+
+Args:
+  resource: string, REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `TestIamPermissions` method.
+  "permissions": [ # REQUIRED: The set of permissions to check for 'resource'. Permissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.
+    "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/spanner_v1.projects.instances.databases.html b/docs/dyn/spanner_v1.projects.instances.databases.html index df83bdeb249..e7f8a6c4b3e 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.html @@ -74,6 +74,11 @@

Cloud Spanner API . projects . instances . databases

Instance Methods

+

+ backupSchedules() +

+

Returns the backupSchedules Resource.

+

databaseRoles()

@@ -97,7 +102,7 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

+

Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.

dropDatabase(database, x__xgafv=None)

Drops (aka deletes) a Cloud Spanner database. Completed backups for the database will be retained according to their `expire_time`. Note: Cloud Spanner might continue to accept requests for a few seconds after the database has been deleted.

@@ -192,7 +197,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.
+  
Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.
 
 Args:
   parent: string, Required. The name of the instance that will serve the new database. Values are of the form `projects//instances/`. (required)
@@ -211,7 +216,7 @@ 

Method Details

"extraStatements": [ # Optional. A list of DDL statements to run inside the newly created database. Statements can create tables, indexes, etc. These statements execute atomically with the creation of the database: if there is an error in any statement, the database is not created. "A String", ], - "protoDescriptors": "A String", # Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). + "protoDescriptors": "A String", # Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \ --include_imports \ --descriptor_set_out=descriptors.data \ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description). } x__xgafv: string, V1 error format. @@ -798,7 +803,7 @@

Method Details

"encryptionConfig": { # Encryption configuration for the restored database. # Optional. An encryption configuration describing the encryption type and key resources in Cloud KMS used to encrypt/decrypt the database to restore to. If this field is not specified, the restored database will use the same encryption configuration as the backup by default, namely encryption_type = `USE_CONFIG_DEFAULT_OR_BACKUP_ENCRYPTION`. "encryptionType": "A String", # Required. The encryption type of the restored database. "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to encrypt/decrypt the restored database. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`. - "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs. + "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configurations, specify a single regional location KMS key. * For multi-regional database instance configurations of type `GOOGLE_MANAGED`, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For a database instance configuration of type `USER_MANAGED`, please specify only regional location KMS keys to cover each region in the instance configuration. Multi-regional location KMS keys are not supported for USER_MANAGED instance configurations. "A String", ], }, diff --git a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html index e77c1e56289..b372d120764 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.sessions.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.sessions.html @@ -1186,7 +1186,7 @@

Method Details

"maxPartitions": "A String", # **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired maximum number of partitions to return. For example, this may be set to the number of workers available. The default for this option is currently 10,000. The maximum value is currently 200,000. This is only a hint. The actual number of partitions returned may be smaller or larger than this maximum count request. "partitionSizeBytes": "A String", # **Note:** This hint is currently ignored by PartitionQuery and PartitionRead requests. The desired data size for each partition generated. The default for this option is currently 1 GiB. This is only a hint. The actual size of each partition may be smaller or larger than this size request. }, - "sql": "A String", # Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. + "sql": "A String", # Required. The query request to generate partitions for. The request fails if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a PartitionedDml transaction for large, partition-friendly DML operations. "transaction": { # This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions. # Read only snapshot transactions are supported, read/write and single use transactions are not. "begin": { # Transactions: Each session can have at most one active transaction at a time (note that standalone reads and queries use a transaction internally and do count towards the one transaction limit). After the active transaction is completed, the session can immediately be re-used for the next transaction. It is not necessary to create a new session for each transaction. Transaction modes: Cloud Spanner supports three transaction modes: 1. Locking read-write. This type of transaction is the only way to write data into Cloud Spanner. These transactions rely on pessimistic locking and, if necessary, two-phase commit. Locking read-write transactions may abort, requiring the application to retry. 2. Snapshot read-only. Snapshot read-only transactions provide guaranteed consistency across several reads, but do not allow writes. Snapshot read-only transactions can be configured to read at timestamps in the past, or configured to perform a strong read (where Spanner will select a timestamp such that the read is guaranteed to see the effects of all transactions that have committed before the start of the read). Snapshot read-only transactions do not need to be committed. Queries on change streams must be performed with the snapshot read-only transaction mode, specifying a strong read. See TransactionOptions.ReadOnly.strong for more details. 3. Partitioned DML. This type of transaction is used to execute a single Partitioned DML statement. Partitioned DML partitions the key space and runs the DML statement over each partition in parallel using separate, internal transactions that commit independently. Partitioned DML transactions do not need to be committed. For transactions that only read, snapshot read-only transactions provide simpler semantics and are almost always faster. In particular, read-only transactions do not take locks, so they do not conflict with read-write transactions. As a consequence of not taking locks, they also do not abort, so retry loops are not needed. Transactions may only read-write data in a single database. They may, however, read-write data in different tables within that database. Locking read-write transactions: Locking transactions may be used to atomically read-modify-write data anywhere in a database. This type of transaction is externally consistent. Clients should attempt to minimize the amount of time a transaction is active. Faster transactions commit with higher probability and cause less contention. Cloud Spanner attempts to keep read locks active as long as the transaction continues to do reads, and the transaction has not been terminated by Commit or Rollback. Long periods of inactivity at the client may cause Cloud Spanner to release a transaction's locks and abort it. Conceptually, a read-write transaction consists of zero or more reads or SQL statements followed by Commit. At any time before Commit, the client can send a Rollback request to abort the transaction. Semantics: Cloud Spanner can commit the transaction if all read locks it acquired are still valid at commit time, and it is able to acquire write locks for all writes. Cloud Spanner can abort the transaction for any reason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees that the transaction has not modified any user data in Cloud Spanner. Unless the transaction commits, Cloud Spanner makes no guarantees about how long the transaction's locks were held for. It is an error to use Cloud Spanner locks for any sort of mutual exclusion other than between Cloud Spanner transactions themselves. Retrying aborted transactions: When a transaction aborts, the application can choose to retry the whole transaction again. To maximize the chances of successfully committing the retry, the client should execute the retry in the same session as the original attempt. The original session's lock priority increases with each consecutive abort, meaning that each attempt has a slightly better chance of success than the previous. Note that the lock priority is preserved per session (not per transaction). Lock priority is set by the first read or write in the first attempt of a read-write transaction. If the application starts a new session to retry the whole transaction, the transaction loses its original lock priority. Moreover, the lock priority is only preserved if the transaction fails with an `ABORTED` error. Under some circumstances (for example, many transactions attempting to modify the same row(s)), a transaction can abort many times in a short period before successfully committing. Thus, it is not a good idea to cap the number of retries a transaction can attempt; instead, it is better to limit the total amount of time spent retrying. Idle transactions: A transaction is considered idle if it has no outstanding reads or SQL queries and has not started a read or SQL query within the last 10 seconds. Idle transactions can be aborted by Cloud Spanner so that they don't hold on to locks indefinitely. If an idle transaction is aborted, the commit will fail with error `ABORTED`. If this behavior is undesirable, periodically executing a simple SQL query in the transaction (for example, `SELECT 1`) prevents the transaction from becoming idle. Snapshot read-only transactions: Snapshot read-only transactions provides a simpler method than locking read-write transactions for doing several consistent reads. However, this type of transaction does not support writes. Snapshot transactions do not take locks. Instead, they work by choosing a Cloud Spanner timestamp, then executing all reads at that timestamp. Since they do not acquire locks, they do not block concurrent read-write transactions. Unlike locking read-write transactions, snapshot read-only transactions never abort. They can fail if the chosen read timestamp is garbage collected; however, the default garbage collection policy is generous enough that most applications do not need to worry about this in practice. Snapshot read-only transactions do not need to call Commit or Rollback (and in fact are not permitted to do so). To execute a snapshot transaction, the client specifies a timestamp bound, which tells Cloud Spanner how to choose a read timestamp. The types of timestamp bound are: - Strong (the default). - Bounded staleness. - Exact staleness. If the Cloud Spanner database to be read is geographically distributed, stale read-only transactions can execute more quickly than strong or read-write transactions, because they are able to execute far from the leader replica. Each type of timestamp bound is discussed in detail below. Strong: Strong reads are guaranteed to see the effects of all transactions that have committed before the start of the read. Furthermore, all rows yielded by a single read are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Strong reads are not repeatable: two consecutive strong read-only transactions might return inconsistent results if there are concurrent writes. If consistency across reads is required, the reads should be executed within a transaction or at an exact read timestamp. Queries on change streams (see below for more details) must also specify the strong read timestamp bound. See TransactionOptions.ReadOnly.strong. Exact staleness: These timestamp bounds execute reads at a user-specified timestamp. Reads at a timestamp are guaranteed to see a consistent prefix of the global transaction history: they observe modifications done by all transactions with a commit timestamp less than or equal to the read timestamp, and observe none of the modifications done by transactions with a larger commit timestamp. They will block until all conflicting transactions that may be assigned commit timestamps <= the read timestamp have finished. The timestamp can either be expressed as an absolute Cloud Spanner commit timestamp or a staleness relative to the current time. These modes do not require a "negotiation phase" to pick a timestamp. As a result, they execute slightly faster than the equivalent boundedly stale concurrency modes. On the other hand, boundedly stale reads usually return fresher results. See TransactionOptions.ReadOnly.read_timestamp and TransactionOptions.ReadOnly.exact_staleness. Bounded staleness: Bounded staleness modes allow Cloud Spanner to pick the read timestamp, subject to a user-provided staleness bound. Cloud Spanner chooses the newest timestamp within the staleness bound that allows execution of the reads at the closest available replica without blocking. All rows yielded are consistent with each other -- if any part of the read observes a transaction, all parts of the read see the transaction. Boundedly stale reads are not repeatable: two stale reads, even if they use the same staleness bound, can execute at different timestamps and thus return inconsistent results. Boundedly stale reads execute in two phases: the first phase negotiates a timestamp among all replicas needed to serve the read. In the second phase, reads are executed at the negotiated timestamp. As a result of the two phase execution, bounded staleness reads are usually a little slower than comparable exact staleness reads. However, they are typically able to return fresher results, and are more likely to execute at the closest replica. Because the timestamp negotiation requires up-front knowledge of which rows will be read, it can only be used with single-use read-only transactions. See TransactionOptions.ReadOnly.max_staleness and TransactionOptions.ReadOnly.min_read_timestamp. Old read timestamps and garbage collection: Cloud Spanner continuously garbage collects deleted and overwritten data in the background to reclaim storage space. This process is known as "version GC". By default, version GC reclaims versions after they are one hour old. Because of this, Cloud Spanner cannot perform reads at read timestamps more than one hour in the past. This restriction also applies to in-progress reads and/or SQL queries whose timestamp become too old while executing. Reads and SQL queries with too-old read timestamps fail with the error `FAILED_PRECONDITION`. You can configure and extend the `VERSION_RETENTION_PERIOD` of a database up to a period as long as one week, which allows Cloud Spanner to perform reads up to one week in the past. Querying change Streams: A Change Stream is a schema object that can be configured to watch data changes on the entire database, a set of tables, or a set of columns in a database. When a change stream is created, Spanner automatically defines a corresponding SQL Table-Valued Function (TVF) that can be used to query the change records in the associated change stream using the ExecuteStreamingSql API. The name of the TVF for a change stream is generated from the name of the change stream: READ_. All queries on change stream TVFs must be executed using the ExecuteStreamingSql API with a single-use read-only transaction with a strong read-only timestamp_bound. The change stream TVF allows users to specify the start_timestamp and end_timestamp for the time range of interest. All change records within the retention period is accessible using the strong read-only timestamp_bound. All other TransactionOptions are invalid for change stream queries. In addition, if TransactionOptions.read_only.return_read_timestamp is set to true, a special value of 2^63 - 2 will be returned in the Transaction message that describes the transaction, instead of a valid read timestamp. This special value should be discarded and not used for any subsequent queries. Please see https://cloud.google.com/spanner/docs/change-streams for more details on how to query the change stream TVFs. Partitioned DML transactions: Partitioned DML transactions are used to execute DML statements with a different execution strategy that provides different, and often better, scalability properties for large, table-wide operations than DML in a ReadWrite transaction. Smaller scoped statements, such as an OLTP workload, should prefer using ReadWrite transactions. Partitioned DML partitions the keyspace and runs the DML statement on each partition in separate, internal transactions. These transactions commit automatically when complete, and run independently from one another. To reduce lock contention, this execution strategy only acquires read locks on rows that match the WHERE clause of the statement. Additionally, the smaller per-partition transactions hold locks for less time. That said, Partitioned DML is not a drop-in replacement for standard DML used in ReadWrite transactions. - The DML statement must be fully-partitionable. Specifically, the statement must be expressible as the union of many statements which each access only a single row of the table. - The statement is not applied atomically to all rows of the table. Rather, the statement is applied atomically to partitions of the table, in independent transactions. Secondary index rows are updated atomically with the base table rows. - Partitioned DML does not guarantee exactly-once execution semantics against a partition. The statement is applied at least once to each partition. It is strongly recommended that the DML statement should be idempotent to avoid unexpected results. For instance, it is potentially dangerous to run a statement such as `UPDATE table SET column = column + 1` as it could be run multiple times against some rows. - The partitions are committed automatically - there is no support for Commit or Rollback. If the call returns an error, or if the client issuing the ExecuteSql call dies, it is possible that some rows had the statement executed on them successfully. It is also possible that statement was never executed against other rows. - Partitioned DML transactions may only contain the execution of a single DML statement via ExecuteSql or ExecuteStreamingSql. - If any error is encountered during the execution of the partitioned DML operation (for instance, a UNIQUE INDEX violation, division by zero, or a value that cannot be stored due to schema constraints), then the operation is stopped at that point and an error is returned. It is possible that at this point, some partitions have been committed (or even committed multiple times), and other partitions have not been run at all. Given the above, Partitioned DML is good fit for large, database-wide, operations that are idempotent, such as deleting old rows from a very large table. # Begin a new transaction and execute this read or SQL query in it. The transaction ID of the new transaction is returned in ResultSetMetadata.transaction, which is a Transaction. "excludeTxnFromChangeStreams": True or False, # When `exclude_txn_from_change_streams` is set to `true`: * Modifications from this transaction will not be recorded in change streams with DDL option `allow_txn_exclusion=true` that are tracking columns modified by these transactions. * Modifications from this transaction will be recorded in change streams with DDL option `allow_txn_exclusion=false or not set` that are tracking columns modified by these transactions. When `exclude_txn_from_change_streams` is set to `false` or not set, Modifications from this transaction will be recorded in all change streams that are tracking columns modified by these transactions. `exclude_txn_from_change_streams` may only be specified for read-write or partitioned-dml transactions, otherwise the API will return an `INVALID_ARGUMENT` error. diff --git a/docs/dyn/spanner_v1.projects.instances.html b/docs/dyn/spanner_v1.projects.instances.html index 25f61acaa6a..baf6f2c1def 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 configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).

+

Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance configuration back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).

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.

@@ -159,7 +159,7 @@

Method Details

{ # The request for CreateInstance. "instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to create. The name may be omitted, but if specified must be `/instances/`. - "autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -187,8 +187,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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. - "processingUnits": 42, # The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "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. "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. }, @@ -258,7 +258,7 @@

Method Details

An object of the form: { # An isolated set of Cloud Spanner resources on which databases can be hosted. - "autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -286,8 +286,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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. - "processingUnits": 42, # The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "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. "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. }
@@ -357,7 +357,7 @@

Method Details

{ # The response for ListInstances. "instances": [ # The list of requested instances. { # An isolated set of Cloud Spanner resources on which databases can be hosted. - "autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -385,8 +385,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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. - "processingUnits": 42, # The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "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. "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 +414,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 configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).
+  
Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance configuration back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).
 
 Args:
   name: string, Required. The instance to move. Values are of the form `projects//instances/`. (required)
@@ -422,7 +422,7 @@ 

Method Details

The object takes the form of: { # The request for MoveInstance. - "targetConfig": "A String", # Required. The target instance config for the instance to move. Values are of the form `projects//instanceConfigs/`. + "targetConfig": "A String", # Required. The target instance configuration for the instance to move. Values are of the form `projects//instanceConfigs/`. } x__xgafv: string, V1 error format. @@ -466,7 +466,7 @@

Method Details

{ # The request for UpdateInstance. "fieldMask": "A String", # Required. A mask specifying which fields in Instance should be updated. The field mask must always be specified; this prevents any future fields in Instance from being erased accidentally by clients that do not know about them. "instance": { # An isolated set of Cloud Spanner resources on which databases can be hosted. # Required. The instance to update, which must always include the instance name. Otherwise, only fields mentioned in field_mask need be included. - "autoscalingConfig": { # Autoscaling config for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. + "autoscalingConfig": { # Autoscaling configuration for an instance. # Optional. The autoscaling configuration. Autoscaling is enabled if this field is set. When autoscaling is enabled, node_count and processing_units are treated as OUTPUT_ONLY fields and reflect the current compute capacity allocated to the instance. "autoscalingLimits": { # The autoscaling limits for the instance. Users can define the minimum and maximum compute capacity allocated to the instance, and the autoscaler will only scale within that range. Users can either use nodes or processing units to specify the limits, but should use the same unit to set both the min_limit and max_limit. # Required. Autoscaling limits for an instance. "maxNodes": 42, # Maximum number of nodes allocated to the instance. If set, this number should be greater than or equal to min_nodes. "maxProcessingUnits": 42, # Maximum number of processing units allocated to the instance. If set, this number should be multiples of 1000 and be greater than or equal to min_processing_units. @@ -494,8 +494,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 may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. - "processingUnits": 42, # The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units. + "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. "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/spanner_v1.projects.instances.instancePartitions.html b/docs/dyn/spanner_v1.projects.instances.instancePartitions.html index 43ba05f6d0a..5cb44455949 100644 --- a/docs/dyn/spanner_v1.projects.instances.instancePartitions.html +++ b/docs/dyn/spanner_v1.projects.instances.instancePartitions.html @@ -122,8 +122,8 @@

Method Details

"displayName": "A String", # Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. "etag": "A String", # Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly. "name": "A String", # Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. - "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. - "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. "referencingBackups": [ # Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. "A String", ], @@ -204,8 +204,8 @@

Method Details

"displayName": "A String", # Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. "etag": "A String", # Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly. "name": "A String", # Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. - "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. - "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. "referencingBackups": [ # Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. "A String", ], @@ -242,8 +242,8 @@

Method Details

"displayName": "A String", # Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. "etag": "A String", # Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly. "name": "A String", # Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. - "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. - "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. "referencingBackups": [ # Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. "A String", ], @@ -292,8 +292,8 @@

Method Details

"displayName": "A String", # Required. The descriptive name for this instance partition as it appears in UIs. Must be unique per project and between 4 and 30 characters in length. "etag": "A String", # Used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance partition from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance partition updates in order to avoid race conditions: An etag is returned in the response which contains instance partitions, and systems are expected to put that etag in the request to update instance partitions to ensure that their change will be applied to the same version of the instance partition. If no etag is provided in the call to update instance partition, then the existing instance partition is overwritten blindly. "name": "A String", # Required. A unique identifier for the instance partition. Values are of the form `projects//instances//instancePartitions/a-z*[a-z0-9]`. The final segment of the name must be between 2 and 64 characters in length. An instance partition's name cannot be changed after the instance partition is created. - "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. - "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "nodeCount": 42, # The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`. + "processingUnits": 42, # The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state. "referencingBackups": [ # Output only. The names of the backups that reference this instance partition. Referencing backups should share the parent instance. The existence of any referencing backup prevents the instance partition from being deleted. "A String", ], diff --git a/docs/dyn/sts_v1.v1.html b/docs/dyn/sts_v1.v1.html index e03c788bc2b..49ee357a4c3 100644 --- a/docs/dyn/sts_v1.v1.html +++ b/docs/dyn/sts_v1.v1.html @@ -113,6 +113,7 @@

Method Details

An object of the form: { # Response message for ExchangeToken. + "access_boundary_session_key": "A String", # The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`. "access_token": "A String", # An OAuth 2.0 security token, issued by Google, in response to the token exchange request. Tokens can vary in size, depending in part on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time. "expires_in": 42, # The amount of time, in seconds, between the time when the access token was issued and the time when the access token will expire. This field is absent when the `subject_token` in the request is a Google-issued, short-lived access token. In this case, the access token has the same expiration time as the `subject_token`. "issued_token_type": "A String", # The token type. Always matches the value of `requested_token_type` from the request. 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 251fec45225..90252c842f7 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html @@ -204,7 +204,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -345,7 +345,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -462,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. 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 e74babd2590..b81a6797723 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -204,7 +204,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -455,7 +455,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -682,7 +682,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. diff --git a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html index 6853eb5a93c..ee89aec584b 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -238,7 +238,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -292,7 +292,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -496,7 +496,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -593,7 +593,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -993,7 +993,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -1047,7 +1047,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1251,7 +1251,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1348,7 +1348,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1648,7 +1648,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -1702,7 +1702,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1906,7 +1906,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2003,7 +2003,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2307,7 +2307,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -2361,7 +2361,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2565,7 +2565,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2662,7 +2662,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. 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 c553b89e89a..7ab21ae760c 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html @@ -205,7 +205,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -257,7 +257,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -336,7 +336,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -453,7 +453,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -505,7 +505,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -584,7 +584,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -677,7 +677,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -729,7 +729,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -808,7 +808,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. 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 a25631f6e0b..e85ec57d634 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -205,7 +205,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -257,7 +257,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -449,7 +449,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -566,7 +566,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -618,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -810,7 +810,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -903,7 +903,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -955,7 +955,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1147,7 +1147,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html index 5a29e3f3386..753aa2c294b 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -239,7 +239,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -294,7 +294,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -346,7 +346,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -554,7 +554,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -606,7 +606,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -685,7 +685,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -758,7 +758,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -810,7 +810,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1002,7 +1002,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1060,7 +1060,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1321,7 +1321,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -1376,7 +1376,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1428,7 +1428,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1636,7 +1636,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1688,7 +1688,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1767,7 +1767,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1840,7 +1840,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -1892,7 +1892,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2084,7 +2084,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2142,7 +2142,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2303,7 +2303,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -2358,7 +2358,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2410,7 +2410,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2618,7 +2618,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2670,7 +2670,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2749,7 +2749,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2822,7 +2822,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -2874,7 +2874,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3066,7 +3066,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3124,7 +3124,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3289,7 +3289,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # Optional. A list of network tags to associate with the VM. @@ -3344,7 +3344,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3396,7 +3396,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3604,7 +3604,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3656,7 +3656,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3735,7 +3735,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3808,7 +3808,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -3860,7 +3860,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -4052,7 +4052,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. @@ -4110,7 +4110,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. - "subnetwork": "A String", # The subnetwork to connect the NIC to. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], "networkTags": [ # A list of network tags to associate with the VM. diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html index 8c77eba924f..39b9434e4ee 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.html @@ -135,8 +135,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Whether Workstations endpoint is private. + "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -144,13 +144,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Optional. Configuration for private workstation cluster. - "allowedProjects": [ + "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. + "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. "A String", ], - "clusterHostname": "A String", - "enablePrivateEndpoint": True or False, - "serviceAttachmentUri": "A String", + "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. + "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -261,8 +261,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Whether Workstations endpoint is private. + "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -270,13 +270,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Optional. Configuration for private workstation cluster. - "allowedProjects": [ + "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. + "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. "A String", ], - "clusterHostname": "A String", - "enablePrivateEndpoint": True or False, - "serviceAttachmentUri": "A String", + "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. + "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -327,8 +327,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Whether Workstations endpoint is private. + "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -336,13 +336,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Optional. Configuration for private workstation cluster. - "allowedProjects": [ + "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. + "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. "A String", ], - "clusterHostname": "A String", - "enablePrivateEndpoint": True or False, - "serviceAttachmentUri": "A String", + "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. + "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. @@ -396,8 +396,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Whether Workstations endpoint is private. + "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -405,13 +405,13 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Optional. Configuration for private workstation cluster. - "allowedProjects": [ + "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. + "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. "A String", ], - "clusterHostname": "A String", - "enablePrivateEndpoint": True or False, - "serviceAttachmentUri": "A String", + "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. + "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index 8b80260dd8f..61da7cce064 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -131,6 +131,12 @@

Method Details

The object takes the form of: { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + "first": 42, # Required. Starting port number for the current range of ports. + "last": 42, # Required. Ending port number for the current range of ports. + }, + ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, @@ -332,6 +338,12 @@

Method Details

An object of the form: { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + "first": 42, # Required. Starting port number for the current range of ports. + "last": 42, # Required. Ending port number for the current range of ports. + }, + ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, @@ -521,6 +533,12 @@

Method Details

], "workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + "first": 42, # Required. Starting port number for the current range of ports. + "last": 42, # Required. Ending port number for the current range of ports. + }, + ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, @@ -664,6 +682,12 @@

Method Details

], "workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + "first": 42, # Required. Starting port number for the current range of ports. + "last": 42, # Required. Ending port number for the current range of ports. + }, + ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, @@ -822,6 +846,12 @@

Method Details

The object takes the form of: { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. + "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + "first": 42, # Required. Starting port number for the current range of ports. + "last": 42, # Required. Ending port number for the current range of ports. + }, + ], "annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html index b3805f1a36f..aaecfbe4439 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.html @@ -135,8 +135,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Whether Workstations endpoint is private. + "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -144,15 +144,17 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Optional. Configuration for private workstation cluster. - "allowedProjects": [ + "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. + "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. "A String", ], - "clusterHostname": "A String", - "enablePrivateEndpoint": True or False, - "serviceAttachmentUri": "A String", + "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. + "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. @@ -261,8 +263,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Whether Workstations endpoint is private. + "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -270,15 +272,17 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Optional. Configuration for private workstation cluster. - "allowedProjects": [ + "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. + "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. "A String", ], - "clusterHostname": "A String", - "enablePrivateEndpoint": True or False, - "serviceAttachmentUri": "A String", + "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. + "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. @@ -327,8 +331,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Whether Workstations endpoint is private. + "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -336,15 +340,17 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Optional. Configuration for private workstation cluster. - "allowedProjects": [ + "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. + "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. "A String", ], - "clusterHostname": "A String", - "enablePrivateEndpoint": True or False, - "serviceAttachmentUri": "A String", + "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. + "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. @@ -396,8 +402,8 @@

Method Details

"degraded": True or False, # Output only. Whether this workstation cluster is in degraded mode, in which case it may require user action to restore full functionality. Details can be found in conditions. "deleteTime": "A String", # Output only. Time when this workstation cluster was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation cluster. - "domainConfig": { # Configuration options for private workstation clusters. # Optional. Configuration options for a custom domain. - "domain": "A String", # Immutable. Whether Workstations endpoint is private. + "domainConfig": { # Configuration options for a custom domain. # Optional. Configuration options for a custom domain. + "domain": "A String", # Immutable. Domain used by Workstations for HTTP ingress. }, "etag": "A String", # Optional. Checksum computed by the server. May be sent on update and delete requests to make sure that the client has an up-to-date value before proceeding. "labels": { # Optional. [Labels](https://cloud.google.com/workstations/docs/label-resources) that are applied to the workstation cluster and that are also propagated to the underlying Compute Engine resources. @@ -405,15 +411,17 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation cluster. "network": "A String", # Immutable. Name of the Compute Engine network in which instances associated with this workstation cluster will be created. - "privateClusterConfig": { # Optional. Configuration for private workstation cluster. - "allowedProjects": [ + "privateClusterConfig": { # Configuration options for private workstation clusters. # Optional. Configuration for private workstation cluster. + "allowedProjects": [ # Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed. "A String", ], - "clusterHostname": "A String", - "enablePrivateEndpoint": True or False, - "serviceAttachmentUri": "A String", + "clusterHostname": "A String", # Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment. + "enablePrivateEndpoint": True or False, # Immutable. Whether Workstations endpoint is private. + "serviceAttachmentUri": "A String", # Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services). }, "reconciling": True or False, # Output only. Indicates whether this workstation cluster is currently being updated to match its intended state. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "subnetwork": "A String", # Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation cluster. "updateTime": "A String", # Output only. Time when this workstation cluster was most recently updated. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index 5dba36444b3..4039768cf8d 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -132,7 +132,7 @@

Method Details

{ # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -268,6 +268,8 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. } @@ -357,7 +359,7 @@

Method Details

{ # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -493,6 +495,8 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }
@@ -570,7 +574,7 @@

Method Details

"workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -706,6 +710,8 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }, @@ -737,7 +743,7 @@

Method Details

"workstationConfigs": [ # The requested configs. { # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -873,6 +879,8 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. }, @@ -919,7 +927,7 @@

Method Details

{ # A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers. "allowedPorts": [ # Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535. - { # A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. + { # A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same. "first": 42, # Required. Starting port number for the current range of ports. "last": 42, # Required. Ending port number for the current range of ports. }, @@ -1055,6 +1063,8 @@

Method Details

"A String", ], "runningTimeout": "A String", # Optional. Number of seconds that a workstation can run until it is automatically shut down. We recommend that workstations be shut down daily to reduce costs and so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field shuts down VMs after the specified time, regardless of whether or not the VMs are idle. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. "updateTime": "A String", # Output only. Time when this workstation configuration was most recently updated. } diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html index 5769e5036d9..226d08d664a 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -152,6 +152,8 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. @@ -288,6 +290,8 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. @@ -384,6 +388,8 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. @@ -434,6 +440,8 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. @@ -499,6 +507,8 @@

Method Details

}, "name": "A String", # Identifier. Full name of this workstation. "reconciling": True or False, # Output only. Indicates whether this workstation is currently being updated to match its intended state. + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "sourceWorkstation": "A String", # Optional. The source workstation from which this workstations persistent directories were cloned on creation. "startTime": "A String", # Output only. Time when this workstation was most recently successfully started, regardless of the workstation's initial state. "state": "A String", # Output only. Current state of the workstation. diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 8a974b5ed6b..9c72c3a8fc6 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1290,7 +1290,7 @@ } } }, -"revision": "20240623", +"revision": "20240708", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1332,6 +1332,7 @@ "properties": { "etag": { "description": "Output only. An opaque identifier for the current version of the `AccessPolicy`. This will always be a strongly validated etag, meaning that two Access Policies will be identical if and only if their etags are identical. Clients should not expect this to be in any specific format.", +"readOnly": true, "type": "string" }, "name": { @@ -1741,7 +1742,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "items": { "$ref": "EgressSource" }, @@ -1770,7 +1771,7 @@ "id": "EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", "type": "string" } }, @@ -2548,7 +2549,7 @@ "properties": { "vpcSubnetwork": { "$ref": "VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network." +"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/admin.directory_v1.json b/googleapiclient/discovery_cache/documents/admin.directory_v1.json index 58ee6d6a441..b4dad8e4008 100644 --- a/googleapiclient/discovery_cache/documents/admin.directory_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.directory_v1.json @@ -3931,7 +3931,7 @@ ] }, "insert": { -"description": "Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case.", +"description": "Creates a user. Mutate calls immediately following user creation might sometimes fail as the user isn't fully created due to propagation delay in our backends. Check the error details for the \"User creation is not complete\" message to see if this is the case. Retrying the calls after some time can help in this case. If `resolveConflictAccount` is set to `true`, a `202` response code means that a conflicting unmanaged account exists and was invited to join the organization. A `409` response code means that a conflicting account exists so the user wasn't created based on the [handling unmanaged user accounts](https://support.google.com/a/answer/11112794) option selected.", "flatPath": "admin/directory/v1/users", "httpMethod": "POST", "id": "directory.users.insert", @@ -4671,7 +4671,7 @@ } } }, -"revision": "20240618", +"revision": "20240709", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { diff --git a/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json b/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json new file mode 100644 index 00000000000..4d7a453fe27 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/adsenseplatform.v1alpha.json @@ -0,0 +1,721 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/adsense": { +"description": "View and manage your AdSense data" +}, +"https://www.googleapis.com/auth/adsense.readonly": { +"description": "View your AdSense data" +} +} +} +}, +"basePath": "", +"baseUrl": "https://adsenseplatform.googleapis.com/", +"batchPath": "batch", +"canonicalName": "AdSense Platform", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/adsense/platforms/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "adsenseplatform:v1alpha", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://adsenseplatform.mtls.googleapis.com/", +"name": "adsenseplatform", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"platforms": { +"resources": { +"accounts": { +"methods": { +"close": { +"description": "Closes a sub-account.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}:close", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.close", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Account to close. Format: platforms/{platform}/accounts/{account_id}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:close", +"request": { +"$ref": "CloseAccountRequest" +}, +"response": { +"$ref": "CloseAccountResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"create": { +"description": "Creates a sub-account.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Platform to create an account for. Format: platforms/{platform}", +"location": "path", +"pattern": "^platforms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/accounts", +"request": { +"$ref": "Account" +}, +"response": { +"$ref": "Account" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"get": { +"description": "Gets information about the selected sub-account.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Account" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"list": { +"description": "Lists a partial view of sub-accounts for a specific parent account.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Platform who parents the accounts. Format: platforms/{platform}", +"location": "path", +"pattern": "^platforms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/accounts", +"response": { +"$ref": "ListAccountsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"lookup": { +"description": "Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts:lookup", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.lookup", +"parameterOrder": [ +"parent" +], +"parameters": { +"creationRequestId": { +"description": "Optional. The creation_request_id provided when calling createAccount.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Platform who parents the account. Format: platforms/{platform}", +"location": "path", +"pattern": "^platforms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/accounts:lookup", +"response": { +"$ref": "LookupAccountResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +} +}, +"resources": { +"events": { +"methods": { +"create": { +"description": "Creates an account event.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/events", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.events.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Account to log events about. Format: platforms/{platform}/accounts/{account}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/events", +"request": { +"$ref": "Event" +}, +"response": { +"$ref": "Event" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +} +} +}, +"sites": { +"methods": { +"create": { +"description": "Creates a site for a specified account.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.sites.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Account to create site. Format: platforms/{platform}/accounts/{account_id}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/sites", +"request": { +"$ref": "Site" +}, +"response": { +"$ref": "Site" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"delete": { +"description": "Deletes a site from a specified account.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", +"httpMethod": "DELETE", +"id": "adsenseplatform.platforms.accounts.sites.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"get": { +"description": "Gets a site from a specified sub-account.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.sites.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Site" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"list": { +"description": "Lists sites for a specific account.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.sites.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/sites", +"response": { +"$ref": "ListSitesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"requestReview": { +"description": "Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.", +"flatPath": "v1alpha/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}:requestReview", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.sites.requestReview", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:requestReview", +"response": { +"$ref": "RequestSiteReviewResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +} +} +} +} +} +} +} +}, +"revision": "20240710", +"rootUrl": "https://adsenseplatform.googleapis.com/", +"schemas": { +"Account": { +"description": "Representation of an Account.", +"id": "Account", +"properties": { +"createTime": { +"description": "Output only. Creation time of the account.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creationRequestId": { +"description": "Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.", +"type": "string" +}, +"displayName": { +"description": "Display name of this account.", +"type": "string" +}, +"name": { +"description": "Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+", +"readOnly": true, +"type": "string" +}, +"regionCode": { +"description": "Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.", +"type": "string" +}, +"state": { +"description": "Output only. Approval state of the account.", +"enum": [ +"STATE_UNSPECIFIED", +"UNCHECKED", +"APPROVED", +"DISAPPROVED" +], +"enumDescriptions": [ +"Unspecified.", +"Unchecked.", +"The account is ready to serve ads.", +"The account has been blocked from serving ads." +], +"readOnly": true, +"type": "string" +}, +"timeZone": { +"$ref": "TimeZone", +"description": "Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts." +} +}, +"type": "object" +}, +"Address": { +"description": "Address data.", +"id": "Address", +"properties": { +"address1": { +"description": "First line of address. Max length 64 bytes or 30 characters.", +"type": "string" +}, +"address2": { +"description": "Second line of address. Max length 64 bytes or 30 characters.", +"type": "string" +}, +"city": { +"description": "City. Max length 60 bytes or 30 characters.", +"type": "string" +}, +"company": { +"description": "Name of the company. Max length 255 bytes or 34 characters.", +"type": "string" +}, +"contact": { +"description": "Contact name of the company. Max length 128 bytes or 34 characters.", +"type": "string" +}, +"fax": { +"description": "Fax number with international code (i.e. +441234567890).", +"type": "string" +}, +"phone": { +"description": "Phone number with international code (i.e. +441234567890).", +"type": "string" +}, +"regionCode": { +"description": "Country/Region code. The region is specified as a CLDR region code (e.g. \"US\", \"FR\").", +"type": "string" +}, +"state": { +"description": "State. Max length 60 bytes or 30 characters.", +"type": "string" +}, +"zip": { +"description": "Zip/post code. Max length 10 bytes or 10 characters.", +"type": "string" +} +}, +"type": "object" +}, +"CloseAccountRequest": { +"description": "Request definition for the account close rpc.", +"id": "CloseAccountRequest", +"properties": {}, +"type": "object" +}, +"CloseAccountResponse": { +"description": "Response definition for the account close rpc.", +"id": "CloseAccountResponse", +"properties": {}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"Event": { +"description": "A platform sub-account event to record spam signals.", +"id": "Event", +"properties": { +"eventInfo": { +"$ref": "EventInfo", +"description": "Required. Information associated with the event." +}, +"eventTime": { +"description": "Required. Event timestamp.", +"format": "google-datetime", +"type": "string" +}, +"eventType": { +"description": "Required. Event type.", +"enum": [ +"EVENT_TYPE_UNSPECIFIED", +"LOG_IN_VIA_PLATFORM", +"SIGN_UP_VIA_PLATFORM" +], +"enumDescriptions": [ +"Do not use. You must set an event type explicitly.", +"Log in via platform.", +"Sign up via platform." +], +"type": "string" +} +}, +"type": "object" +}, +"EventInfo": { +"description": "Private information for partner recorded events (PII).", +"id": "EventInfo", +"properties": { +"billingAddress": { +"$ref": "Address", +"description": "The billing address of the publisher associated with this event, if available." +}, +"email": { +"description": "Required. The email address that is associated with the publisher when performing the event.", +"type": "string" +} +}, +"type": "object" +}, +"ListAccountsResponse": { +"description": "Response definition for the list accounts rpc.", +"id": "ListAccountsResponse", +"properties": { +"accounts": { +"description": "The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.", +"items": { +"$ref": "Account" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", +"type": "string" +} +}, +"type": "object" +}, +"ListSitesResponse": { +"description": "Response definition for the site list rpc.", +"id": "ListSitesResponse", +"properties": { +"nextPageToken": { +"description": "Continuation token used to page through sites. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", +"type": "string" +}, +"sites": { +"description": "The sites returned in this list response.", +"items": { +"$ref": "Site" +}, +"type": "array" +} +}, +"type": "object" +}, +"LookupAccountResponse": { +"description": "Response definition for the lookup account rpc.", +"id": "LookupAccountResponse", +"properties": { +"name": { +"description": "The name of the Account Format: platforms/{platform}/accounts/{account_id}", +"type": "string" +} +}, +"type": "object" +}, +"RequestSiteReviewResponse": { +"description": "Response definition for the site request review rpc.", +"id": "RequestSiteReviewResponse", +"properties": {}, +"type": "object" +}, +"Site": { +"description": "Representation of a Site.", +"id": "Site", +"properties": { +"domain": { +"description": "Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.", +"type": "string" +}, +"name": { +"description": "Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. State of a site.", +"enum": [ +"STATE_UNSPECIFIED", +"REQUIRES_REVIEW", +"GETTING_READY", +"READY", +"NEEDS_ATTENTION" +], +"enumDescriptions": [ +"State unspecified.", +"Either: - The site hasn't been checked yet. - The site is inactive and needs another review before it can show ads again. Learn how to [request a review for an inactive site](https://support.google.com/adsense/answer/9393996).", +"Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks.", +"The site is ready to show ads. Learn how to [set up ads on the site](https://support.google.com/adsense/answer/7037624).", +"Publisher needs to fix some issues before the site is ready to show ads. Learn what to do [if a new site isn't ready](https://support.google.com/adsense/answer/9061852)." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"TimeZone": { +"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", +"id": "TimeZone", +"properties": { +"id": { +"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", +"type": "string" +}, +"version": { +"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "AdSense Platform API", +"version": "v1alpha", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index a597576b035..8867fb7591e 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -16810,7 +16810,7 @@ } } }, -"revision": "20240703", +"revision": "20240709", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 2fbc3dbb0ff..6e14dd34949 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -20447,7 +20447,7 @@ } } }, -"revision": "20240703", +"revision": "20240709", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 097329a18a6..737b0921ed2 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -1489,7 +1489,7 @@ } } }, -"revision": "20240627", +"revision": "20240703", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1578,19 +1578,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15" +"POSTGRES_15", +"POSTGRES_16" ], "enumDeprecated": [ false, true, false, +false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", -"The database version is Postgres 15." +"The database version is Postgres 15.", +"The database version is Postgres 16." ], "readOnly": true, "type": "string" @@ -1839,19 +1842,22 @@ false "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15" +"POSTGRES_15", +"POSTGRES_16" ], "enumDeprecated": [ false, true, false, +false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", -"The database version is Postgres 15." +"The database version is Postgres 15.", +"The database version is Postgres 16." ], "type": "string" }, @@ -4654,19 +4660,22 @@ false "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15" +"POSTGRES_15", +"POSTGRES_16" ], "enumDeprecated": [ false, true, false, +false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", -"The database version is Postgres 15." +"The database version is Postgres 15.", +"The database version is Postgres 16." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index 0722f1a31ac..075b0bfcc0b 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -1486,7 +1486,7 @@ } } }, -"revision": "20240627", +"revision": "20240703", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -1575,19 +1575,22 @@ "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15" +"POSTGRES_15", +"POSTGRES_16" ], "enumDeprecated": [ false, true, false, +false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", -"The database version is Postgres 15." +"The database version is Postgres 15.", +"The database version is Postgres 16." ], "readOnly": true, "type": "string" @@ -1825,19 +1828,22 @@ false "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15" +"POSTGRES_15", +"POSTGRES_16" ], "enumDeprecated": [ false, true, false, +false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", -"The database version is Postgres 15." +"The database version is Postgres 15.", +"The database version is Postgres 16." ], "type": "string" }, @@ -4630,19 +4636,22 @@ false "DATABASE_VERSION_UNSPECIFIED", "POSTGRES_13", "POSTGRES_14", -"POSTGRES_15" +"POSTGRES_15", +"POSTGRES_16" ], "enumDeprecated": [ false, true, false, +false, false ], "enumDescriptions": [ "This is an unknown database version.", "DEPRECATED - The database version is Postgres 13.", "The database version is Postgres 14.", -"The database version is Postgres 15." +"The database version is Postgres 15.", +"The database version is Postgres 16." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json index f47d55e07e9..f9b2fec593d 100644 --- a/googleapiclient/discovery_cache/documents/androidpublisher.v3.json +++ b/googleapiclient/discovery_cache/documents/androidpublisher.v3.json @@ -277,36 +277,6 @@ "https://www.googleapis.com/auth/androidpublisher" ] }, -"appRecoveries": { -"description": "List all app recovery action resources associated with a particular package name and app version.", -"flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", -"httpMethod": "POST", -"id": "androidpublisher.apprecovery.appRecoveries", -"parameterOrder": [ -"packageName" -], -"parameters": { -"packageName": { -"description": "Required. Package name of the app for which list of recovery actions is requested.", -"location": "path", -"required": true, -"type": "string" -}, -"versionCode": { -"description": "Required. Version code targeted by the list of recovery actions.", -"format": "int64", -"location": "query", -"type": "string" -} -}, -"path": "androidpublisher/v3/applications/{packageName}/appRecoveries", -"response": { -"$ref": "ListAppRecoveriesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/androidpublisher" -] -}, "cancel": { "description": "Cancel an already executing app recovery action. Note that this action changes status of the recovery action to CANCELED.", "flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries/{appRecoveryId}:cancel", @@ -403,6 +373,36 @@ "scopes": [ "https://www.googleapis.com/auth/androidpublisher" ] +}, +"list": { +"description": "List all app recovery action resources associated with a particular package name and app version.", +"flatPath": "androidpublisher/v3/applications/{packageName}/appRecoveries", +"httpMethod": "GET", +"id": "androidpublisher.apprecovery.list", +"parameterOrder": [ +"packageName" +], +"parameters": { +"packageName": { +"description": "Required. Package name of the app for which list of recovery actions is requested.", +"location": "path", +"required": true, +"type": "string" +}, +"versionCode": { +"description": "Required. Version code targeted by the list of recovery actions.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "androidpublisher/v3/applications/{packageName}/appRecoveries", +"response": { +"$ref": "ListAppRecoveriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/androidpublisher" +] } } }, @@ -4731,7 +4731,7 @@ } } }, -"revision": "20240627", +"revision": "20240709", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -6299,7 +6299,7 @@ "readOnly": true }, "transactionProgramCode": { -"description": "Optional. The transaction program code, used to help determine service fee for apps partcipating in special partner programs. This field can not be used for external offers transactions. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing external transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field.", +"description": "Optional. The transaction program code, used to help determine service fee for eligible apps participating in partner programs. Developers participating in the Play Media Experience Program (https://play.google.com/console/about/programs/mediaprogram/) must provide the program code when reporting alternative billing transactions. If you are an eligible developer, please contact your BDM for more information on how to set this field. Note: this field can not be used for external offers transactions.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index b92735bb985..e998ab9e8e0 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -2013,7 +2013,7 @@ } } }, -"revision": "20240704", +"revision": "20240708", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -3355,6 +3355,12 @@ false }, "type": "object" }, +"PromoteArtifactMetadata": { +"description": "The metadata for promote artifact long running operation.", +"id": "PromoteArtifactMetadata", +"properties": {}, +"type": "object" +}, "PythonPackage": { "description": "PythonPackage represents a python artifact.", "id": "PythonPackage", @@ -3735,7 +3741,7 @@ false "type": "string" }, "packageId": { -"description": "The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` must start with a letter, end with a letter or number, only contain letters, numbers, hyphens and periods i.e. [a-z0-9-.], and cannot exceed 256 characters.", +"description": "The ID of the package of the generic artifact. If the package does not exist, a new package will be created. The `package_id` should start and end with a letter or number, only contain letters, numbers, hyphens, underscores, and periods, and not exceed 256 characters.", "type": "string" }, "versionId": { diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 0d7ad8c52fc..9cccf6b3651 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240627", +"revision": "20240703", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -683,25 +683,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", -"REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", -"REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -712,25 +706,19 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", -"Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", -"Assured Workloads For EU Regions and Support controls", -"Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", -"Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", -"Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"Assured Workloads for Japan Regions", "KSA R5 Controls.", "Assured Workloads for Regional Controls" ], @@ -1178,25 +1166,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", -"REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", -"REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -1207,25 +1189,19 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", -"Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", -"Assured Workloads For EU Regions and Support controls", -"Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", -"Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", -"Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"Assured Workloads for Japan Regions", "KSA R5 Controls.", "Assured Workloads for Regional Controls" ], diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index 7df193da679..36f40905192 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -588,7 +588,7 @@ } } }, -"revision": "20240627", +"revision": "20240703", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -680,25 +680,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", -"REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", -"REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -709,25 +703,19 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", -"Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", -"Assured Workloads For EU Regions and Support controls", -"Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", -"Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", -"Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"Assured Workloads for Japan Regions", "KSA R5 Controls.", "Assured Workloads for Regional Controls" ], @@ -1173,25 +1161,19 @@ "FEDRAMP_HIGH", "FEDRAMP_MODERATE", "US_REGIONAL_ACCESS", -"REGIONAL_CONTROLS_PREMIUM_US", "HIPAA", "HITRUST", "EU_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_EU", "CA_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_CA", "ITAR", "AU_REGIONS_AND_US_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_AU", "ASSURED_WORKLOADS_FOR_PARTNERS", "ISR_REGIONS", -"REGIONAL_CONTROLS_PREMIUM_ISR", "ISR_REGIONS_AND_SUPPORT", "CA_PROTECTED_B", "IL5", "IL2", "JP_REGIONS_AND_SUPPORT", -"REGIONAL_CONTROLS_PREMIUM_JP", "KSA_REGIONS_AND_SUPPORT_WITH_SOVEREIGNTY_CONTROLS", "REGIONAL_CONTROLS" ], @@ -1202,25 +1184,19 @@ "FedRAMP High data protection controls", "FedRAMP Moderate data protection controls", "Assured Workloads For US Regions data protection controls", -"Assured Workloads For US Regions data protection controls", "Health Insurance Portability and Accountability Act controls", "Health Information Trust Alliance controls", "Assured Workloads For EU Regions and Support controls", -"Assured Workloads For EU Regions and Support controls", -"Assured Workloads For Canada Regions and Support controls", "Assured Workloads For Canada Regions and Support controls", "International Traffic in Arms Regulations", "Assured Workloads for Australia Regions and Support controls", -"Assured Workloads for Australia Regions and Support controls", "Assured Workloads for Partners;", "Assured Workloads for Israel Regions", -"Assured Workloads for Israel", "Assured Workloads for Israel Regions", "Assured Workloads for Canada Protected B regime", "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"Assured Workloads for Japan Regions", "KSA R5 Controls.", "Assured Workloads for Regional Controls" ], diff --git a/googleapiclient/discovery_cache/documents/batch.v1.json b/googleapiclient/discovery_cache/documents/batch.v1.json index 8939ac983f7..e84991d1f4b 100644 --- a/googleapiclient/discovery_cache/documents/batch.v1.json +++ b/googleapiclient/discovery_cache/documents/batch.v1.json @@ -561,7 +561,7 @@ } } }, -"revision": "20240620", +"revision": "20240703", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -2010,7 +2010,7 @@ "type": "object" }, "StatusEvent": { -"description": "Status event", +"description": "Status event.", "id": "StatusEvent", "properties": { "description": { @@ -2024,10 +2024,10 @@ }, "taskExecution": { "$ref": "TaskExecution", -"description": "Task Execution" +"description": "Task Execution. This field is only defined for task-level status events where the task fails." }, "taskState": { -"description": "Task State", +"description": "Task State. This field is only defined for task-level status events.", "enum": [ "STATE_UNSPECIFIED", "PENDING", @@ -2223,11 +2223,11 @@ "type": "object" }, "TaskStatus": { -"description": "Status of a task", +"description": "Status of a task.", "id": "TaskStatus", "properties": { "state": { -"description": "Task state", +"description": "Task state.", "enum": [ "STATE_UNSPECIFIED", "PENDING", diff --git a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json index 801bb286084..f8fb052d3fb 100644 --- a/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/beyondcorp.v1alpha.json @@ -1028,7 +1028,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", +"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -3534,7 +3534,7 @@ ], "parameters": { "filter": { -"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", +"description": "Optional. Filter expression to restrict the insights returned. Supported filter fields: * `type` * `category` * `subCategory` Examples: * \"category = application AND type = count\" * \"category = application AND subCategory = iap\" * \"type = status\" Allowed values: * type: [count, latency, status, list] * category: [application, device, request, security] * subCategory: [iap, caa, webprotect] NOTE: Only equality based comparison is allowed. Only `AND` conjunction is allowed. NOTE: The 'AND' in the filter field needs to be in capital letters only. NOTE: Just filtering on `subCategory` is not allowed. It should be passed in with the parent `category` too. (These expressions are based on the filter language described at https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -4080,7 +4080,7 @@ } } }, -"revision": "20240619", +"revision": "20240626", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index eb2d1dbe1f3..9b3ab346278 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1935,7 +1935,7 @@ } } }, -"revision": "20240623", +"revision": "20240629", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -2605,7 +2605,7 @@ "id": "BigtableColumnFamily", "properties": { "columns": { -"description": "Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through `.Column` field.", +"description": "Optional. Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as `.`. Other columns can be accessed as a list through the `.Column` field.", "items": { "$ref": "BigtableColumn" }, @@ -3121,7 +3121,7 @@ "type": "string" }, "role": { -"description": "An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * OWNER <=> roles/bigquery.dataOwner * WRITER <=> roles/bigquery.dataEditor * READER <=> roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", +"description": "An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: * `OWNER`: `roles/bigquery.dataOwner` * `WRITER`: `roles/bigquery.dataEditor` * `READER`: `roles/bigquery.dataViewer` This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to \"roles/bigquery.dataOwner\", it will be returned back as \"OWNER\".", "type": "string" }, "routine": { @@ -3129,7 +3129,7 @@ "description": "[Pick one] A routine from a different dataset to grant access to. Queries executed against that routine will have read access to views/tables/routines in this dataset. Only UDF is supported for now. The role field is not required when this field is set. If that routine is updated by any user, access to the routine needs to be granted again via an update operation." }, "specialGroup": { -"description": "[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", +"description": "[Pick one] A special group to grant access to. Possible values include: * projectOwners: Owners of the enclosing project. * projectReaders: Readers of the enclosing project. * projectWriters: Writers of the enclosing project. * allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.", "type": "string" }, "userByEmail": { @@ -6415,7 +6415,7 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", -"Model to capture the manual preprocessing logic in the transform clause." +"Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." ], "readOnly": true, "type": "string" @@ -6586,7 +6586,7 @@ "Random forest classifier model.", "An imported TensorFlow Lite model.", "An imported ONNX model.", -"Model to capture the manual preprocessing logic in the transform clause." +"Model to capture the columns and logic in the TRANSFORM clause along with statistics useful for ML analytic functions." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index 75c57023925..8efb4643508 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -1763,7 +1763,7 @@ } } }, -"revision": "20240621", +"revision": "20240705", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { @@ -2591,7 +2591,7 @@ "type": "string" }, "reminders": { -"description": "Information about the event's reminders for the authenticated user.", +"description": "Information about the event's reminders for the authenticated user. Note that changing reminders does not also change the updated property of the enclosing event.", "properties": { "overrides": { "description": "If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5.", @@ -2651,7 +2651,7 @@ "type": "string" }, "updated": { -"description": "Last modification time of the event (as a RFC3339 timestamp). Read-only.", +"description": "Last modification time of the main event data (as a RFC3339 timestamp). Updating event reminders will not cause this to change. Read-only.", "format": "date-time", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 23b06637db9..4c5d519d4ae 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -433,7 +433,7 @@ "type": "string" }, "updateMask": { -"description": "Required. The updated field paths, comma separated if there are multiple. Currently supported field paths: - `display_name` (Only supports changing the display name of a space with the `SPACE` type, or when also including the `space_type` mask to change a `GROUP_CHAT` space type to `SPACE`. Trying to update the display name of a `GROUP_CHAT` or a `DIRECT_MESSAGE` space results in an invalid argument error. If you receive the error message `ALREADY_EXISTS` when updating the `displayName`, try a different `displayName`. An existing space within the Google Workspace organization might already use this display name.) - `space_type` (Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error). `space_type` is not supported with admin access. - `space_details` - `space_history_state` (Supports [turning history on or off for the space](https://support.google.com/chat/answer/7664687) if [the organization allows users to change their history setting](https://support.google.com/a/answer/7664184). Warning: mutually exclusive with all other field paths.) `space_history_state` is not supported with admin access. - `access_settings.audience` (Supports changing the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in space. If no audience is specified in the access setting, the space's access setting is updated to private. Warning: mutually exclusive with all other field paths.) `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", +"description": "Required. The updated field paths, comma separated if there are multiple. You can update the following fields for a space: - `space_details` - `display_name`: Only supports updating the display name for spaces where `spaceType` field is `SPACE`. If you receive the error message `ALREADY_EXISTS`, try a different value. An existing space within the Google Workspace organization might already use this display name. - `space_type`: Only supports changing a `GROUP_CHAT` space type to `SPACE`. Include `display_name` together with `space_type` in the update mask and ensure that the specified space has a non-empty display name and the `SPACE` space type. Including the `space_type` mask and the `SPACE` type in the specified space when updating the display name is optional if the existing space already has the `SPACE` type. Trying to update the space type in other ways results in an invalid argument error. `space_type` is not supported with admin access. - `space_history_state`: Updates [space history settings](https://support.google.com/chat/answer/7664687) by turning history on or off for the space. Only supported if history settings are enabled for the Google Workspace organization. To update the space history state, you must omit all other field masks in your request. `space_history_state` is not supported with admin access. - `access_settings.audience`: Updates the [access setting](https://support.google.com/chat/answer/11971020) of who can discover the space, join the space, and preview the messages in named space where `spaceType` field is `SPACE`. If the existing space has a target audience, you can remove the audience and restrict space access by omitting a value for this field mask. To update access settings for a space, the authenticating user must be a space manager and omit all other field masks in your request. You can't update this field if the space is in [import mode](https://developers.google.com/workspace/chat/import-data-overview). To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience). `access_settings.audience` is not supported with admin access. - Developer Preview: Supports changing the [permission settings](https://support.google.com/chat/answer/13340792) of a space, supported field paths include: `permission_settings.manage_members_and_groups`, `permission_settings.modify_space_details`, `permission_settings.toggle_history`, `permission_settings.use_at_mention_all`, `permission_settings.manage_apps`, `permission_settings.manage_webhooks`, `permission_settings.reply_messages` (Warning: mutually exclusive with all other non-permission settings field paths). `permission_settings` is not supported with admin access.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1241,7 +1241,7 @@ } } }, -"revision": "20240701", +"revision": "20240709", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { @@ -1257,14 +1257,14 @@ ], "enumDescriptions": [ "Access state is unknown or not supported in this API.", -"Space is discoverable by added or invited members or groups.", -"Space is discoverable by the selected [target audience](https://support.google.com/a/answer/9934697), as well as added or invited members or groups." +"Only users or Google Groups that have been individually added or invited by other users or Google Workspace administrators can discover and access the space.", +"A space manager has granted a target audience access to the space. Users or Google Groups that have been individually added or invited to the space can also discover and access the space. To learn more, see [Make a space discoverable to specific users](https://developers.google.com/workspace/chat/space-target-audience)." ], "readOnly": true, "type": "string" }, "audience": { -"description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", +"description": "Optional. The resource name of the [target audience](https://support.google.com/a/answer/9934697) who can discover the space, join the space, and preview the messages in the space. If unset, only users or Google Groups who have been individually invited or added to the space can access it. For details, see [Make a space discoverable to a target audience](https://developers.google.com/workspace/chat/space-target-audience). Format: `audiences/{audience}` To use the default target audience for the Google Workspace organization, set to `audiences/default`.", "type": "string" } }, @@ -1850,7 +1850,7 @@ "type": "object" }, "DeprecatedEvent": { -"description": "A Google Chat app interaction event. To learn about interaction events, see [Receive and respond to interactions with your Google Chat app](https://developers.google.com/workspace/chat/api/guides/message-formats). To learn about event types and for example event payloads, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", +"description": "A Google Chat app interaction event that represents and contains data about a user's interaction with a Chat app. To configure your Chat app to receive interaction events, see [Receive and respond to user interactions](https://developers.google.com/workspace/chat/receive-respond-interactions). In addition to receiving events from user interactions, Chat apps can receive events about changes to spaces, such as when a new member is added to a space. To learn about space events, see [Work with events from Google Chat](https://developers.google.com/workspace/chat/events-overview).", "id": "DeprecatedEvent", "properties": { "action": { @@ -1859,7 +1859,7 @@ }, "common": { "$ref": "CommonEventObject", -"description": "Represents informatmessage_visibilityion about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card." +"description": "Represents information about the user's client, such as locale, host app, and platform. For Chat apps, `CommonEventObject` includes information submitted by users interacting with [dialogs](https://developers.google.com/workspace/chat/dialogs), like data entered on a card." }, "configCompleteRedirectUrl": { "description": "The URL the Chat app should redirect the user to after they have completed an authorization or configuration flow outside of Google Chat. For more information, see [Connect a Chat app with other services & tools](https://developers.google.com/workspace/chat/connect-web-services-tools).", @@ -1896,7 +1896,7 @@ }, "space": { "$ref": "Space", -"description": "The space in which the interaction event occurred." +"description": "The space in which the user interacted with the Chat app." }, "threadKey": { "description": "The Chat app-defined key for the thread related to the interaction event. See [`spaces.messages.thread.threadKey`](/chat/api/reference/rest/v1/spaces.messages#Thread.FIELDS.thread_key) for more information.", @@ -1907,7 +1907,7 @@ "type": "string" }, "type": { -"description": "The type of interaction event. For details, see [Types of Google Chat app interaction events](https://developers.google.com/workspace/chat/events).", +"description": "The [type](/workspace/chat/api/reference/rest/v1/EventType) of user interaction with the Chat app, such as `MESSAGE` or `ADDED_TO_SPACE`.", "enum": [ "UNSPECIFIED", "MESSAGE", @@ -1918,17 +1918,17 @@ ], "enumDescriptions": [ "Default value for the enum. DO NOT USE.", -"A user sends the Chat app a message, or invokes the Chat app in a space.", -"A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization.", -"A user removes the Chat app from a space.", -"A user clicks an interactive element of a card or dialog from a Chat app, such as a button. If a user interacts with a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", +"A user sends the Chat app a message, or invokes the Chat app in a space, such as any of the following examples: * Any message in a direct message (DM) space with the Chat app. * A message in a multi-person space where a person @mentions the Chat app, or uses one of its slash commands. * If you've configured link previews for your Chat app, a user posts a message that contains a link that matches the configured URL pattern.", +"A user adds the Chat app to a space, or a Google Workspace administrator installs the Chat app in direct message spaces for users in their organization. Chat apps typically respond to this interaction event by posting a welcome message in the space. When administrators install Chat apps, the `space.adminInstalled` field is set to `true` and users can't uninstall them. To learn about Chat apps installed by administrators, see Google Workspace Admin Help's documentation, [Install Marketplace apps in your domain](https://support.google.com/a/answer/172482).", +"A user removes the Chat app from a space, or a Google Workspace administrator uninstalls the Chat app for a user in their organization. Chat apps can't respond with messages to this event, because they have already been removed. When administrators uninstall Chat apps, the `space.adminInstalled` field is set to `false`. If a user installed the Chat app before the administrator, the Chat app remains installed for the user and the Chat app doesn't receive a `REMOVED_FROM_SPACE` interaction event.", +"A user clicks an interactive element of a card or dialog from a Chat app, such as a button. To receive an interaction event, the button must trigger another interaction with the Chat app. For example, a Chat app doesn't receive a `CARD_CLICKED` interaction event if a user clicks a button that opens a link to a website, but receives interaction events in the following examples: * The user clicks a `Send feedback` button on a card, which opens a dialog for the user to input information. * The user clicks a `Submit` button after inputting information into a card or dialog. If a user clicks a button to open, submit, or cancel a dialog, the `CARD_CLICKED` interaction event's `isDialogEvent` field is set to `true` and includes a [`DialogEventType`](https://developers.google.com/workspace/chat/api/reference/rest/v1/DialogEventType).", "A user updates a widget in a card message or dialog." ], "type": "string" }, "user": { "$ref": "User", -"description": "The user that triggered the interaction event." +"description": "The user that interacted with the Chat app." } }, "type": "object" @@ -4098,7 +4098,7 @@ "type": "string" }, "externalUserAllowed": { -"description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. * The space is used to [import data to Google Chat] (https://developers.google.com/chat/api/guides/import-data-overview) because import mode spaces must only permit members from the same Google Workspace organization. However, as part of the [Google Workspace Developer Preview Program](https://developers.google.com/workspace/preview), import mode spaces can permit any Google Chat user so this field can then be set for import mode spaces. For existing spaces, this field is output only.", +"description": "Immutable. Whether this space permits any Google Chat user as a member. Input when creating a space in a Google Workspace organization. Omit this field when creating spaces in the following conditions: * The authenticated user uses a consumer account (unmanaged user account). By default, a space created by a consumer account permits any Google Chat user. For existing spaces, this field is output only.", "type": "boolean" }, "importMode": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index 036e56cb06f..23cdd404d0d 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -591,12 +591,12 @@ "type": "string" }, "filter": { -"description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id", +"description": "Query string to filter results, AND-separated fields in EBNF syntax. Note: OR operations are not supported in this filter. Supported filter fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * latest_profile_active_date * permission_name * app_id * manifest_versions", "location": "query", "type": "string" }, "orderBy": { -"description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id", +"description": "Field used to order results. Supported order by fields: * app_name * app_type * install_type * number_of_permissions * total_install_count * app_id * manifest_versions", "location": "query", "type": "string" }, @@ -1172,7 +1172,7 @@ } } }, -"revision": "20240702", +"revision": "20240709", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json index bb9b46c18ce..a310ee5549f 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v1.json @@ -2346,7 +2346,7 @@ } } }, -"revision": "20240627", +"revision": "20240704", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -4295,7 +4295,7 @@ false "id": "HttpConfig", "properties": { "proxySecretVersionName": { -"description": "SecretVersion resource of the HTTP proxy URL. The Service Account should have accessor permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port].", +"description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json index 7f055e49e79..804598c9561 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json @@ -844,7 +844,7 @@ } } }, -"revision": "20240627", +"revision": "20240704", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -1806,12 +1806,14 @@ "enum": [ "TYPE_UNSPECIFIED", "STRING", -"ARRAY" +"ARRAY", +"OBJECT" ], "enumDescriptions": [ "Default enum type; should not be used.", "Default", -"Arrary type." +"Array type.", +"Object type." ], "type": "string" } @@ -1829,6 +1831,13 @@ }, "type": "array" }, +"objectVal": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Value of the parameter if type is object.", +"type": "object" +}, "stringVal": { "description": "Value of the parameter if type is string.", "type": "string" @@ -1838,12 +1847,14 @@ "enum": [ "TYPE_UNSPECIFIED", "STRING", -"ARRAY" +"ARRAY", +"OBJECT" ], "enumDescriptions": [ "Default enum type; should not be used.", "Default", -"Array type" +"Array type", +"Object type" ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json b/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json index 92f9805ada7..bb9eb089055 100644 --- a/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/clouderrorreporting.v1beta1.json @@ -728,7 +728,7 @@ } } }, -"revision": "20240702", +"revision": "20240705", "rootUrl": "https://clouderrorreporting.googleapis.com/", "schemas": { "DeleteEventsResponse": { @@ -979,7 +979,7 @@ "type": "string" }, "message": { -"description": "Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `\"PHP (Notice|Parse error|Fatal error|Warning): \"` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).", +"description": "Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `\"PHP (Notice|Parse error|Fatal error|Warning): \"` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack).", "type": "string" }, "serviceContext": { diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index e4b15b7d295..0ce64289e33 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -33564,7 +33564,7 @@ "regions": { "methods": { "get": { -"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", +"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -44715,7 +44715,7 @@ } } }, -"revision": "20240618", +"revision": "20240702", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -46139,6 +46139,14 @@ false "sourceInstanceTemplateId": { "description": "ID of the instance template used to populate reservation properties.", "type": "string" +}, +"utilizations": { +"additionalProperties": { +"format": "int64", +"type": "string" +}, +"description": "Per service utilization breakdown. The Key is the Google Cloud managed service name.", +"type": "object" } }, "type": "object" @@ -47479,11 +47487,13 @@ false "description": "Specifies how to determine whether the backend of a load balancer can handle additional traffic or is fully loaded. For usage guidelines, see Connection balancing mode. Backends must use compatible balancing modes. For more information, see Supported balancing modes and target capacity settings and Restrictions and guidance for instance groups. Note: Currently, if you use the API to configure incompatible balancing modes, the configuration might be accepted even though it has no impact and is ignored. Specifically, Backend.maxUtilization is ignored when Backend.balancingMode is RATE. In the future, this incompatible combination will be rejected.", "enum": [ "CONNECTION", +"CUSTOM_METRICS", "RATE", "UTILIZATION" ], "enumDescriptions": [ "Balance based on the number of simultaneous connections.", +"Based on custom defined and reported metrics.", "Balance based on requests per second (RPS).", "Balance based on the backend utilization." ], @@ -47494,6 +47504,13 @@ false "format": "float", "type": "number" }, +"customMetrics": { +"description": "List of custom metrics that are used for CUSTOM_METRICS BalancingMode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy.", +"items": { +"$ref": "BackendCustomMetric" +}, +"type": "array" +}, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -47923,6 +47940,26 @@ false }, "type": "object" }, +"BackendCustomMetric": { +"description": "Custom Metrics are used for CUSTOM_METRICS balancing_mode and WEIGHTED_ROUND_ROBIN BackendService locality_lb_policy.", +"id": "BackendCustomMetric", +"properties": { +"dryRun": { +"description": "If true, the metric data is collected and reported to Cloud Monitoring, but is not used for load balancing.", +"type": "boolean" +}, +"maxUtilization": { +"description": "Optional parameter to define a target utilization for the Custom Metrics balancing mode. The valid range is [0.0, 1.0].", +"format": "float", +"type": "number" +}, +"name": { +"description": "Name of a custom utilization signal. The name must be 1-24 characters long, and comply with RFC1035. Specifically, the name must be 1-24 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. For usage guidelines, see Custom Metrics balancing mode. This field can only be used for a global or regional backend service with the loadBalancingScheme set to EXTERNAL_MANAGED, INTERNAL_MANAGED INTERNAL_SELF_MANAGED.", +"type": "string" +} +}, +"type": "object" +}, "BackendService": { "description": "Represents a Backend Service resource. A backend service defines how Google Cloud load balancers distribute traffic. The backend service configuration contains a set of values, such as the protocol used to connect to backends, various distribution and session settings, health checks, and timeouts. These settings provide fine-grained control over how your load balancer behaves. Most of the settings have default values that allow for easy configuration if you need to get started quickly. Backend services in Google Compute Engine can be either regionally or globally scoped. * [Global](https://cloud.google.com/compute/docs/reference/rest/alpha/backendServices) * [Regional](https://cloud.google.com/compute/docs/reference/rest/alpha/regionBackendServices) For more information, see Backend Services.", "id": "BackendService", @@ -48105,7 +48142,8 @@ false "RANDOM", "RING_HASH", "ROUND_ROBIN", -"WEIGHTED_MAGLEV" +"WEIGHTED_MAGLEV", +"WEIGHTED_ROUND_ROBIN" ], "enumDescriptions": [ "", @@ -48115,7 +48153,8 @@ false "The load balancer selects a random healthy host.", "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.", "This is a simple policy in which each healthy backend is selected in round robin order. This is the default.", -"Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing." +"Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.", +"Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields." ], "type": "string" }, @@ -48257,6 +48296,7 @@ false "type": "integer" }, "usedBy": { +"description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -49091,7 +49131,8 @@ false "RANDOM", "RING_HASH", "ROUND_ROBIN", -"WEIGHTED_MAGLEV" +"WEIGHTED_MAGLEV", +"WEIGHTED_ROUND_ROBIN" ], "enumDescriptions": [ "", @@ -49101,7 +49142,8 @@ false "The load balancer selects a random healthy host.", "The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests.", "This is a simple policy in which each healthy backend is selected in round robin order. This is the default.", -"Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing." +"Per-instance weighted Load Balancing via health check reported weights. If set, the Backend Service must configure a non legacy HTTP-based Health Check, and health check replies are expected to contain non-standard HTTP response header field X-Load-Balancing-Endpoint-Weight to specify the per-instance weights. If set, Load Balancing is weighted based on the per-instance weights reported in the last processed health check replies, as long as every instance either reported a valid weight or had UNAVAILABLE_WEIGHT. Otherwise, Load Balancing remains equal-weight. This option is only supported in Network Load Balancing.", +"Per-endpoint weighted round-robin Load Balancing using weights computed from Backend reported Custom Metrics. If set, the Backend Service responses are expected to contain non-standard HTTP response header field X-Endpoint-Load-Metrics. The reported metrics to use for computing the weights are specified via the backends[].customMetrics fields." ], "type": "string" } @@ -49212,6 +49254,7 @@ false "id": "BackendServiceUsedBy", "properties": { "reference": { +"description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -50058,6 +50101,10 @@ false "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" }, +"customEndTimestamp": { +"description": "[Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.", +"type": "string" +}, "description": { "description": "An optional description of this resource. Provide this property when you create the resource.", "type": "string" @@ -50548,6 +50595,10 @@ false "cancellationInformation": { "$ref": "CommitmentResourceStatusCancellationInformation", "description": "[Output Only] An optional, contains all the needed information of cancellation." +}, +"customTermEligibilityEndTimestamp": { +"description": "[Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.", +"type": "string" } }, "type": "object" @@ -59606,8 +59657,7 @@ false "type": "array" }, "baseInstanceName": { -"description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", -"pattern": "[a-z][-a-z0-9]{0,57}", +"description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -70061,12 +70111,6 @@ false "format": "int32", "type": "integer" }, -"clientPort": { -"deprecated": true, -"description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode.", -"format": "int32", -"type": "integer" -}, "fqdn": { "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", "type": "string" @@ -70110,19 +70154,6 @@ false "$ref": "NetworkEndpointGroupAppEngine", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, -"clientPortMappingMode": { -"deprecated": true, -"description": "Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional.", -"enum": [ -"CLIENT_PORT_PER_ENDPOINT", -"PORT_MAPPING_DISABLED" -], -"enumDescriptions": [ -"For each endpoint there is exactly one client port.", -"NEG should not be used for mapping client port to destination." -], -"type": "string" -}, "cloudFunction": { "$ref": "NetworkEndpointGroupCloudFunction", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." @@ -82117,6 +82148,9 @@ false "vmMaintenancePolicy": { "$ref": "ResourcePolicyVmMaintenancePolicy", "description": "Resource policy applicable to VMs for infrastructure maintenance." +}, +"workloadPolicy": { +"$ref": "ResourcePolicyWorkloadPolicy" } }, "type": "object" @@ -82796,6 +82830,24 @@ false }, "type": "object" }, +"ResourcePolicyWorkloadPolicy": { +"description": "Represents the workload policy.", +"id": "ResourcePolicyWorkloadPolicy", +"properties": { +"type": { +"enum": [ +"HIGH_AVAILABILITY", +"HIGH_THROUGHPUT" +], +"enumDescriptions": [ +"VMs will be provisioned in such a way which provides high availability.", +"VMs will be provisioned in such a way which provides high throughput." +], +"type": "string" +} +}, +"type": "object" +}, "ResourceStatus": { "description": "Contains output only fields. Use this sub-message for actual values set on Instance attributes as compared to the value requested by the user (intent) in their instance CRUD calls.", "id": "ResourceStatus", @@ -82874,7 +82926,7 @@ false "id": "ResourceStatusScheduling", "properties": { "availabilityDomain": { -"description": "Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.", +"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", "format": "int32", "type": "integer" }, @@ -85854,7 +85906,7 @@ false "type": "boolean" }, "availabilityDomain": { -"description": "Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement-policy-extension for more details.", +"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", "format": "int32", "type": "integer" }, @@ -98900,7 +98952,7 @@ false "type": "string" }, "stackType": { -"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", +"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/googleapiclient/discovery_cache/documents/compute.beta.json b/googleapiclient/discovery_cache/documents/compute.beta.json index 2ea6da97f9c..77345d6b9a2 100644 --- a/googleapiclient/discovery_cache/documents/compute.beta.json +++ b/googleapiclient/discovery_cache/documents/compute.beta.json @@ -3669,6 +3669,40 @@ "https://www.googleapis.com/auth/compute" ] }, +"addPacketMirroringRule": { +"description": "Inserts a packet mirroring rule into a firewall policy.", +"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", +"httpMethod": "POST", +"id": "compute.firewallPolicies.addPacketMirroringRule", +"parameterOrder": [ +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to update.", +"location": "path", +"pattern": "(firewallPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "locations/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", +"request": { +"$ref": "FirewallPolicyRule" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "addRule": { "description": "Inserts a rule into a firewall policy.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/addRule", @@ -3862,6 +3896,39 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getPacketMirroringRule": { +"description": "Gets a packet mirroring rule of the specified priority.", +"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", +"httpMethod": "GET", +"id": "compute.firewallPolicies.getPacketMirroringRule", +"parameterOrder": [ +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to which the queried rule belongs.", +"location": "path", +"pattern": "(firewallPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +}, +"priority": { +"description": "The priority of the rule to get from the firewall policy.", +"format": "int32", +"location": "query", +"type": "integer" +} +}, +"path": "locations/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", +"response": { +"$ref": "FirewallPolicyRule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getRule": { "description": "Gets a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/getRule", @@ -4066,6 +4133,46 @@ "https://www.googleapis.com/auth/compute" ] }, +"patchPacketMirroringRule": { +"description": "Patches a packet mirroring rule of the specified priority.", +"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", +"httpMethod": "POST", +"id": "compute.firewallPolicies.patchPacketMirroringRule", +"parameterOrder": [ +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to update.", +"location": "path", +"pattern": "(firewallPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +}, +"priority": { +"description": "The priority of the rule to patch.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "locations/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", +"request": { +"$ref": "FirewallPolicyRule" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "patchRule": { "description": "Patches a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/patchRule", @@ -4142,6 +4249,43 @@ "https://www.googleapis.com/auth/compute" ] }, +"removePacketMirroringRule": { +"description": "Deletes a packet mirroring rule of the specified priority.", +"flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", +"httpMethod": "POST", +"id": "compute.firewallPolicies.removePacketMirroringRule", +"parameterOrder": [ +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to update.", +"location": "path", +"pattern": "(firewallPolicies/)?[0-9]{0,20}", +"required": true, +"type": "string" +}, +"priority": { +"description": "The priority of the rule to remove from the firewall policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "locations/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "removeRule": { "description": "Deletes a rule of the specified priority.", "flatPath": "locations/global/firewallPolicies/{firewallPolicy}/removeRule", @@ -17184,6 +17328,60 @@ "https://www.googleapis.com/auth/compute" ] }, +"addPacketMirroringRule": { +"description": "Inserts a packet mirroring rule into a firewall policy.", +"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", +"httpMethod": "POST", +"id": "compute.networkFirewallPolicies.addPacketMirroringRule", +"parameterOrder": [ +"project", +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to update.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"maxPriority": { +"description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"minPriority": { +"description": "When rule.priority is not specified, auto choose a unused priority between minPriority and maxPriority>. This field is exclusive with rule.priority.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addPacketMirroringRule", +"request": { +"$ref": "FirewallPolicyRule" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "addRule": { "description": "Inserts a rule into a firewall policy.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/addRule", @@ -17437,6 +17635,47 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, +"getPacketMirroringRule": { +"description": "Gets a packet mirroring rule of the specified priority.", +"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", +"httpMethod": "GET", +"id": "compute.networkFirewallPolicies.getPacketMirroringRule", +"parameterOrder": [ +"project", +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to which the queried rule belongs.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"priority": { +"description": "The priority of the rule to get from the firewall policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getPacketMirroringRule", +"response": { +"$ref": "FirewallPolicyRule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, "getRule": { "description": "Gets a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/getRule", @@ -17609,6 +17848,54 @@ "https://www.googleapis.com/auth/compute" ] }, +"patchPacketMirroringRule": { +"description": "Patches a packet mirroring rule of the specified priority.", +"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", +"httpMethod": "POST", +"id": "compute.networkFirewallPolicies.patchPacketMirroringRule", +"parameterOrder": [ +"project", +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to update.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"priority": { +"description": "The priority of the rule to patch.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchPacketMirroringRule", +"request": { +"$ref": "FirewallPolicyRule" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "patchRule": { "description": "Patches a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/patchRule", @@ -17701,6 +17988,51 @@ "https://www.googleapis.com/auth/compute" ] }, +"removePacketMirroringRule": { +"description": "Deletes a packet mirroring rule of the specified priority.", +"flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", +"httpMethod": "POST", +"id": "compute.networkFirewallPolicies.removePacketMirroringRule", +"parameterOrder": [ +"project", +"firewallPolicy" +], +"parameters": { +"firewallPolicy": { +"description": "Name of the firewall policy to update.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"priority": { +"description": "The priority of the rule to remove from the firewall policy.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removePacketMirroringRule", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, "removeRule": { "description": "Deletes a rule of the specified priority.", "flatPath": "projects/{project}/global/firewallPolicies/{firewallPolicy}/removeRule", @@ -31184,7 +31516,7 @@ "regions": { "methods": { "get": { -"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", +"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -41579,7 +41911,7 @@ } } }, -"revision": "20240618", +"revision": "20240702", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -44904,7 +45236,8 @@ false "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", -"NONE" +"NONE", +"STRONG_COOKIE_AFFINITY" ], "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", @@ -44914,10 +45247,15 @@ false "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.", "The hash is based on a user specified header field.", "The hash is based on a user provided cookie.", -"No session affinity. Connections from the same client IP may go to any instance in the pool." +"No session affinity. Connections from the same client IP may go to any instance in the pool.", +"Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." ], "type": "string" }, +"strongSessionAffinityCookie": { +"$ref": "BackendServiceHttpCookie", +"description": "Describes the HTTP cookie used for stateful session affinity. This field is applicable and required if the sessionAffinity is set to STRONG_COOKIE_AFFINITY." +}, "subsetting": { "$ref": "Subsetting" }, @@ -44927,6 +45265,7 @@ false "type": "integer" }, "usedBy": { +"description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -45293,6 +45632,25 @@ false }, "type": "object" }, +"BackendServiceHttpCookie": { +"description": "The HTTP cookie used for stateful session affinity.", +"id": "BackendServiceHttpCookie", +"properties": { +"name": { +"description": "Name of the cookie.", +"type": "string" +}, +"path": { +"description": "Path to set for the cookie.", +"type": "string" +}, +"ttl": { +"$ref": "Duration", +"description": "Lifetime of the cookie." +} +}, +"type": "object" +}, "BackendServiceIAP": { "description": "Identity-Aware Proxy", "id": "BackendServiceIAP", @@ -45729,6 +46087,7 @@ false "id": "BackendServiceUsedBy", "properties": { "reference": { +"description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -46586,6 +46945,7 @@ false "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", "GENERAL_PURPOSE", +"GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", @@ -46616,6 +46976,7 @@ false "", "", "", +"", "" ], "type": "string" @@ -49848,6 +50209,13 @@ false "description": "Name of the resource. For Organization Firewall Policies it's a [Output Only] numeric ID allocated by Google Cloud which uniquely identifies the Organization Firewall Policy.", "type": "string" }, +"packetMirroringRules": { +"description": "A list of packet mirroring rules that belong to this policy.", +"items": { +"$ref": "FirewallPolicyRule" +}, +"type": "array" +}, "parent": { "description": "[Output Only] The parent of the firewall policy. This field is not applicable to network firewall policies.", "type": "string" @@ -55330,8 +55698,7 @@ false "type": "array" }, "baseInstanceName": { -"description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", -"pattern": "[a-z][-a-z0-9]{0,57}", +"description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -58756,6 +59123,11 @@ false "description": "[Output Only] The name of the firewall policy.", "type": "string" }, +"priority": { +"description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", +"format": "int32", +"type": "integer" +}, "rules": { "description": "The rules that apply to the network.", "items": { @@ -58773,12 +59145,16 @@ false "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", +"SYSTEM_GLOBAL", +"SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ "", "", "", +"", +"", "" ], "type": "string" @@ -64659,12 +65035,6 @@ false "format": "int32", "type": "integer" }, -"clientPort": { -"deprecated": true, -"description": "Represents the port number to which PSC consumer sends packets. Only valid for network endpoint groups created with CLIENT_PORT_PER_ENDPOINT mapping mode.", -"format": "int32", -"type": "integer" -}, "fqdn": { "description": "Optional fully qualified domain name of network endpoint. This can only be specified when NetworkEndpointGroup.network_endpoint_type is NON_GCP_FQDN_PORT.", "type": "string" @@ -64704,19 +65074,6 @@ false "$ref": "NetworkEndpointGroupAppEngine", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." }, -"clientPortMappingMode": { -"deprecated": true, -"description": "Only valid when networkEndpointType is GCE_VM_IP_PORT and the NEG is regional.", -"enum": [ -"CLIENT_PORT_PER_ENDPOINT", -"PORT_MAPPING_DISABLED" -], -"enumDescriptions": [ -"For each endpoint there is exactly one client port.", -"NEG should not be used for mapping client port to destination." -], -"type": "string" -}, "cloudFunction": { "$ref": "NetworkEndpointGroupCloudFunction", "description": "Only valid when networkEndpointType is SERVERLESS. Only one of cloudRun, appEngine or cloudFunction may be set." @@ -73434,6 +73791,11 @@ false "description": "[Output Only] The name of the firewall policy.", "type": "string" }, +"priority": { +"description": "[Output only] Priority of firewall policy association. Not applicable for type=HIERARCHY.", +"format": "int32", +"type": "integer" +}, "rules": { "description": "The rules that apply to the network.", "items": { @@ -73447,12 +73809,16 @@ false "HIERARCHY", "NETWORK", "NETWORK_REGIONAL", +"SYSTEM_GLOBAL", +"SYSTEM_REGIONAL", "UNSPECIFIED" ], "enumDescriptions": [ "", "", "", +"", +"", "" ], "type": "string" @@ -75020,6 +75386,11 @@ false "ResourceStatusScheduling": { "id": "ResourceStatusScheduling", "properties": { +"availabilityDomain": { +"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", +"format": "int32", +"type": "integer" +}, "terminationTimestamp": { "description": "Time in future when the instance will be terminated in RFC3339 text format.", "type": "string" @@ -77646,6 +78017,11 @@ false "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", "type": "boolean" }, +"availabilityDomain": { +"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", +"format": "int32", +"type": "integer" +}, "hostErrorTimeoutSeconds": { "description": "Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used.", "format": "int32", @@ -86364,7 +86740,8 @@ false "GENERATED_COOKIE", "HEADER_FIELD", "HTTP_COOKIE", -"NONE" +"NONE", +"STRONG_COOKIE_AFFINITY" ], "enumDescriptions": [ "2-tuple hash on packet's source and destination IP addresses. Connections from the same source IP address to the same destination IP address will be served by the same backend VM while that VM remains healthy.", @@ -86374,7 +86751,8 @@ false "Hash based on a cookie generated by the L7 loadbalancer. Only valid for HTTP(S) load balancing.", "The hash is based on a user specified header field.", "The hash is based on a user provided cookie.", -"No session affinity. Connections from the same client IP may go to any instance in the pool." +"No session affinity. Connections from the same client IP may go to any instance in the pool.", +"Strong cookie-based affinity. Connections bearing the same cookie will be served by the same backend VM while that VM remains healthy, as long as the cookie has not expired." ], "type": "string" } @@ -89651,7 +90029,7 @@ false "type": "string" }, "stackType": { -"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", +"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/googleapiclient/discovery_cache/documents/compute.v1.json b/googleapiclient/discovery_cache/documents/compute.v1.json index efb1177a57c..cb70f3014c7 100644 --- a/googleapiclient/discovery_cache/documents/compute.v1.json +++ b/googleapiclient/discovery_cache/documents/compute.v1.json @@ -27980,7 +27980,7 @@ "regions": { "methods": { "get": { -"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request.", +"description": "Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the `quotas` field). To exclude one or more fields, set your request's `fields` query parameter to only include the fields you need. For example, to only include the `id` and `selfLink` fields, add the query parameter `?fields=id,selfLink` to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the `items.quotas` field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.", "flatPath": "projects/{project}/regions/{region}", "httpMethod": "GET", "id": "compute.regions.get", @@ -37421,7 +37421,7 @@ } } }, -"revision": "20240618", +"revision": "20240702", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -40687,6 +40687,7 @@ false "type": "integer" }, "usedBy": { +"description": "[Output Only] List of resources referencing given backend service.", "items": { "$ref": "BackendServiceUsedBy" }, @@ -41489,6 +41490,7 @@ false "id": "BackendServiceUsedBy", "properties": { "reference": { +"description": "[Output Only] Server-defined URL for resources referencing given BackendService like UrlMaps, TargetTcpProxies, TargetSslProxies and ForwardingRule.", "type": "string" } }, @@ -42242,6 +42244,7 @@ false "COMPUTE_OPTIMIZED_C3D", "COMPUTE_OPTIMIZED_H3", "GENERAL_PURPOSE", +"GENERAL_PURPOSE_C4", "GENERAL_PURPOSE_E2", "GENERAL_PURPOSE_N2", "GENERAL_PURPOSE_N2D", @@ -42272,6 +42275,7 @@ false "", "", "", +"", "" ], "type": "string" @@ -50039,8 +50043,7 @@ false "type": "array" }, "baseInstanceName": { -"description": "The base instance name to use for instances in this group. The value must be 1-58 characters long. Instances are named by appending a hyphen and a random four-character string to the base instance name. The base instance name must comply with RFC1035.", -"pattern": "[a-z][-a-z0-9]{0,57}", +"description": "The base instance name is a prefix that you want to attach to the names of all VMs in a MIG. The maximum character length is 58 and the name must comply with RFC1035 format. When a VM is created in the group, the MIG appends a hyphen and a random four-character string to the base instance name. If you want the MIG to assign sequential numbers instead of a random string, then end the base instance name with a hyphen followed by one or more hash symbols. The hash symbols indicate the number of digits. For example, a base instance name of \"vm-###\" results in \"vm-001\" as a VM name. @pattern [a-z](([-a-z0-9]{0,57})|([-a-z0-9]{0,52}-#{1,10}(\\\\[[0-9]{1,10}\\\\])?))", "type": "string" }, "creationTimestamp": { @@ -71222,6 +71225,11 @@ false "description": "Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine.", "type": "boolean" }, +"availabilityDomain": { +"description": "Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.", +"format": "int32", +"type": "integer" +}, "instanceTerminationAction": { "description": "Specifies the termination action for the instance.", "enum": [ @@ -82684,7 +82692,7 @@ false "type": "string" }, "stackType": { -"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6. If not specified, IPV4_ONLY will be used.", +"description": "The stack type for this VPN gateway to identify the IP protocols that are enabled. Possible values are: IPV4_ONLY, IPV4_IPV6, IPV6_ONLY. If not specified, IPV4_ONLY is used if the gateway IP version is IPV4, or IPV4_IPV6 if the gateway IP version is IPV6.", "enum": [ "IPV4_IPV6", "IPV4_ONLY", diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index 97550fa8fb3..bb83e86d4b9 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2427,7 +2427,7 @@ } } }, -"revision": "20240701", +"revision": "20240708", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -5892,7 +5892,7 @@ false "type": "array" }, "valueSeparator": { -"description": "Required. Value separator.", +"description": "Required. Value separator. Only \",\" can be used for OAuth auth code flow scope field.", "type": "string" } }, @@ -6536,6 +6536,10 @@ false ], "type": "string" }, +"defaultValue": { +"description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", +"type": "any" +}, "description": { "description": "A brief description of the field.", "type": "string" @@ -6547,6 +6551,10 @@ false "jsonSchema": { "$ref": "JsonSchema", "description": "JsonSchema representation of this action's result" +}, +"nullable": { +"description": "Specifies whether a null value is allowed.", +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/connectors.v2.json b/googleapiclient/discovery_cache/documents/connectors.v2.json index 217f519e688..621a267ecb0 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v2.json +++ b/googleapiclient/discovery_cache/documents/connectors.v2.json @@ -660,7 +660,7 @@ } } }, -"revision": "20240701", +"revision": "20240708", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AccessCredentials": { @@ -2269,6 +2269,10 @@ false ], "type": "string" }, +"defaultValue": { +"description": "The following field specifies the default value of the Parameter provided by the external system if a value is not provided.", +"type": "any" +}, "description": { "description": "A brief description of the metadata field.", "type": "string" @@ -2280,6 +2284,10 @@ false "name": { "description": "Name of the metadata field.", "type": "string" +}, +"nullable": { +"description": "Specifies whether a null value is allowed.", +"type": "boolean" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/css.v1.json b/googleapiclient/discovery_cache/documents/css.v1.json new file mode 100644 index 00000000000..94e5ccbf865 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/css.v1.json @@ -0,0 +1,1216 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/content": { +"description": "Manage your product listings and accounts for Google Shopping" +} +} +} +}, +"basePath": "", +"baseUrl": "https://css.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Css", +"description": "Programmatically manage your Comparison Shopping Service (CSS) account data at scale.", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/comparison-shopping-services/api/overview", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "css:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://css.mtls.googleapis.com/", +"name": "css", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"accounts": { +"methods": { +"get": { +"description": "Retrieves a single CSS/MC account by ID.", +"flatPath": "v1/accounts/{accountsId}", +"httpMethod": "GET", +"id": "css.accounts.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the managed CSS/MC account. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +}, +"parent": { +"description": "Optional. Only required when retrieving MC account information. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Account" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"listChildAccounts": { +"description": "Lists all the accounts under the specified CSS account ID, and optionally filters by label ID and account name.", +"flatPath": "v1/accounts/{accountsId}:listChildAccounts", +"httpMethod": "GET", +"id": "css.accounts.listChildAccounts", +"parameterOrder": [ +"parent" +], +"parameters": { +"fullName": { +"description": "If set, only the MC accounts with the given name (case sensitive) will be returned.", +"location": "query", +"type": "string" +}, +"labelId": { +"description": "If set, only the MC accounts with the given label ID will be returned.", +"format": "int64", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 50 accounts will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListChildAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListChildAccounts` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent account. Must be a CSS group or domain. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}:listChildAccounts", +"response": { +"$ref": "ListChildAccountsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"updateLabels": { +"description": "Updates labels assigned to CSS/MC accounts by a CSS domain.", +"flatPath": "v1/accounts/{accountsId}:updateLabels", +"httpMethod": "POST", +"id": "css.accounts.updateLabels", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The label resource name. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:updateLabels", +"request": { +"$ref": "UpdateAccountLabelsRequest" +}, +"response": { +"$ref": "Account" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +} +}, +"resources": { +"cssProductInputs": { +"methods": { +"delete": { +"description": "Deletes a CSS Product input from your CSS Center account. After a delete it may take several minutes until the input is no longer available.", +"flatPath": "v1/accounts/{accountsId}/cssProductInputs/{cssProductInputsId}", +"httpMethod": "DELETE", +"id": "css.accounts.cssProductInputs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the CSS product input resource to delete. Format: accounts/{account}/cssProductInputs/{css_product_input}", +"location": "path", +"pattern": "^accounts/[^/]+/cssProductInputs/[^/]+$", +"required": true, +"type": "string" +}, +"supplementalFeedId": { +"description": "The Content API Supplemental Feed ID. The field must not be set if the action applies to a primary feed. If the field is set, then product action applies to a supplemental feed instead of primary Content API feed.", +"format": "int64", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"insert": { +"description": "Uploads a CssProductInput to your CSS Center account. If an input with the same contentLanguage, identity, feedLabel and feedId already exists, this method replaces that entry. After inserting, updating, or deleting a CSS Product input, it may take several minutes before the processed CSS Product can be retrieved.", +"flatPath": "v1/accounts/{accountsId}/cssProductInputs:insert", +"httpMethod": "POST", +"id": "css.accounts.cssProductInputs.insert", +"parameterOrder": [ +"parent" +], +"parameters": { +"feedId": { +"description": "Required. The primary or supplemental feed id. If CSS Product already exists and feed id provided is different, then the CSS Product will be moved to a new feed. Note: For now, CSSs do not need to provide feed ids as we create feeds on the fly. We do not have supplemental feed support for CSS Products yet.", +"format": "int64", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The account where this CSS Product will be inserted. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/cssProductInputs:insert", +"request": { +"$ref": "CssProductInput" +}, +"response": { +"$ref": "CssProductInput" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +} +} +}, +"cssProducts": { +"methods": { +"get": { +"description": "Retrieves the processed CSS Product from your CSS Center account. After inserting, updating, or deleting a product input, it may take several minutes before the updated final product can be retrieved.", +"flatPath": "v1/accounts/{accountsId}/cssProducts/{cssProductsId}", +"httpMethod": "GET", +"id": "css.accounts.cssProducts.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the CSS product to retrieve.", +"location": "path", +"pattern": "^accounts/[^/]+/cssProducts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "CssProduct" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"list": { +"description": "Lists the processed CSS Products in your CSS Center account. The response might contain fewer items than specified by pageSize. Rely on pageToken to determine if there are more items to be requested. After inserting, updating, or deleting a CSS product input, it may take several minutes before the updated processed CSS product can be retrieved.", +"flatPath": "v1/accounts/{accountsId}/cssProducts", +"httpMethod": "GET", +"id": "css.accounts.cssProducts.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of CSS Products to return. The service may return fewer than this value. The maximum value is 1000; values above 1000 will be coerced to 1000. If unspecified, the maximum number of CSS products will be returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListCssProducts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListCssProducts` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The account/domain to list processed CSS Products for. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/cssProducts", +"response": { +"$ref": "ListCssProductsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +} +} +}, +"labels": { +"methods": { +"create": { +"description": "Creates a new label, not assigned to any account.", +"flatPath": "v1/accounts/{accountsId}/labels", +"httpMethod": "POST", +"id": "css.accounts.labels.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent account. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/labels", +"request": { +"$ref": "AccountLabel" +}, +"response": { +"$ref": "AccountLabel" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"delete": { +"description": "Deletes a label and removes it from all accounts to which it was assigned.", +"flatPath": "v1/accounts/{accountsId}/labels/{labelsId}", +"httpMethod": "DELETE", +"id": "css.accounts.labels.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the label to delete. Format: accounts/{account}/labels/{label}", +"location": "path", +"pattern": "^accounts/[^/]+/labels/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"list": { +"description": "Lists the labels assigned to an account.", +"flatPath": "v1/accounts/{accountsId}/labels", +"httpMethod": "GET", +"id": "css.accounts.labels.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of labels to return. The service may return fewer than this value. If unspecified, at most 50 labels will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListAccountLabels` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountLabels` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent account. Format: accounts/{account}", +"location": "path", +"pattern": "^accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/labels", +"response": { +"$ref": "ListAccountLabelsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, +"patch": { +"description": "Updates a label.", +"flatPath": "v1/accounts/{accountsId}/labels/{labelsId}", +"httpMethod": "PATCH", +"id": "css.accounts.labels.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The resource name of the label. Format: accounts/{account}/labels/{label}", +"location": "path", +"pattern": "^accounts/[^/]+/labels/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "AccountLabel" +}, +"response": { +"$ref": "AccountLabel" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +} +} +} +} +} +}, +"revision": "20240614", +"rootUrl": "https://css.googleapis.com/", +"schemas": { +"Account": { +"description": "Information about CSS/MC account.", +"id": "Account", +"properties": { +"accountType": { +"description": "Output only. The type of this account.", +"enum": [ +"ACCOUNT_TYPE_UNSPECIFIED", +"CSS_GROUP", +"CSS_DOMAIN", +"MC_PRIMARY_CSS_MCA", +"MC_CSS_MCA", +"MC_MARKETPLACE_MCA", +"MC_OTHER_MCA", +"MC_STANDALONE", +"MC_MCA_SUBACCOUNT" +], +"enumDescriptions": [ +"Unknown account type.", +"CSS group account.", +"CSS domain account.", +"MC Primary CSS MCA account.", +"MC CSS MCA account.", +"MC Marketplace MCA account.", +"MC Other MCA account.", +"MC Standalone account.", +"MC MCA sub-account." +], +"readOnly": true, +"type": "string" +}, +"automaticLabelIds": { +"description": "Automatically created label IDs assigned to the MC account by CSS Center.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"displayName": { +"description": "The CSS/MC account's short display name.", +"type": "string" +}, +"fullName": { +"description": "Output only. Immutable. The CSS/MC account's full name.", +"readOnly": true, +"type": "string" +}, +"homepageUri": { +"description": "Output only. Immutable. The CSS/MC account's homepage.", +"readOnly": true, +"type": "string" +}, +"labelIds": { +"description": "Manually created label IDs assigned to the CSS/MC account by a CSS parent account.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"name": { +"description": "The label resource name. Format: accounts/{account}", +"type": "string" +}, +"parent": { +"description": "The CSS/MC account's parent resource. CSS group for CSS domains; CSS domain for MC accounts. Returned only if the user has access to the parent account.", +"type": "string" +} +}, +"type": "object" +}, +"AccountLabel": { +"description": "Label assigned by CSS domain or CSS group to one of its sub-accounts.", +"id": "AccountLabel", +"properties": { +"accountId": { +"description": "Output only. The ID of account this label belongs to.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "The description of this label.", +"type": "string" +}, +"displayName": { +"description": "The display name of this label.", +"type": "string" +}, +"labelId": { +"description": "Output only. The ID of the label.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"labelType": { +"description": "Output only. The type of this label.", +"enum": [ +"LABEL_TYPE_UNSPECIFIED", +"MANUAL", +"AUTOMATIC" +], +"enumDescriptions": [ +"Unknown label type.", +"Indicates that the label was created manually.", +"Indicates that the label was created automatically by CSS Center." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "The resource name of the label. Format: accounts/{account}/labels/{label}", +"type": "string" +} +}, +"type": "object" +}, +"Attributes": { +"description": "Attributes for CSS Product.", +"id": "Attributes", +"properties": { +"additionalImageLinks": { +"description": "Additional URL of images of the item.", +"items": { +"type": "string" +}, +"type": "array" +}, +"adult": { +"description": "Set to true if the item is targeted towards adults.", +"type": "boolean" +}, +"ageGroup": { +"description": "Target age group of the item.", +"type": "string" +}, +"brand": { +"description": "Product Related Attributes.[14-36] Brand of the item.", +"type": "string" +}, +"certifications": { +"description": "A list of certificates claimed by the CSS for the given product.", +"items": { +"$ref": "Certification" +}, +"type": "array" +}, +"color": { +"description": "Color of the item.", +"type": "string" +}, +"cppAdsRedirect": { +"description": "Allows advertisers to override the item URL when the product is shown within the context of Product Ads.", +"type": "string" +}, +"cppLink": { +"description": "URL directly linking to your the Product Detail Page of the CSS.", +"type": "string" +}, +"cppMobileLink": { +"description": "URL for the mobile-optimized version of the Product Detail Page of the CSS.", +"type": "string" +}, +"customLabel0": { +"description": "Custom label 0 for custom grouping of items in a Shopping campaign.", +"type": "string" +}, +"customLabel1": { +"description": "Custom label 1 for custom grouping of items in a Shopping campaign.", +"type": "string" +}, +"customLabel2": { +"description": "Custom label 2 for custom grouping of items in a Shopping campaign.", +"type": "string" +}, +"customLabel3": { +"description": "Custom label 3 for custom grouping of items in a Shopping campaign.", +"type": "string" +}, +"customLabel4": { +"description": "Custom label 4 for custom grouping of items in a Shopping campaign.", +"type": "string" +}, +"description": { +"description": "Description of the item.", +"type": "string" +}, +"excludedDestinations": { +"description": "The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).", +"items": { +"type": "string" +}, +"type": "array" +}, +"expirationDate": { +"description": "Date on which the item should expire, as specified upon insertion, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format. The actual expiration date is exposed in `productstatuses` as [googleExpirationDate](https://support.google.com/merchants/answer/6324499) and might be earlier if `expirationDate` is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted.", +"format": "google-datetime", +"type": "string" +}, +"gender": { +"description": "Target gender of the item.", +"type": "string" +}, +"googleProductCategory": { +"description": "Google's category of the item (see [Google product taxonomy](https://support.google.com/merchants/answer/1705911)). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.", +"type": "string" +}, +"gtin": { +"description": "Global Trade Item Number ([GTIN](https://support.google.com/merchants/answer/188494#gtin)) of the item.", +"type": "string" +}, +"headlineOfferCondition": { +"description": "Condition of the headline offer.", +"type": "string" +}, +"headlineOfferLink": { +"description": "Link to the headline offer.", +"type": "string" +}, +"headlineOfferMobileLink": { +"description": "Mobile Link to the headline offer.", +"type": "string" +}, +"headlineOfferPrice": { +"$ref": "Price", +"description": "Headline Price of the aggregate offer." +}, +"headlineOfferShippingPrice": { +"$ref": "Price", +"description": "Headline Price of the aggregate offer." +}, +"highPrice": { +"$ref": "Price", +"description": "High Price of the aggregate offer." +}, +"imageLink": { +"description": "URL of an image of the item.", +"type": "string" +}, +"includedDestinations": { +"description": "The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center). Default destinations are always included unless provided in `excludedDestinations`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"isBundle": { +"description": "Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.", +"type": "boolean" +}, +"itemGroupId": { +"description": "Shared identifier for all variants of the same product.", +"type": "string" +}, +"lowPrice": { +"$ref": "Price", +"description": "Low Price of the aggregate offer." +}, +"material": { +"description": "The material of which the item is made.", +"type": "string" +}, +"mpn": { +"description": "Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item.", +"type": "string" +}, +"multipack": { +"description": "The number of identical products in a merchant-defined multipack.", +"format": "int64", +"type": "string" +}, +"numberOfOffers": { +"description": "The number of aggregate offers.", +"format": "int64", +"type": "string" +}, +"pattern": { +"description": "The item's pattern (e.g. polka dots).", +"type": "string" +}, +"pause": { +"description": "Publication of this item will be temporarily paused.", +"type": "string" +}, +"productDetails": { +"description": "Technical specification or additional product details.", +"items": { +"$ref": "ProductDetail" +}, +"type": "array" +}, +"productHeight": { +"$ref": "ProductDimension", +"description": "The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." +}, +"productHighlights": { +"description": "Bullet points describing the most relevant highlights of a product.", +"items": { +"type": "string" +}, +"type": "array" +}, +"productLength": { +"$ref": "ProductDimension", +"description": "The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." +}, +"productTypes": { +"description": "Categories of the item (formatted as in [products data specification](https://support.google.com/merchants/answer/6324406)).", +"items": { +"type": "string" +}, +"type": "array" +}, +"productWeight": { +"$ref": "ProductWeight", +"description": "The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive)." +}, +"productWidth": { +"$ref": "ProductDimension", +"description": "The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." +}, +"size": { +"description": "Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)).", +"type": "string" +}, +"sizeSystem": { +"description": "System in which the size is specified. Recommended for apparel items.", +"type": "string" +}, +"sizeTypes": { +"description": "The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [https://support.google.com/merchants/answer/6324497](size type)).", +"items": { +"type": "string" +}, +"type": "array" +}, +"title": { +"description": "Title of the item.", +"type": "string" +} +}, +"type": "object" +}, +"Certification": { +"description": "The certification for the product.", +"id": "Certification", +"properties": { +"authority": { +"description": "Name of the certification body.", +"type": "string" +}, +"code": { +"description": "A unique code to identify the certification.", +"type": "string" +}, +"name": { +"description": "Name of the certification.", +"type": "string" +} +}, +"type": "object" +}, +"CssProduct": { +"description": "The processed CSS Product(a.k.a Aggregate Offer internally).", +"id": "CssProduct", +"properties": { +"attributes": { +"$ref": "Attributes", +"description": "Output only. A list of product attributes.", +"readOnly": true +}, +"contentLanguage": { +"description": "Output only. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the product.", +"readOnly": true, +"type": "string" +}, +"cssProductStatus": { +"$ref": "CssProductStatus", +"description": "Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.", +"readOnly": true +}, +"customAttributes": { +"description": "Output only. A list of custom (CSS-provided) attributes. It can also be used to submit any attribute of the feed specification in its generic form (for example, `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.", +"items": { +"$ref": "CustomAttribute" +}, +"readOnly": true, +"type": "array" +}, +"feedLabel": { +"description": "Output only. The feed label for the product.", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "The name of the CSS Product. Format: `\"accounts/{account}/cssProducts/{css_product}\"`", +"type": "string" +}, +"rawProvidedId": { +"description": "Output only. Your unique raw identifier for the product.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CssProductInput": { +"description": "This resource represents input data you submit for a CSS Product, not the processed CSS Product that you see in CSS Center, in Shopping Ads, or across Google surfaces.", +"id": "CssProductInput", +"properties": { +"attributes": { +"$ref": "Attributes", +"description": "A list of CSS Product attributes." +}, +"contentLanguage": { +"description": "Required. The two-letter [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) language code for the CSS Product.", +"type": "string" +}, +"customAttributes": { +"description": "A list of custom (CSS-provided) attributes. It can also be used for submitting any attribute of the feed specification in its generic form (for example: `{ \"name\": \"size type\", \"value\": \"regular\" }`). This is useful for submitting attributes not explicitly exposed by the API, such as additional attributes used for Buy on Google.", +"items": { +"$ref": "CustomAttribute" +}, +"type": "array" +}, +"feedLabel": { +"description": "Required. The [feed label](https://developers.google.com/shopping-content/guides/products/feed-labels) for the CSS Product. Feed Label is synonymous to \"target country\" and hence should always be a valid region code. For example: 'DE' for Germany, 'FR' for France.", +"type": "string" +}, +"finalName": { +"description": "Output only. The name of the processed CSS Product. Format: `accounts/{account}/cssProducts/{css_product}` \"", +"readOnly": true, +"type": "string" +}, +"freshnessTime": { +"description": "Represents the existing version (freshness) of the CSS Product, which can be used to preserve the right order when multiple updates are done at the same time. This field must not be set to the future time. If set, the update is prevented if a newer version of the item already exists in our system (that is the last update time of the existing CSS products is later than the freshness time set in the update). If the update happens, the last update time is then set to this freshness time. If not set, the update will not be prevented and the last update time will default to when this request was received by the CSS API. If the operation is prevented, the aborted exception will be thrown.", +"format": "google-datetime", +"type": "string" +}, +"name": { +"description": "The name of the CSS Product input. Format: `accounts/{account}/cssProductInputs/{css_product_input}`", +"type": "string" +}, +"rawProvidedId": { +"description": "Required. Your unique identifier for the CSS Product. This is the same for the CSS Product input and processed CSS Product. We only allow ids with alphanumerics, underscores and dashes. See the [products feed specification](https://support.google.com/merchants/answer/188494#id) for details.", +"type": "string" +} +}, +"type": "object" +}, +"CssProductStatus": { +"description": "The status of the Css Product, data validation issues, that is, information about the Css Product computed asynchronously.", +"id": "CssProductStatus", +"properties": { +"creationDate": { +"description": "Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", +"format": "google-datetime", +"type": "string" +}, +"destinationStatuses": { +"description": "The intended destinations for the product.", +"items": { +"$ref": "DestinationStatus" +}, +"type": "array" +}, +"googleExpirationDate": { +"description": "Date on which the item expires, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", +"format": "google-datetime", +"type": "string" +}, +"itemLevelIssues": { +"description": "A list of all issues associated with the product.", +"items": { +"$ref": "ItemLevelIssue" +}, +"type": "array" +}, +"lastUpdateDate": { +"description": "Date on which the item has been last updated, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"CustomAttribute": { +"description": "A message that represents custom attributes. Exactly one of `value` or `group_values` must not be empty.", +"id": "CustomAttribute", +"properties": { +"groupValues": { +"description": "Subattributes within this attribute group. If `group_values` is not empty, `value` must be empty.", +"items": { +"$ref": "CustomAttribute" +}, +"type": "array" +}, +"name": { +"description": "The name of the attribute.", +"type": "string" +}, +"value": { +"description": "The value of the attribute. If `value` is not empty, `group_values` must be empty.", +"type": "string" +} +}, +"type": "object" +}, +"DestinationStatus": { +"description": "The destination status of the product status.", +"id": "DestinationStatus", +"properties": { +"approvedCountries": { +"description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is approved.", +"items": { +"type": "string" +}, +"type": "array" +}, +"destination": { +"description": "The name of the destination", +"type": "string" +}, +"disapprovedCountries": { +"description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is disapproved.", +"items": { +"type": "string" +}, +"type": "array" +}, +"pendingCountries": { +"description": "List of country codes (ISO 3166-1 alpha-2) where the aggregate offer is pending approval.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"ItemLevelIssue": { +"description": "The ItemLevelIssue of the product status.", +"id": "ItemLevelIssue", +"properties": { +"applicableCountries": { +"description": "List of country codes (ISO 3166-1 alpha-2) where issue applies to the aggregate offer.", +"items": { +"type": "string" +}, +"type": "array" +}, +"attribute": { +"description": "The attribute's name, if the issue is caused by a single attribute.", +"type": "string" +}, +"code": { +"description": "The error code of the issue.", +"type": "string" +}, +"description": { +"description": "A short issue description in English.", +"type": "string" +}, +"destination": { +"description": "The destination the issue applies to.", +"type": "string" +}, +"detail": { +"description": "A detailed issue description in English.", +"type": "string" +}, +"documentation": { +"description": "The URL of a web page to help with resolving this issue.", +"type": "string" +}, +"resolution": { +"description": "Whether the issue can be resolved by the merchant.", +"type": "string" +}, +"servability": { +"description": "How this issue affects serving of the aggregate offer.", +"type": "string" +} +}, +"type": "object" +}, +"ListAccountLabelsResponse": { +"description": "Response message for the `ListAccountLabels` method.", +"id": "ListAccountLabelsResponse", +"properties": { +"accountLabels": { +"description": "The labels from the specified account.", +"items": { +"$ref": "AccountLabel" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"ListChildAccountsResponse": { +"description": "Response message for the `ListChildAccounts` method.", +"id": "ListChildAccountsResponse", +"properties": { +"accounts": { +"description": "The CSS/MC accounts returned for the specified CSS parent account.", +"items": { +"$ref": "Account" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"ListCssProductsResponse": { +"description": "Response message for the ListCssProducts method.", +"id": "ListCssProductsResponse", +"properties": { +"cssProducts": { +"description": "The processed CSS products from the specified account. These are your processed CSS products after applying rules and supplemental feeds.", +"items": { +"$ref": "CssProduct" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"Price": { +"description": "The price represented as a number and currency.", +"id": "Price", +"properties": { +"amountMicros": { +"description": "The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).", +"format": "int64", +"type": "string" +}, +"currencyCode": { +"description": "The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).", +"type": "string" +} +}, +"type": "object" +}, +"ProductDetail": { +"description": "The product details.", +"id": "ProductDetail", +"properties": { +"attributeName": { +"description": "The name of the product detail.", +"type": "string" +}, +"attributeValue": { +"description": "The value of the product detail.", +"type": "string" +}, +"sectionName": { +"description": "The section header used to group a set of product details.", +"type": "string" +} +}, +"type": "object" +}, +"ProductDimension": { +"description": "The dimension of the product.", +"id": "ProductDimension", +"properties": { +"unit": { +"description": "Required. The dimension units. Acceptable values are: * \"`in`\" * \"`cm`\"", +"type": "string" +}, +"value": { +"description": "Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"ProductWeight": { +"description": "The weight of the product.", +"id": "ProductWeight", +"properties": { +"unit": { +"description": "Required. The weight unit. Acceptable values are: * \"`g`\" * \"`kg`\" * \"`oz`\" * \"`lb`\"", +"type": "string" +}, +"value": { +"description": "Required. The weight represented as a number. The weight can have a maximum precision of four decimal places.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"UpdateAccountLabelsRequest": { +"description": "The request message for the `UpdateLabels` method.", +"id": "UpdateAccountLabelsRequest", +"properties": { +"labelIds": { +"description": "The list of label IDs to overwrite the existing account label IDs. If the list is empty, all currently assigned label IDs will be deleted.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"parent": { +"description": "Optional. Only required when updating MC account labels. The CSS domain that is the parent resource of the MC account. Format: accounts/{account}", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "CSS API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json index 0357c69f8be..ef063dbb320 100644 --- a/googleapiclient/discovery_cache/documents/dataflow.v1b3.json +++ b/googleapiclient/discovery_cache/documents/dataflow.v1b3.json @@ -7,9 +7,6 @@ }, "https://www.googleapis.com/auth/compute": { "description": "View and manage your Google Compute Engine resources" -}, -"https://www.googleapis.com/auth/compute.readonly": { -"description": "View your Google Compute Engine resources" } } } @@ -44,8 +41,58 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-central2.rep.googleapis.com/", +"location": "us-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataflow.us-east7.rep.googleapis.com/", "location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dataflow.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -172,8 +219,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "workerMessages": { @@ -201,8 +247,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } }, @@ -287,8 +332,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "create": { @@ -343,8 +387,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "get": { @@ -398,8 +441,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "getMetrics": { @@ -442,8 +484,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "list": { @@ -524,8 +565,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "snapshot": { @@ -560,8 +600,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "update": { @@ -607,8 +646,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } }, @@ -647,8 +685,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "sendCapture": { @@ -683,8 +720,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -769,8 +805,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -809,8 +844,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "reportStatus": { @@ -845,8 +879,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -887,8 +920,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } }, @@ -927,8 +959,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -989,8 +1020,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "get": { @@ -1046,8 +1076,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "getExecutionDetails": { @@ -1097,8 +1126,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "getMetrics": { @@ -1143,8 +1171,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "list": { @@ -1227,8 +1254,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "snapshot": { @@ -1270,8 +1296,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "update": { @@ -1319,8 +1344,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } }, @@ -1366,8 +1390,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "sendCapture": { @@ -1409,8 +1432,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -1497,8 +1519,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -1541,8 +1562,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -1615,8 +1635,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -1662,8 +1681,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "reportStatus": { @@ -1705,8 +1723,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -1751,8 +1768,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "get": { @@ -1791,8 +1807,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "list": { @@ -1829,8 +1844,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -1869,8 +1883,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "get": { @@ -1918,8 +1931,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "launch": { @@ -1974,8 +1986,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -2018,8 +2029,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "list": { @@ -2054,8 +2064,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -2087,8 +2096,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "get": { @@ -2134,8 +2142,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] }, "launch": { @@ -2188,8 +2195,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/compute", -"https://www.googleapis.com/auth/compute.readonly" +"https://www.googleapis.com/auth/compute" ] } } @@ -2197,7 +2203,7 @@ } } }, -"revision": "20240624", +"revision": "20240709", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index 9c56048ca9a..ca7a422ff21 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -4343,6 +4343,32 @@ "https://www.googleapis.com/auth/dialogflow" ] }, +"getEncryptionSpec": { +"description": "Gets location-level encryption key specification.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.getEncryptionSpec", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the encryption spec resource to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowV2EncryptionSpec" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2/projects/{projectsId}/locations", @@ -7717,6 +7743,39 @@ } } }, +"encryptionSpec": { +"methods": { +"initialize": { +"description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.encryptionSpec.initialize", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:initialize", +"request": { +"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +}, "generators": { "methods": { "create": { @@ -8655,7 +8714,7 @@ } } }, -"revision": "20240617", +"revision": "20240704", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -9167,6 +9226,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, +"targetPlaybook": { +"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -11557,6 +11620,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, +"targetPlaybook": { +"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -15013,6 +15080,21 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudDialogflowV2EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -16217,6 +16299,29 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", +"properties": { +"request": { +"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudDialogflowV2EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2InputAudioConfig": { "description": "Instructs the speech recognizer how to process the audio content.", "id": "GoogleCloudDialogflowV2InputAudioConfig", @@ -19595,6 +19700,21 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudDialogflowV2beta1EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -19799,6 +19919,29 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", +"properties": { +"request": { +"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -21258,6 +21401,13 @@ true "readOnly": true, "type": "string" }, +"responseMessages": { +"description": "Optional. Automated agent responses.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" +}, +"type": "array" +}, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -21407,6 +21557,125 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ResponseMessage": { +"description": "Response messages from an automated agent.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessage", +"properties": { +"endInteraction": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", +"description": "A signal that indicates the interaction with the Dialogflow agent has ended." +}, +"liveAgentHandoff": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", +"description": "Hands off conversation to a live agent." +}, +"mixedAudio": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", +"description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." +}, +"payload": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Returns a response containing a custom, platform-specific payload.", +"type": "object" +}, +"telephonyTransferCall": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", +"description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." +}, +"text": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", +"description": "Returns a text response." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { +"description": "Indicates that interaction with the Dialogflow agent has ended.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", +"properties": {}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { +"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", +"properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { +"description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", +"properties": { +"segments": { +"description": "Segments this audio response is composed of.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { +"description": "Represents one segment of audio.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", +"properties": { +"allowPlaybackInterruption": { +"description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", +"type": "boolean" +}, +"audio": { +"description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", +"format": "byte", +"type": "string" +}, +"uri": { +"description": "Client-specific URI that points to an audio clip accessible to the client.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { +"description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", +"properties": { +"phoneNumber": { +"description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", +"type": "string" +}, +"sipUri": { +"description": "Transfer the call to a SIP endpoint.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageText": { +"description": "The text response message.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageText", +"properties": { +"text": { +"description": "A collection of text responses.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index ad31295c55a..3d334b12234 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -4108,6 +4108,32 @@ "https://www.googleapis.com/auth/dialogflow" ] }, +"getEncryptionSpec": { +"description": "Gets location-level encryption key specification.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.getEncryptionSpec", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the encryption spec resource to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2beta1/projects/{projectsId}/locations", @@ -7109,6 +7135,39 @@ } } }, +"encryptionSpec": { +"methods": { +"initialize": { +"description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.encryptionSpec.initialize", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}:initialize", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +}, "generators": { "methods": { "create": { @@ -8023,7 +8082,7 @@ } } }, -"revision": "20240617", +"revision": "20240704", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8535,6 +8594,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, +"targetPlaybook": { +"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -10925,6 +10988,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, +"targetPlaybook": { +"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -13274,6 +13341,21 @@ }, "type": "object" }, +"GoogleCloudDialogflowV2EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudDialogflowV2EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -13517,6 +13599,29 @@ }, "type": "object" }, +"GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", +"properties": { +"request": { +"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudDialogflowV2EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -16512,6 +16617,21 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudDialogflowV2beta1EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -17606,6 +17726,29 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", +"properties": { +"request": { +"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowV2beta1InputAudioConfig", @@ -19499,6 +19642,13 @@ true "readOnly": true, "type": "string" }, +"responseMessages": { +"description": "Optional. Automated agent responses.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" +}, +"type": "array" +}, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 2ccf651f72a..37ab72d10a3 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -4453,7 +4453,7 @@ } } }, -"revision": "20240617", +"revision": "20240704", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5273,6 +5273,10 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { +"model": { +"description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", +"type": "string" +}, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5364,6 +5368,10 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { +"model": { +"description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", +"type": "string" +}, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -5827,6 +5835,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, +"targetPlaybook": { +"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -7864,6 +7876,7 @@ false "NO_MATCH", "NO_INPUT", "EVENT", +"KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -7874,6 +7887,7 @@ false "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", +"The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -10712,6 +10726,10 @@ false "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, +"targetPlaybook": { +"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -13061,6 +13079,21 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudDialogflowV2EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -13304,6 +13337,29 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", +"properties": { +"request": { +"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudDialogflowV2EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -15125,6 +15181,21 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudDialogflowV2beta1EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -15329,6 +15400,29 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", +"properties": { +"request": { +"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -16788,6 +16882,13 @@ true "readOnly": true, "type": "string" }, +"responseMessages": { +"description": "Optional. Automated agent responses.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" +}, +"type": "array" +}, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -16937,6 +17038,125 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ResponseMessage": { +"description": "Response messages from an automated agent.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessage", +"properties": { +"endInteraction": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", +"description": "A signal that indicates the interaction with the Dialogflow agent has ended." +}, +"liveAgentHandoff": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", +"description": "Hands off conversation to a live agent." +}, +"mixedAudio": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", +"description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." +}, +"payload": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Returns a response containing a custom, platform-specific payload.", +"type": "object" +}, +"telephonyTransferCall": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", +"description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." +}, +"text": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", +"description": "Returns a text response." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { +"description": "Indicates that interaction with the Dialogflow agent has ended.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", +"properties": {}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { +"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", +"properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { +"description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", +"properties": { +"segments": { +"description": "Segments this audio response is composed of.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { +"description": "Represents one segment of audio.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", +"properties": { +"allowPlaybackInterruption": { +"description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", +"type": "boolean" +}, +"audio": { +"description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", +"format": "byte", +"type": "string" +}, +"uri": { +"description": "Client-specific URI that points to an audio clip accessible to the client.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { +"description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", +"properties": { +"phoneNumber": { +"description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", +"type": "string" +}, +"sipUri": { +"description": "Transfer the call to a SIP endpoint.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageText": { +"description": "The text response message.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageText", +"properties": { +"text": { +"description": "A collection of text responses.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 9b269057509..41558e76a42 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5185,7 +5185,7 @@ } } }, -"revision": "20240617", +"revision": "20240704", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5697,6 +5697,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, +"targetPlaybook": { +"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -8699,6 +8703,10 @@ "description": "Diagnostic info related to the answer generation model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsAnswerGenerationModelCallSignals", "properties": { +"model": { +"description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", +"type": "string" +}, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -8790,6 +8798,10 @@ "description": "Diagnostic info related to the rewriter model call.", "id": "GoogleCloudDialogflowCxV3beta1DataStoreConnectionSignalsRewriterModelCallSignals", "properties": { +"model": { +"description": "Name of the generative model. For example, \"gemini-ultra\", \"gemini-pro\", \"gemini-1.5-flash\" etc. Defaults to \"Other\" if the model is unknown.", +"type": "string" +}, "modelOutput": { "description": "Output of the generative model.", "type": "string" @@ -9257,6 +9269,10 @@ "description": "The target page to transition to. Format: `projects//locations//agents//flows//pages/`.", "type": "string" }, +"targetPlaybook": { +"description": "The target playbook to transition to. Format: `projects//locations//agents//playbooks/`.", +"type": "string" +}, "triggerFulfillment": { "$ref": "GoogleCloudDialogflowCxV3beta1Fulfillment", "description": "The fulfillment to call when the event occurs. Handling webhook errors with a fulfillment enabled with webhook could cause infinite loop. It is invalid to specify such fulfillment for a handler handling webhooks." @@ -11584,6 +11600,7 @@ false "NO_MATCH", "NO_INPUT", "EVENT", +"KNOWLEDGE_CONNECTOR", "PLAYBOOK" ], "enumDescriptions": [ @@ -11594,6 +11611,7 @@ false "No match was found for the query.", "Indicates an empty query.", "The query directly triggered an event.", +"The query was matched to a Knowledge Connector answer.", "The query was handled by a `Playbook`." ], "type": "string" @@ -14982,6 +15000,21 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudDialogflowV2EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2EntityType", @@ -15225,6 +15258,29 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecMetadata", +"properties": { +"request": { +"$ref": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudDialogflowV2EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2InputDataset": { "description": "InputDataset used to create model or do evaluation. NextID:5", "id": "GoogleCloudDialogflowV2InputDataset", @@ -17046,6 +17102,21 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudDialogflowV2beta1EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1EntityType": { "description": "Each intent parameter has a type, called the entity type, which dictates exactly how data from an end-user expression is extracted. Dialogflow provides predefined system entities that can match many common types of data. For example, there are system entities for matching dates, times, colors, email addresses, and so on. You can also create your own custom entities for matching custom data. For example, you could define a vegetable entity that can match the types of vegetables available for purchase with a grocery store agent. For more information, see the [Entity guide](https://cloud.google.com/dialogflow/docs/entities-overview).", "id": "GoogleCloudDialogflowV2beta1EntityType", @@ -17250,6 +17321,29 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecMetadata", +"properties": { +"request": { +"$ref": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudDialogflowV2beta1EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Intent": { "description": "An intent categorizes an end-user's intention for one conversation turn. For each agent, you define many intents, where your combined intents can handle a complete conversation. When an end-user writes or says something, referred to as an end-user expression or end-user input, Dialogflow matches the end-user input to the best intent in your agent. Matching an intent is also known as intent classification. For more information, see the [intent guide](https://cloud.google.com/dialogflow/docs/intents-overview).", "id": "GoogleCloudDialogflowV2beta1Intent", @@ -18709,6 +18803,13 @@ true "readOnly": true, "type": "string" }, +"responseMessages": { +"description": "Optional. Automated agent responses.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessage" +}, +"type": "array" +}, "sendTime": { "description": "Optional. The time when the message was sent.", "format": "google-datetime", @@ -18858,6 +18959,125 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ResponseMessage": { +"description": "Response messages from an automated agent.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessage", +"properties": { +"endInteraction": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", +"description": "A signal that indicates the interaction with the Dialogflow agent has ended." +}, +"liveAgentHandoff": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", +"description": "Hands off conversation to a live agent." +}, +"mixedAudio": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", +"description": "An audio response message composed of both the synthesized Dialogflow agent responses and the audios hosted in places known to the client." +}, +"payload": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Returns a response containing a custom, platform-specific payload.", +"type": "object" +}, +"telephonyTransferCall": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", +"description": "A signal that the client should transfer the phone call connected to this agent to a third-party endpoint." +}, +"text": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageText", +"description": "Returns a text response." +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction": { +"description": "Indicates that interaction with the Dialogflow agent has ended.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageEndInteraction", +"properties": {}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff": { +"description": "Indicates that the conversation should be handed off to a human agent. Dialogflow only uses this to determine which conversations were handed off to a human agent for measurement purposes. What else to do with this signal is up to you and your handoff procedures. You may set this, for example: * In the entry fulfillment of a CX Page if entering the page indicates something went extremely wrong in the conversation. * In a webhook response when you determine that the customer issue can only be handled by a human.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageLiveAgentHandoff", +"properties": { +"metadata": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Custom metadata for your handoff procedure. Dialogflow doesn't impose any structure on this.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio": { +"description": "Represents an audio message that is composed of both segments synthesized from the Dialogflow agent prompts and ones hosted externally at the specified URIs.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudio", +"properties": { +"segments": { +"description": "Segments this audio response is composed of.", +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment": { +"description": "Represents one segment of audio.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageMixedAudioSegment", +"properties": { +"allowPlaybackInterruption": { +"description": "Whether the playback of this segment can be interrupted by the end user's speech and the client should then start the next Dialogflow request.", +"type": "boolean" +}, +"audio": { +"description": "Raw audio synthesized from the Dialogflow agent's response using the output config specified in the request.", +"format": "byte", +"type": "string" +}, +"uri": { +"description": "Client-specific URI that points to an audio clip accessible to the client.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall": { +"description": "Represents the signal that telles the client to transfer the phone call connected to the agent to a third-party endpoint.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageTelephonyTransferCall", +"properties": { +"phoneNumber": { +"description": "Transfer the call to a phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164).", +"type": "string" +}, +"sipUri": { +"description": "Transfer the call to a SIP endpoint.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1ResponseMessageText": { +"description": "The text response message.", +"id": "GoogleCloudDialogflowV2beta1ResponseMessageText", +"properties": { +"text": { +"description": "A collection of text responses.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Sentiment": { "description": "The sentiment, such as positive/negative feeling or association, for a unit of analysis, such as the query text. See: https://cloud.google.com/natural-language/docs/basics#interpreting_sentiment_analysis_values for how to interpret the result.", "id": "GoogleCloudDialogflowV2beta1Sentiment", diff --git a/googleapiclient/discovery_cache/documents/discovery.v1.json b/googleapiclient/discovery_cache/documents/discovery.v1.json index 97434b0f0a2..a588116c681 100644 --- a/googleapiclient/discovery_cache/documents/discovery.v1.json +++ b/googleapiclient/discovery_cache/documents/discovery.v1.json @@ -234,10 +234,6 @@ "description": "The default value of this property (if one exists).", "type": "string" }, -"deprecated": { -"description": "Whether the parameter is deprecated.", -"type": "boolean" -}, "description": { "description": "A description of this object.", "type": "string" @@ -249,13 +245,6 @@ }, "type": "array" }, -"enumDeprecated": { -"description": "The deprecation status for the enums. Each position maps to the corresponding value in the \"enum\" array.", -"items": { -"type": "boolean" -}, -"type": "array" -}, "enumDescriptions": { "description": "The descriptions for the enums. Each position maps to the corresponding value in the \"enum\" array.", "items": { @@ -401,32 +390,6 @@ "description": "A link to human readable documentation for the API.", "type": "string" }, -"endpoints": { -"description": "A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status.", -"items": { -"description": "A single endpoint object", -"properties": { -"deprecated": { -"description": "Whether this endpoint is deprecated", -"type": "boolean" -}, -"description": { -"description": "A string describing the host designated by the URL", -"type": "string" -}, -"endpointUrl": { -"description": "The URL of the endpoint target host", -"type": "string" -}, -"location": { -"description": "The location of the endpoint", -"type": "string" -} -}, -"type": "object" -}, -"type": "array" -}, "etag": { "description": "The ETag for this response.", "readOnly": true, @@ -555,14 +518,6 @@ "RestMethod": { "id": "RestMethod", "properties": { -"apiVersion": { -"description": "The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter.", -"type": "string" -}, -"deprecated": { -"description": "Whether this method is deprecated.", -"type": "boolean" -}, "description": { "description": "Description of this method.", "type": "string" @@ -708,10 +663,6 @@ "RestResource": { "id": "RestResource", "properties": { -"deprecated": { -"description": "Whether this resource is deprecated.", -"type": "boolean" -}, "methods": { "additionalProperties": { "$ref": "RestMethod", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 2979816235f..333411ed03b 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -5711,7 +5711,7 @@ } } }, -"revision": "20240701", +"revision": "20240704", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6177,6 +6177,11 @@ "disable": { "description": "Disable query rephraser.", "type": "boolean" +}, +"maxRephraseSteps": { +"description": "Max rephrase steps. The max number is 5 steps. If not set or set to < 1, it will be set to 1 by default.", +"format": "int32", +"type": "integer" } }, "type": "object" @@ -12317,6 +12322,38 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { +"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { +"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", +"properties": { +"outputResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"description": "Output result indicating where the data were exported to." +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of the export operation." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -12746,6 +12783,32 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaOutputResult": { +"description": "Output result that stores the information about where the exported data is stored.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"properties": { +"bigqueryResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", +"description": "The BigQuery location where the result is stored." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { +"description": "A BigQuery output result.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", +"properties": { +"datasetId": { +"description": "The ID of a BigQuery Dataset.", +"type": "string" +}, +"tableId": { +"description": "The ID of a BigQuery Table.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 91c7d6a8757..3f6b0851113 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -6761,7 +6761,7 @@ } } }, -"revision": "20240701", +"revision": "20240704", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -11416,6 +11416,38 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { +"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { +"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", +"properties": { +"outputResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"description": "Output result indicating where the data were exported to." +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of the export operation." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaFactChunk": { "description": "Fact Chunk.", "id": "GoogleCloudDiscoveryengineV1alphaFactChunk", @@ -12409,6 +12441,32 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaOutputResult": { +"description": "Output result that stores the information about where the exported data is stored.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"properties": { +"bigqueryResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", +"description": "The BigQuery location where the result is stored." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { +"description": "A BigQuery output result.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", +"properties": { +"datasetId": { +"description": "The ID of a BigQuery Dataset.", +"type": "string" +}, +"tableId": { +"description": "The ID of a BigQuery Table.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaPageInfo": { "description": "Detailed page information.", "id": "GoogleCloudDiscoveryengineV1alphaPageInfo", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index fa33383aa34..3a7a3ab31b8 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -6175,7 +6175,7 @@ } } }, -"revision": "20240701", +"revision": "20240704", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -9150,6 +9150,38 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { +"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { +"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", +"properties": { +"outputResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"description": "Output result indicating where the data were exported to." +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of the export operation." +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaFieldConfig": { "description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", "id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", @@ -9579,6 +9611,32 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaOutputResult": { +"description": "Output result that stores the information about where the exported data is stored.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"properties": { +"bigqueryResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", +"description": "The BigQuery location where the result is stored." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { +"description": "A BigQuery output result.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", +"properties": { +"datasetId": { +"description": "The ID of a BigQuery Dataset.", +"type": "string" +}, +"tableId": { +"description": "The ID of a BigQuery Table.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaProject": { "description": "Metadata and configurations for a Google Cloud project in the service.", "id": "GoogleCloudDiscoveryengineV1alphaProject", diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index 5a51cbefe70..a893dcc91da 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -23,13 +23,213 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dlp.asia-east1.rep.googleapis.com/", +"location": "asia-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.asia-east2.rep.googleapis.com/", +"location": "asia-east2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.asia-northeast1.rep.googleapis.com/", +"location": "asia-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.asia-northeast2.rep.googleapis.com/", +"location": "asia-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.asia-northeast3.rep.googleapis.com/", +"location": "asia-northeast3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.asia-south2.rep.googleapis.com/", +"location": "asia-south2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.asia-southeast1.rep.googleapis.com/", +"location": "asia-southeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.asia-southeast2.rep.googleapis.com/", +"location": "asia-southeast2" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dlp.australia-southeast1.rep.googleapis.com/", "location": "australia-southeast1" }, { "description": "Regional Endpoint", +"endpointUrl": "https://dlp.australia-southeast2.rep.googleapis.com/", +"location": "australia-southeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-central2.rep.googleapis.com/", +"location": "europe-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-north1.rep.googleapis.com/", +"location": "europe-north1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-north2.rep.googleapis.com/", +"location": "europe-north2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-southwest1.rep.googleapis.com/", +"location": "europe-southwest1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-west1.rep.googleapis.com/", +"location": "europe-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-west12.rep.googleapis.com/", +"location": "europe-west12" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-west2.rep.googleapis.com/", +"location": "europe-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-west3.rep.googleapis.com/", +"location": "europe-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-west4.rep.googleapis.com/", +"location": "europe-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.europe-west8.rep.googleapis.com/", +"location": "europe-west8" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dlp.europe-west9.rep.googleapis.com/", "location": "europe-west9" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.me-central1.rep.googleapis.com/", +"location": "me-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.me-central2.rep.googleapis.com/", +"location": "me-central2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.me-west1.rep.googleapis.com/", +"location": "me-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.northamerica-northeast1.rep.googleapis.com/", +"location": "northamerica-northeast1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.northamerica-northeast2.rep.googleapis.com/", +"location": "northamerica-northeast2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.northamerica-south1.rep.googleapis.com/", +"location": "northamerica-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.southamerica-east1.rep.googleapis.com/", +"location": "southamerica-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.southamerica-west1.rep.googleapis.com/", +"location": "southamerica-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-central1.rep.googleapis.com/", +"location": "us-central1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-east1.rep.googleapis.com/", +"location": "us-east1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-east4.rep.googleapis.com/", +"location": "us-east4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-east5.rep.googleapis.com/", +"location": "us-east5" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-south1.rep.googleapis.com/", +"location": "us-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-west3.rep.googleapis.com/", +"location": "us-west3" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-west4.rep.googleapis.com/", +"location": "us-west4" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://dlp.us-west8.rep.googleapis.com/", +"location": "us-west8" } ], "fullyEncodeReservedExpansion": true, @@ -4774,7 +4974,7 @@ } } }, -"revision": "20240702", +"revision": "20240707", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -6369,7 +6569,7 @@ "id": "GooglePrivacyDlpV2DataProfileLocation", "properties": { "folderId": { -"description": "The ID of the Folder within an organization to scan.", +"description": "The ID of the folder within an organization to scan.", "format": "int64", "type": "string" }, @@ -7376,7 +7576,7 @@ "id": "GooglePrivacyDlpV2DiscoveryStartingLocation", "properties": { "folderId": { -"description": "The ID of the Folder within an organization to scan.", +"description": "The ID of the folder within an organization to scan.", "format": "int64", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json index ef9c6a499c9..f5112321e75 100644 --- a/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json +++ b/googleapiclient/discovery_cache/documents/essentialcontacts.v1.json @@ -850,7 +850,7 @@ } } }, -"revision": "20240630", +"revision": "20240707", "rootUrl": "https://essentialcontacts.googleapis.com/", "schemas": { "GoogleCloudEssentialcontactsV1ComputeContactsResponse": { @@ -923,7 +923,7 @@ "type": "string" }, "validationState": { -"description": "The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.", +"description": "Output only. The validity of the contact. A contact is considered valid if it is the correct recipient for notifications for a particular resource.", "enum": [ "VALIDATION_STATE_UNSPECIFIED", "VALID", @@ -934,6 +934,7 @@ "The contact is marked as valid. This is usually done manually by the contact admin. All new contacts begin in the valid state.", "The contact is considered invalid. This may become the state if the contact's email is found to be unreachable." ], +"readOnly": true, "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json index abd228bcf76..4641a75596c 100644 --- a/googleapiclient/discovery_cache/documents/file.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json @@ -1069,7 +1069,7 @@ } } }, -"revision": "20240626", +"revision": "20240704", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1098,6 +1098,21 @@ "readOnly": true, "type": "string" }, +"fileSystemProtocol": { +"description": "Output only. The file system protocol of the source Filestore instance that this backup is created from.", +"enum": [ +"FILE_PROTOCOL_UNSPECIFIED", +"NFS_V3", +"NFS_V4_1" +], +"enumDescriptions": [ +"FILE_PROTOCOL_UNSPECIFIED serves a \"not set\" default value when a FileProtocol is a separate field in a message.", +"NFS 3.0.", +"NFS 4.1." +], +"readOnly": true, +"type": "string" +}, "kmsKeyName": { "description": "Immutable. KMS key name used for data encryption.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 5f6c252fb30..8d5a96ad9c0 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -585,7 +585,7 @@ } } }, -"revision": "20240708", +"revision": "20240710", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GoogleFirebaseAppdistroV1Release": { @@ -708,16 +708,16 @@ "steps": { "description": "Required. Steps to be accomplished by the AI", "items": { -"$ref": "GoogleFirebaseAppdistroV1alphaAiInstructionsStep" +"$ref": "GoogleFirebaseAppdistroV1alphaAiStep" }, "type": "array" } }, "type": "object" }, -"GoogleFirebaseAppdistroV1alphaAiInstructionsStep": { +"GoogleFirebaseAppdistroV1alphaAiStep": { "description": "A step to be accomplished by the AI", -"id": "GoogleFirebaseAppdistroV1alphaAiInstructionsStep", +"id": "GoogleFirebaseAppdistroV1alphaAiStep", "properties": { "assertion": { "description": "An assertion to be checked by the AI", @@ -730,6 +730,34 @@ }, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaAiStepResult": { +"description": "Captures the results of an AiStep", +"id": "GoogleFirebaseAppdistroV1alphaAiStepResult", +"properties": { +"state": { +"description": "Output only. The current state of the step", +"enum": [ +"STEP_STATE_UNSPECIFIED", +"IN_PROGRESS", +"PASSED", +"FAILED" +], +"enumDescriptions": [ +"Step state unspecified", +"The step is in progress", +"The step has completed successfully", +"The step has failed" +], +"readOnly": true, +"type": "string" +}, +"step": { +"$ref": "GoogleFirebaseAppdistroV1alphaAiStep", +"description": "Required. The step performed by the AI" +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaApp": { "id": "GoogleFirebaseAppdistroV1alphaApp", "properties": { @@ -818,6 +846,14 @@ "description": "The results of running an automated test on a particular device.", "id": "GoogleFirebaseAppdistroV1alphaDeviceExecution", "properties": { +"aiStepResults": { +"description": "Output only. Results of the AI steps if passed in", +"items": { +"$ref": "GoogleFirebaseAppdistroV1alphaAiStepResult" +}, +"readOnly": true, +"type": "array" +}, "appCrash": { "$ref": "GoogleFirebaseAppdistroV1alphaAppCrash", "description": "Output only. An app crash, if any occurred during the test.", diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 6350b16cff7..26f47eed32b 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -1706,7 +1706,7 @@ } } }, -"revision": "20240626", +"revision": "20240630", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2499,7 +2499,7 @@ "type": "string" }, "retention": { -"description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days.", +"description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks.", "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 22ce49c03b6..46ac9e34f77 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -1146,6 +1146,122 @@ }, "rbacrolebindings": { "methods": { +"create": { +"description": "Creates a Membership RBACRoleBinding.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings", +"httpMethod": "POST", +"id": "gkehub.projects.locations.memberships.rbacrolebindings.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", +"required": true, +"type": "string" +}, +"rbacrolebindingId": { +"description": "Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/rbacrolebindings", +"request": { +"$ref": "RBACRoleBinding" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a Membership RBACRoleBinding.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", +"httpMethod": "DELETE", +"id": "gkehub.projects.locations.memberships.rbacrolebindings.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generateMembershipRBACRoleBindingYAML": { +"description": "Generates a YAML of the RBAC policies for the specified RoleBinding and its associated impersonation resources.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings:generateMembershipRBACRoleBindingYAML", +"httpMethod": "POST", +"id": "gkehub.projects.locations.memberships.rbacrolebindings.generateMembershipRBACRoleBindingYAML", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent (project and location) where the RBACRoleBinding will be created. Specified in the format `projects/*/locations/*/memberships/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", +"required": true, +"type": "string" +}, +"rbacrolebindingId": { +"description": "Required. Client chosen ID for the RBACRoleBinding. `rbacrolebinding_id` must be a valid RFC 1123 compliant DNS label: 1. At most 63 characters in length 2. It must consist of lower case alphanumeric characters or `-` 3. It must start and end with an alphanumeric character Which can be expressed as the regex: `[a-z0-9]([-a-z0-9]*[a-z0-9])?`, with a maximum length of 63 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/rbacrolebindings:generateMembershipRBACRoleBindingYAML", +"request": { +"$ref": "RBACRoleBinding" +}, +"response": { +"$ref": "GenerateMembershipRBACRoleBindingYAMLResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Returns the details of a Membership RBACRoleBinding.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", +"httpMethod": "GET", +"id": "gkehub.projects.locations.memberships.rbacrolebindings.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The RBACRoleBinding resource name in the format `projects/*/locations/*/memberships/*/rbacrolebindings/*`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "RBACRoleBinding" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists all Membership RBACRoleBindings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings", @@ -1181,6 +1297,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Updates a Membership RBACRoleBinding.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}/rbacrolebindings/{rbacrolebindingsId}", +"httpMethod": "PATCH", +"id": "gkehub.projects.locations.memberships.rbacrolebindings.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The resource name for the rbacrolebinding `projects/{project}/locations/{location}/scopes/{scope}/rbacrolebindings/{rbacrolebinding}` or `projects/{project}/locations/{location}/memberships/{membership}/rbacrolebindings/{rbacrolebinding}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+/rbacrolebindings/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. The fields to be updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "RBACRoleBinding" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -1951,7 +2101,7 @@ } } }, -"revision": "20240623", +"revision": "20240706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -2545,6 +2695,24 @@ ], "type": "string" }, +"otelCollector": { +"description": "Deployment state of otel-collector", +"enum": [ +"DEPLOYMENT_STATE_UNSPECIFIED", +"NOT_INSTALLED", +"INSTALLED", +"ERROR", +"PENDING" +], +"enumDescriptions": [ +"Deployment's state cannot be determined", +"Deployment is not installed", +"Deployment is installed", +"Deployment was attempted to be installed, but has errors", +"Deployment is installing or terminating" +], +"type": "string" +}, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2563,6 +2731,24 @@ ], "type": "string" }, +"resourceGroupControllerManager": { +"description": "Deployment state of resource-group-controller-manager", +"enum": [ +"DEPLOYMENT_STATE_UNSPECIFIED", +"NOT_INSTALLED", +"INSTALLED", +"ERROR", +"PENDING" +], +"enumDescriptions": [ +"Deployment's state cannot be determined", +"Deployment is not installed", +"Deployment is installed", +"Deployment was attempted to be installed, but has errors", +"Deployment is installing or terminating" +], +"type": "string" +}, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -2698,7 +2884,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { -"description": "Version of the deployed admission_webhook pod", +"description": "Version of the deployed admission-webhook pod", "type": "string" }, "gitSync": { @@ -2713,10 +2899,18 @@ "description": "Version of the deployed monitor pod", "type": "string" }, +"otelCollector": { +"description": "Version of the deployed otel-collector pod", +"type": "string" +}, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, +"resourceGroupControllerManager": { +"description": "Version of the deployed resource-group-controller-manager pod", +"type": "string" +}, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -3784,6 +3978,17 @@ }, "type": "object" }, +"GenerateMembershipRBACRoleBindingYAMLResponse": { +"description": "Response for GenerateRBACRoleBindingYAML.", +"id": "GenerateMembershipRBACRoleBindingYAMLResponse", +"properties": { +"roleBindingsYaml": { +"description": "a yaml text blob including the RBAC policies.", +"type": "string" +} +}, +"type": "object" +}, "GkeCluster": { "description": "GkeCluster contains information specific to GKE clusters.", "id": "GkeCluster", @@ -6006,7 +6211,7 @@ "type": "string" }, "management": { -"description": "Enables automatic Service Mesh management.", +"description": "Optional. Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index 2a72c1924a8..d7ea8f58c7d 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2175,7 +2175,7 @@ } } }, -"revision": "20240623", +"revision": "20240706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2970,6 +2970,24 @@ ], "type": "string" }, +"otelCollector": { +"description": "Deployment state of otel-collector", +"enum": [ +"DEPLOYMENT_STATE_UNSPECIFIED", +"NOT_INSTALLED", +"INSTALLED", +"ERROR", +"PENDING" +], +"enumDescriptions": [ +"Deployment's state cannot be determined", +"Deployment is not installed", +"Deployment is installed", +"Deployment was attempted to be installed, but has errors", +"Deployment is installing or terminating" +], +"type": "string" +}, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2988,6 +3006,24 @@ ], "type": "string" }, +"resourceGroupControllerManager": { +"description": "Deployment state of resource-group-controller-manager", +"enum": [ +"DEPLOYMENT_STATE_UNSPECIFIED", +"NOT_INSTALLED", +"INSTALLED", +"ERROR", +"PENDING" +], +"enumDescriptions": [ +"Deployment's state cannot be determined", +"Deployment is not installed", +"Deployment is installed", +"Deployment was attempted to be installed, but has errors", +"Deployment is installing or terminating" +], +"type": "string" +}, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -3123,7 +3159,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { -"description": "Version of the deployed admission_webhook pod", +"description": "Version of the deployed admission-webhook pod", "type": "string" }, "gitSync": { @@ -3138,10 +3174,18 @@ "description": "Version of the deployed monitor pod", "type": "string" }, +"otelCollector": { +"description": "Version of the deployed otel-collector pod", +"type": "string" +}, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, +"resourceGroupControllerManager": { +"description": "Version of the deployed resource-group-controller-manager pod", +"type": "string" +}, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -6690,6 +6734,20 @@ "description": "**Service Mesh**: Spec for a single Membership for the servicemesh feature", "id": "ServiceMeshMembershipSpec", "properties": { +"configApi": { +"description": "Optional. Specifies the API that will be used for configuring the mesh workloads.", +"enum": [ +"CONFIG_API_UNSPECIFIED", +"CONFIG_API_ISTIO", +"CONFIG_API_GATEWAY" +], +"enumDescriptions": [ +"Unspecified", +"Use the Istio API for configuration.", +"Use the K8s Gateway API for configuration." +], +"type": "string" +}, "controlPlane": { "deprecated": true, "description": "Deprecated: use `management` instead Enables automatic control plane management.", @@ -6706,6 +6764,7 @@ "type": "string" }, "defaultChannel": { +"deprecated": true, "description": "Determines which release channel to use for default injection and service mesh APIs.", "enum": [ "CHANNEL_UNSPECIFIED", @@ -6722,7 +6781,7 @@ "type": "string" }, "management": { -"description": "Enables automatic Service Mesh management.", +"description": "Optional. Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 9c5e76f826f..c85ec8a75a0 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2101,7 +2101,7 @@ } } }, -"revision": "20240623", +"revision": "20240706", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2780,6 +2780,24 @@ ], "type": "string" }, +"otelCollector": { +"description": "Deployment state of otel-collector", +"enum": [ +"DEPLOYMENT_STATE_UNSPECIFIED", +"NOT_INSTALLED", +"INSTALLED", +"ERROR", +"PENDING" +], +"enumDescriptions": [ +"Deployment's state cannot be determined", +"Deployment is not installed", +"Deployment is installed", +"Deployment was attempted to be installed, but has errors", +"Deployment is installing or terminating" +], +"type": "string" +}, "reconcilerManager": { "description": "Deployment state of reconciler-manager pod", "enum": [ @@ -2798,6 +2816,24 @@ ], "type": "string" }, +"resourceGroupControllerManager": { +"description": "Deployment state of resource-group-controller-manager", +"enum": [ +"DEPLOYMENT_STATE_UNSPECIFIED", +"NOT_INSTALLED", +"INSTALLED", +"ERROR", +"PENDING" +], +"enumDescriptions": [ +"Deployment's state cannot be determined", +"Deployment is not installed", +"Deployment is installed", +"Deployment was attempted to be installed, but has errors", +"Deployment is installing or terminating" +], +"type": "string" +}, "rootReconciler": { "description": "Deployment state of root-reconciler", "enum": [ @@ -2933,7 +2969,7 @@ "id": "ConfigManagementConfigSyncVersion", "properties": { "admissionWebhook": { -"description": "Version of the deployed admission_webhook pod", +"description": "Version of the deployed admission-webhook pod", "type": "string" }, "gitSync": { @@ -2948,10 +2984,18 @@ "description": "Version of the deployed monitor pod", "type": "string" }, +"otelCollector": { +"description": "Version of the deployed otel-collector pod", +"type": "string" +}, "reconcilerManager": { "description": "Version of the deployed reconciler-manager pod", "type": "string" }, +"resourceGroupControllerManager": { +"description": "Version of the deployed resource-group-controller-manager pod", +"type": "string" +}, "rootReconciler": { "description": "Version of the deployed reconciler container in root-reconciler pod", "type": "string" @@ -6330,7 +6374,7 @@ "type": "string" }, "management": { -"description": "Enables automatic Service Mesh management.", +"description": "Optional. Enables automatic Service Mesh management.", "enum": [ "MANAGEMENT_UNSPECIFIED", "MANAGEMENT_AUTOMATIC", diff --git a/googleapiclient/discovery_cache/documents/identitytoolkit.v3.json b/googleapiclient/discovery_cache/documents/identitytoolkit.v3.json index 959d3bb7127..3fec5f32005 100644 --- a/googleapiclient/discovery_cache/documents/identitytoolkit.v3.json +++ b/googleapiclient/discovery_cache/documents/identitytoolkit.v3.json @@ -18,7 +18,7 @@ "description": "Help the third party sites to implement federated login.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/identity-toolkit/v3/", -"etag": "\"9eZ1uxVRThTDhLJCZHhqs3eQWz4/taa97NuhcHSAt0fUktvGBcH-OqE\"", +"etag": "\"J3WqvAcMk4eQjJXvfSI4Yr8VouA/3oj2ig7C4N6A-_tqqb8y4vu2RvM\"", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json index b3659d17e3e..9c6e6ad7a11 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1.json @@ -4140,7 +4140,7 @@ } } }, -"revision": "20240701", +"revision": "20240707", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -11100,16 +11100,20 @@ false "description": "Request to Import template", "id": "GoogleCloudIntegrationsV1alphaImportTemplateRequest", "properties": { -"configParameters": { -"description": "Optional. Config parameters which would be used to configure template bundles.", -"items": { -"$ref": "GoogleCloudIntegrationsV1alphaIntegrationConfigParameter" -}, -"type": "array" -}, "integration": { "description": "Required. Name of the integration where template needs to be imported.", "type": "string" +}, +"integrationRegion": { +"description": "Required. The region of the Integration to be created.", +"type": "string" +}, +"subIntegrations": { +"additionalProperties": { +"$ref": "GoogleCloudIntegrationsV1alphaUseTemplateRequestIntegrationDetails" +}, +"description": "Optional. Sub Integration which would be created via templates.", +"type": "object" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/logging.v2.json b/googleapiclient/discovery_cache/documents/logging.v2.json index 55088895965..9dde22f0993 100644 --- a/googleapiclient/discovery_cache/documents/logging.v2.json +++ b/googleapiclient/discovery_cache/documents/logging.v2.json @@ -1362,6 +1362,11 @@ "parent" ], "parameters": { +"filter": { +"description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", +"location": "query", +"type": "string" +}, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -2053,7 +2058,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", +"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^folders/[^/]+$", "required": true, @@ -3274,6 +3279,11 @@ "parent" ], "parameters": { +"filter": { +"description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", +"location": "query", +"type": "string" +}, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -4700,7 +4710,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", +"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^organizations/[^/]+$", "required": true, @@ -5921,6 +5931,11 @@ "parent" ], "parameters": { +"filter": { +"description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", +"location": "query", +"type": "string" +}, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -7552,6 +7567,11 @@ "parent" ], "parameters": { +"filter": { +"description": "Optional. Specifies the type (\"Logging\" or \"OpsAnalytics\") and the visibility (PRIVATE or SHARED) of the saved queries to list. If provided, the filter must contain either the type function or a visibility token, or both. If both are chosen, they can be placed in any order, but they must be joined by the AND operator or the empty character.The two supported type function calls are: type(\"Logging\") type(\"OpsAnalytics\")The two supported visibility tokens are: visibility = PRIVATE visibility = SHAREDFor example:type(\"Logging\") AND visibility = PRIVATE visibility=SHARED type(\"OpsAnalytics\") type(\"OpsAnalytics)\" visibility = PRIVATE visibility = SHARED", +"location": "query", +"type": "string" +}, "pageSize": { "description": "Optional. The maximum number of results to return from this request.Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", @@ -8376,7 +8396,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" For example:\"organizations/12345/settings\"", +"description": "Required. The resource name for the settings to update. \"organizations/[ORGANIZATION_ID]/settings\" \"folders/[FOLDER_ID]/settings\" For example:\"organizations/12345/settings\"", "location": "path", "pattern": "^[^/]+/[^/]+$", "required": true, @@ -8404,7 +8424,7 @@ } } }, -"revision": "20240620", +"revision": "20240705", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 6b6fc265255..6b2052102d3 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -175,192 +175,191 @@ "https://www.googleapis.com/auth/content" ] }, -"getBusinessIdentity": { -"description": "Retrieves the business identity of an account.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", +"list": { +"description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.", +"flatPath": "accounts/v1beta/accounts", "httpMethod": "GET", -"id": "merchantapi.accounts.getBusinessIdentity", -"parameterOrder": [ -"name" -], +"id": "merchantapi.accounts.list", +"parameterOrder": [], "parameters": { -"name": { -"description": "Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", -"location": "path", -"pattern": "^accounts/[^/]+/businessIdentity$", -"required": true, +"filter": { +"description": "Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", +"location": "query", "type": "string" } }, -"path": "accounts/v1beta/{+name}", +"path": "accounts/v1beta/accounts", "response": { -"$ref": "BusinessIdentity" +"$ref": "ListAccountsResponse" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, -"getBusinessInfo": { -"description": "Retrieves the business info of an account.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", +"listSubaccounts": { +"description": "List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type=\"ACCOUNT_AGGREGATION\"))`", +"flatPath": "accounts/v1beta/accounts/{accountsId}:listSubaccounts", "httpMethod": "GET", -"id": "merchantapi.accounts.getBusinessInfo", +"id": "merchantapi.accounts.listSubaccounts", "parameterOrder": [ -"name" +"provider" ], "parameters": { -"name": { -"description": "Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`", +"pageSize": { +"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"provider": { +"description": "Required. The parent account. Format: `accounts/{account}`", "location": "path", -"pattern": "^accounts/[^/]+/businessInfo$", +"pattern": "^accounts/[^/]+$", "required": true, "type": "string" } }, -"path": "accounts/v1beta/{+name}", +"path": "accounts/v1beta/{+provider}:listSubaccounts", "response": { -"$ref": "BusinessInfo" +"$ref": "ListSubAccountsResponse" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, -"getHomepage": { -"description": "Retrieves a store's homepage.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", -"httpMethod": "GET", -"id": "merchantapi.accounts.getHomepage", +"patch": { +"description": "Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.", +"flatPath": "accounts/v1beta/accounts/{accountsId}", +"httpMethod": "PATCH", +"id": "merchantapi.accounts.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`", +"description": "Identifier. The resource name of the account. Format: `accounts/{account}`", "location": "path", -"pattern": "^accounts/[^/]+/homepage$", +"pattern": "^accounts/[^/]+$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Required. List of fields being updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "accounts/v1beta/{+name}", +"request": { +"$ref": "Account" +}, "response": { -"$ref": "Homepage" +"$ref": "Account" }, "scopes": [ "https://www.googleapis.com/auth/content" ] +} }, -"getShippingSettings": { -"description": "Retrieve shipping setting information.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings", +"resources": { +"accounttax": { +"methods": { +"get": { +"description": "Returns the tax rules that match the conditions of GetAccountTaxRequest", +"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", "httpMethod": "GET", -"id": "merchantapi.accounts.getShippingSettings", +"id": "merchantapi.accounts.accounttax.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`", +"description": "Required. The name from which tax settings will be retrieved", "location": "path", -"pattern": "^accounts/[^/]+/shippingSettings$", +"pattern": "^accounts/[^/]+/accounttax/[^/]+$", "required": true, "type": "string" } }, "path": "accounts/v1beta/{+name}", "response": { -"$ref": "ShippingSettings" +"$ref": "AccountTax" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, "list": { -"description": "Lists accounts accessible to the calling user and matching the constraints of the request such as page size or filters. This is not just listing the sub-accounts of an MCA, but all accounts the calling user has access to including other MCAs, linked accounts, standalone accounts and so on.", -"flatPath": "accounts/v1beta/accounts", -"httpMethod": "GET", -"id": "merchantapi.accounts.list", -"parameterOrder": [], -"parameters": { -"filter": { -"description": "Optional. Returns only accounts that match the [filter](/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](/merchant/api/guides/accounts/filter-syntax).", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", -"location": "query", -"type": "string" -} -}, -"path": "accounts/v1beta/accounts", -"response": { -"$ref": "ListAccountsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"listSubaccounts": { -"description": "List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful `ListAccounts` method. This method will produce the same results as calling `ListsAccounts` with the following filter: `relationship(providerId={parent} AND service(type=\"ACCOUNT_AGGREGATION\"))`", -"flatPath": "accounts/v1beta/accounts/{accountsId}:listSubaccounts", +"description": "Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax", "httpMethod": "GET", -"id": "merchantapi.accounts.listSubaccounts", +"id": "merchantapi.accounts.accounttax.list", "parameterOrder": [ -"provider" +"parent" ], "parameters": { "pageSize": { -"description": "Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.", +"description": "The maximum number of tax settings to return in the response, used for paging.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccounts` must match the call that provided the page token.", +"description": "The token returned by the previous request.", "location": "query", "type": "string" }, -"provider": { -"description": "Required. The parent account. Format: `accounts/{account}`", +"parent": { +"description": "Required. The parent, which owns this collection of account tax. Format: accounts/{account}", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, "type": "string" } }, -"path": "accounts/v1beta/{+provider}:listSubaccounts", +"path": "accounts/v1beta/{+parent}/accounttax", "response": { -"$ref": "ListSubAccountsResponse" +"$ref": "ListAccountTaxResponse" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, "patch": { -"description": "Updates an account regardless of its type: standalone, MCA or sub-account. Executing this method requires admin access.", -"flatPath": "accounts/v1beta/accounts/{accountsId}", +"description": "Updates the tax settings of the account.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", "httpMethod": "PATCH", -"id": "merchantapi.accounts.patch", +"id": "merchantapi.accounts.accounttax.patch", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name of the account. Format: `accounts/{account}`", +"description": "Identifier. The name of the tax setting. Format: \"{account_tax.name=accounts/{account}}\"", "location": "path", -"pattern": "^accounts/[^/]+$", +"pattern": "^accounts/[^/]+/accounttax/[^/]+$", "required": true, "type": "string" }, "updateMask": { -"description": "Required. List of fields being updated.", +"description": "The list of fields to be updated", "format": "google-fieldmask", "location": "query", "type": "string" @@ -368,10 +367,39 @@ }, "path": "accounts/v1beta/{+name}", "request": { -"$ref": "Account" +"$ref": "AccountTax" }, "response": { -"$ref": "Account" +"$ref": "AccountTax" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +} +} +}, +"businessIdentity": { +"methods": { +"getBusinessIdentity": { +"description": "Retrieves the business identity of an account.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", +"httpMethod": "GET", +"id": "merchantapi.accounts.businessIdentity.getBusinessIdentity", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the business identity. Format: `accounts/{account}/businessIdentity`", +"location": "path", +"pattern": "^accounts/[^/]+/businessIdentity$", +"required": true, +"type": "string" +} +}, +"path": "accounts/v1beta/{+name}", +"response": { +"$ref": "BusinessIdentity" }, "scopes": [ "https://www.googleapis.com/auth/content" @@ -381,7 +409,7 @@ "description": "Updates the business identity of an account. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/businessIdentity", "httpMethod": "PATCH", -"id": "merchantapi.accounts.updateBusinessIdentity", +"id": "merchantapi.accounts.businessIdentity.updateBusinessIdentity", "parameterOrder": [ "name" ], @@ -410,34 +438,29 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] +} +} }, -"updateBusinessInfo": { -"description": "Updates the business info of an account. Executing this method requires admin access.", +"businessInfo": { +"methods": { +"getBusinessInfo": { +"description": "Retrieves the business info of an account.", "flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", -"httpMethod": "PATCH", -"id": "merchantapi.accounts.updateBusinessInfo", +"httpMethod": "GET", +"id": "merchantapi.accounts.businessInfo.getBusinessInfo", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`", +"description": "Required. The resource name of the business info. Format: `accounts/{account}/businessInfo`", "location": "path", "pattern": "^accounts/[^/]+/businessInfo$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. List of fields being updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" } }, "path": "accounts/v1beta/{+name}", -"request": { -"$ref": "BusinessInfo" -}, "response": { "$ref": "BusinessInfo" }, @@ -445,19 +468,19 @@ "https://www.googleapis.com/auth/content" ] }, -"updateHomepage": { -"description": "Updates a store's homepage. Executing this method requires admin access.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", +"updateBusinessInfo": { +"description": "Updates the business info of an account. Executing this method requires admin access.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/businessInfo", "httpMethod": "PATCH", -"id": "merchantapi.accounts.updateHomepage", +"id": "merchantapi.accounts.businessInfo.updateBusinessInfo", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`", +"description": "Identifier. The resource name of the business info. Format: `accounts/{account}/businessInfo`", "location": "path", -"pattern": "^accounts/[^/]+/homepage$", +"pattern": "^accounts/[^/]+/businessInfo$", "required": true, "type": "string" }, @@ -470,98 +493,62 @@ }, "path": "accounts/v1beta/{+name}", "request": { -"$ref": "Homepage" +"$ref": "BusinessInfo" }, "response": { -"$ref": "Homepage" +"$ref": "BusinessInfo" }, "scopes": [ "https://www.googleapis.com/auth/content" ] } +} }, -"resources": { -"accounttax": { +"emailpreferences": { "methods": { -"get": { -"description": "Returns the tax rules that match the conditions of GetAccountTaxRequest", -"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", +"getEmailPreferences": { +"description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", "httpMethod": "GET", -"id": "merchantapi.accounts.accounttax.get", +"id": "merchantapi.accounts.emailpreferences.getEmailPreferences", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Required. The name from which tax settings will be retrieved", +"description": "Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`", "location": "path", -"pattern": "^accounts/[^/]+/accounttax/[^/]+$", +"pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", "required": true, "type": "string" } }, "path": "accounts/v1beta/{+name}", "response": { -"$ref": "AccountTax" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, -"list": { -"description": "Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax", -"httpMethod": "GET", -"id": "merchantapi.accounts.accounttax.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "The maximum number of tax settings to return in the response, used for paging.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The token returned by the previous request.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent, which owns this collection of account tax. Format: accounts/{account}", -"location": "path", -"pattern": "^accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "accounts/v1beta/{+parent}/accounttax", -"response": { -"$ref": "ListAccountTaxResponse" +"$ref": "EmailPreferences" }, "scopes": [ "https://www.googleapis.com/auth/content" ] }, -"patch": { -"description": "Updates the tax settings of the account.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", +"updateEmailPreferences": { +"description": "Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", "httpMethod": "PATCH", -"id": "merchantapi.accounts.accounttax.patch", +"id": "merchantapi.accounts.emailpreferences.updateEmailPreferences", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "Identifier. The name of the tax setting. Format: \"{account_tax.name=accounts/{account}}\"", +"description": "Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.", "location": "path", -"pattern": "^accounts/[^/]+/accounttax/[^/]+$", +"pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", "required": true, "type": "string" }, "updateMask": { -"description": "The list of fields to be updated", +"description": "Required. List of fields being updated.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -569,10 +556,10 @@ }, "path": "accounts/v1beta/{+name}", "request": { -"$ref": "AccountTax" +"$ref": "EmailPreferences" }, "response": { -"$ref": "AccountTax" +"$ref": "EmailPreferences" }, "scopes": [ "https://www.googleapis.com/auth/content" @@ -610,6 +597,31 @@ "https://www.googleapis.com/auth/content" ] }, +"getHomepage": { +"description": "Retrieves a store's homepage.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", +"httpMethod": "GET", +"id": "merchantapi.accounts.homepage.getHomepage", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the homepage to retrieve. Format: `accounts/{account}/homepage`", +"location": "path", +"pattern": "^accounts/[^/]+/homepage$", +"required": true, +"type": "string" +} +}, +"path": "accounts/v1beta/{+name}", +"response": { +"$ref": "Homepage" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, "unclaim": { "description": "Unclaims a store's homepage. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/homepage:unclaim", @@ -637,6 +649,40 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] +}, +"updateHomepage": { +"description": "Updates a store's homepage. Executing this method requires admin access.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/homepage", +"httpMethod": "PATCH", +"id": "merchantapi.accounts.homepage.updateHomepage", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Identifier. The resource name of the store's homepage. Format: `accounts/{account}/homepage`", +"location": "path", +"pattern": "^accounts/[^/]+/homepage$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. List of fields being updated.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "accounts/v1beta/{+name}", +"request": { +"$ref": "Homepage" +}, +"response": { +"$ref": "Homepage" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] } } }, @@ -1040,6 +1086,31 @@ }, "shippingSettings": { "methods": { +"getShippingSettings": { +"description": "Retrieve shipping setting information.", +"flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings", +"httpMethod": "GET", +"id": "merchantapi.accounts.shippingSettings.getShippingSettings", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the shipping setting to retrieve. Format: `accounts/{account}/shippingsetting`", +"location": "path", +"pattern": "^accounts/[^/]+/shippingSettings$", +"required": true, +"type": "string" +} +}, +"path": "accounts/v1beta/{+name}", +"response": { +"$ref": "ShippingSettings" +}, +"scopes": [ +"https://www.googleapis.com/auth/content" +] +}, "insert": { "description": "Replace the shipping setting of a merchant with the request shipping setting. Executing this method requires admin access.", "flatPath": "accounts/v1beta/accounts/{accountsId}/shippingSettings:insert", @@ -1209,31 +1280,6 @@ "https://www.googleapis.com/auth/content" ] }, -"getEmailPreferences": { -"description": "Returns the email preferences for a Merchant Center account user. Use the name=accounts/*/users/me/emailPreferences alias to get preferences for the authenticated user.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", -"httpMethod": "GET", -"id": "merchantapi.accounts.users.getEmailPreferences", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The name of the `EmailPreferences` resource. Format: `accounts/{account}/users/{email}/emailPreferences`", -"location": "path", -"pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", -"required": true, -"type": "string" -} -}, -"path": "accounts/v1beta/{+name}", -"response": { -"$ref": "EmailPreferences" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, "list": { "description": "Lists all users of a Merchant Center account.", "flatPath": "accounts/v1beta/accounts/{accountsId}/users", @@ -1303,40 +1349,6 @@ "scopes": [ "https://www.googleapis.com/auth/content" ] -}, -"updateEmailPreferences": { -"description": "Updates the email preferences for a Merchant Center account user. MCA users should specify the MCA account rather than a sub-account of the MCA. Preferences which are not explicitly selected in the update mask will not be updated. It is invalid for updates to specify an UNCONFIRMED opt-in status value. Use the name=accounts/*/users/me/emailPreferences alias to update preferences for the authenticated user.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/users/{usersId}/emailPreferences", -"httpMethod": "PATCH", -"id": "merchantapi.accounts.users.updateEmailPreferences", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Identifier. The name of the EmailPreferences. The endpoint is only supported for the authenticated user.", -"location": "path", -"pattern": "^accounts/[^/]+/users/[^/]+/emailPreferences$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. List of fields being updated.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -} -}, -"path": "accounts/v1beta/{+name}", -"request": { -"$ref": "EmailPreferences" -}, -"response": { -"$ref": "EmailPreferences" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] } } } @@ -1441,7 +1453,7 @@ } } }, -"revision": "20240614", +"revision": "20240709", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfService": { diff --git a/googleapiclient/discovery_cache/documents/metastore.v1.json b/googleapiclient/discovery_cache/documents/metastore.v1.json index 82e220ab775..5dfec98dd7c 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1.json @@ -1684,7 +1684,7 @@ } } }, -"revision": "20240627", +"revision": "20240709", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2060,6 +2060,31 @@ }, "type": "object" }, +"CustomRegionMetadata": { +"description": "Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", +"id": "CustomRegionMetadata", +"properties": { +"optionalReadOnlyRegions": { +"description": "The read-only regions for this custom region.", +"items": { +"type": "string" +}, +"type": "array" +}, +"requiredReadWriteRegions": { +"description": "The read-write regions for this custom region.", +"items": { +"type": "string" +}, +"type": "array" +}, +"witnessRegion": { +"description": "The Spanner witness region for this custom region.", +"type": "string" +} +}, +"type": "object" +}, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2608,6 +2633,13 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { +"customRegionMetadata": { +"description": "Possible configurations supported if the current region is a custom region.", +"items": { +"$ref": "CustomRegionMetadata" +}, +"type": "array" +}, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3363,6 +3395,7 @@ "UPDATING", "DELETING", "ERROR", +"AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3374,6 +3407,7 @@ "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", +"The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json index 49ed2613674..63079b507c7 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1alpha.json @@ -1796,7 +1796,7 @@ } } }, -"revision": "20240627", +"revision": "20240709", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2196,6 +2196,52 @@ }, "type": "object" }, +"CustomRegionConfig": { +"description": "Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.", +"id": "CustomRegionConfig", +"properties": { +"readOnlyRegions": { +"description": "Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", +"items": { +"type": "string" +}, +"type": "array" +}, +"readWriteRegions": { +"description": "Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CustomRegionMetadata": { +"description": "Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", +"id": "CustomRegionMetadata", +"properties": { +"optionalReadOnlyRegions": { +"description": "The read-only regions for this custom region.", +"items": { +"type": "string" +}, +"type": "array" +}, +"requiredReadWriteRegions": { +"description": "The read-write regions for this custom region.", +"items": { +"type": "string" +}, +"type": "array" +}, +"witnessRegion": { +"description": "The Spanner witness region for this custom region.", +"type": "string" +} +}, +"type": "object" +}, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2769,6 +2815,13 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { +"customRegionMetadata": { +"description": "Possible configurations supported if the current region is a custom region.", +"items": { +"$ref": "CustomRegionMetadata" +}, +"type": "array" +}, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3071,6 +3124,25 @@ "properties": {}, "type": "object" }, +"MultiRegionConfig": { +"description": "The multi-region config for the Dataproc Metastore service.", +"id": "MultiRegionConfig", +"properties": { +"certificates": { +"deprecated": true, +"description": "Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.", +"items": { +"$ref": "RootCACertificate" +}, +"readOnly": true, +"type": "array" +}, +"customRegionConfig": { +"$ref": "CustomRegionConfig" +} +}, +"type": "object" +}, "MultiRegionMetadata": { "description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty.", "id": "MultiRegionMetadata", @@ -3357,6 +3429,25 @@ }, "type": "object" }, +"RootCACertificate": { +"deprecated": true, +"description": "A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.", +"id": "RootCACertificate", +"properties": { +"certificate": { +"deprecated": true, +"description": "The root CA certificate in PEM format. The maximum length is 65536 bytes.", +"type": "string" +}, +"expirationTime": { +"deprecated": true, +"description": "The certificate expiration time in timestamp format.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "ScalingConfig": { "description": "Represents the scaling configuration of a metastore service.", "id": "ScalingConfig", @@ -3504,6 +3595,10 @@ "description": "Output only. The metadata management activities of the metastore service.", "readOnly": true }, +"multiRegionConfig": { +"$ref": "MultiRegionConfig", +"description": "Optional. Specifies the multi-region configuration information for the Hive metastore service." +}, "name": { "description": "Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string" @@ -3554,6 +3649,7 @@ "UPDATING", "DELETING", "ERROR", +"AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3565,6 +3661,7 @@ "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", +"The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/metastore.v1beta.json b/googleapiclient/discovery_cache/documents/metastore.v1beta.json index 901074b74a1..e1c3813edb4 100644 --- a/googleapiclient/discovery_cache/documents/metastore.v1beta.json +++ b/googleapiclient/discovery_cache/documents/metastore.v1beta.json @@ -1796,7 +1796,7 @@ } } }, -"revision": "20240627", +"revision": "20240709", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2196,6 +2196,52 @@ }, "type": "object" }, +"CustomRegionConfig": { +"description": "Custom configuration used to specify regions that the metastore service runs in. Currently only supported in the us multi-region.", +"id": "CustomRegionConfig", +"properties": { +"readOnlyRegions": { +"description": "Optional. The list of read-only regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", +"items": { +"type": "string" +}, +"type": "array" +}, +"readWriteRegions": { +"description": "Required. The list of read-write regions where the metastore service runs in. These regions should be part (or subset) of the multi-region.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"CustomRegionMetadata": { +"description": "Metadata about a custom region. This is only populated if the region is a custom region. For single/multi regions, it will be empty.", +"id": "CustomRegionMetadata", +"properties": { +"optionalReadOnlyRegions": { +"description": "The read-only regions for this custom region.", +"items": { +"type": "string" +}, +"type": "array" +}, +"requiredReadWriteRegions": { +"description": "The read-write regions for this custom region.", +"items": { +"type": "string" +}, +"type": "array" +}, +"witnessRegion": { +"description": "The Spanner witness region for this custom region.", +"type": "string" +} +}, +"type": "object" +}, "DataCatalogConfig": { "description": "Specifies how metastore metadata should be integrated with the Data Catalog service.", "id": "DataCatalogConfig", @@ -2769,6 +2815,13 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { +"customRegionMetadata": { +"description": "Possible configurations supported if the current region is a custom region.", +"items": { +"$ref": "CustomRegionMetadata" +}, +"type": "array" +}, "multiRegionMetadata": { "$ref": "MultiRegionMetadata", "description": "The multi-region metadata if the current region is a multi-region." @@ -3071,6 +3124,25 @@ "properties": {}, "type": "object" }, +"MultiRegionConfig": { +"description": "The multi-region config for the Dataproc Metastore service.", +"id": "MultiRegionConfig", +"properties": { +"certificates": { +"deprecated": true, +"description": "Output only. The list of root CA certificates that a gRPC client uses to connect to a multi-regional Dataproc Metastore service.", +"items": { +"$ref": "RootCACertificate" +}, +"readOnly": true, +"type": "array" +}, +"customRegionConfig": { +"$ref": "CustomRegionConfig" +} +}, +"type": "object" +}, "MultiRegionMetadata": { "description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region or custom dual region, it will be empty.", "id": "MultiRegionMetadata", @@ -3357,6 +3429,25 @@ }, "type": "object" }, +"RootCACertificate": { +"deprecated": true, +"description": "A gRPC client must install all root CA certificates to connect to a multi-regional Dataproc Metastore service and achieve failover.", +"id": "RootCACertificate", +"properties": { +"certificate": { +"deprecated": true, +"description": "The root CA certificate in PEM format. The maximum length is 65536 bytes.", +"type": "string" +}, +"expirationTime": { +"deprecated": true, +"description": "The certificate expiration time in timestamp format.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "ScalingConfig": { "description": "Represents the scaling configuration of a metastore service.", "id": "ScalingConfig", @@ -3504,6 +3595,10 @@ "description": "Output only. The metadata management activities of the metastore service.", "readOnly": true }, +"multiRegionConfig": { +"$ref": "MultiRegionConfig", +"description": "Optional. Specifies the multi-region configuration information for the Hive metastore service." +}, "name": { "description": "Immutable. The relative resource name of the metastore service, in the following format:projects/{project_number}/locations/{location_id}/services/{service_id}.", "type": "string" @@ -3554,6 +3649,7 @@ "UPDATING", "DELETING", "ERROR", +"AUTOSCALING", "MIGRATING" ], "enumDescriptions": [ @@ -3565,6 +3661,7 @@ "The metastore service is being updated. It remains usable but cannot accept additional update requests or be deleted at this time.", "The metastore service is undergoing deletion. It cannot be used.", "The metastore service has encountered an error and cannot be used. The metastore service should be deleted.", +"The Dataproc Metastore service 2 is being scaled up or down.", "The metastore service is processing a managed migration." ], "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index f2608477091..b1f9a6e5b5e 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2473,7 +2473,7 @@ } } }, -"revision": "20240625", +"revision": "20240704", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3443,7 +3443,7 @@ "enumDescriptions": [ "Unspecified (default value).", "Default Google Cloud licensing plan. Licensing is charged per usage. This a good value to start with.", -"Bring-your-own-license (BYOL) plan. User provides the OS license." +"Bring-your-own-license (BYOL) plan. User provides the license." ], "type": "string" }, @@ -6255,7 +6255,7 @@ false "type": "string" }, "licenseType": { -"description": "Optional. License type of the OS image.", +"description": "Optional. License type for premium images (RHEL, RHEL for SAP, SLES, SLES for SAP, Windows Server).", "enum": [ "LICENSE_TYPE_UNSPECIFIED", "LICENSE_TYPE_DEFAULT", @@ -6264,7 +6264,7 @@ false "enumDescriptions": [ "Unspecified (default value).", "Default Google Cloud licensing plan. Licensing is charged per usage. This a good value to start with.", -"Bring-your-own-license (BYOL) plan. User provides the OS license." +"Bring-your-own-license (BYOL) plan. User provides the license." ], "type": "string" } @@ -8296,7 +8296,9 @@ false "COMMITMENT_1_YEAR_MONTHLY_PAYMENTS", "COMMITMENT_3_YEAR_MONTHLY_PAYMENTS", "COMMITMENT_1_YEAR_UPFRONT_PAYMENT", -"COMMITMENT_3_YEAR_UPFRONT_PAYMENT" +"COMMITMENT_3_YEAR_UPFRONT_PAYMENT", +"COMMITMENT_FLEXIBLE_3_YEAR_MONTHLY_PAYMENTS", +"COMMITMENT_FLEXIBLE_3_YEAR_UPFRONT_PAYMENT" ], "enumDescriptions": [ "Unspecified commitment plan.", @@ -8304,7 +8306,9 @@ false "1 year commitment (monthly payments).", "3 year commitment (monthly payments).", "1 year commitment (upfront payment).", -"3 years commitment (upfront payment)." +"3 years commitment (upfront payment).", +"3-year flexible commitment (monthly payments). While not supported in the v1 API, this value is converted to UNSPECIFIED in conversions to the v1 API.", +"3-year flexible commitment (upfront payment). While not supported in the v1 API, this value is converted to UNSPECIFIED in conversions to the v1 API." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index e1899b35c05..8d5237871ee 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -753,7 +753,7 @@ } } }, -"revision": "20240630", +"revision": "20240707", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1356,7 +1356,9 @@ "CLOUD_SQL_FAILOVER", "CLOUD_SQL_START_STOP", "CLOUD_SQL_STORAGE", -"UPTIME_CHECK_FAILURE" +"UPTIME_CHECK_FAILURE", +"CLOUD_ALERTING_ALERT", +"SERVICE_HEALTH_INCIDENT" ], "enumDescriptions": [ "No event type specified.", @@ -1378,7 +1380,9 @@ "Failover of a Cloud SQL instance.", "Start/stop of a Cloud SQL instance.", "Storage event for a Cloud SQL instance.", -"Failure of a Cloud Monitoring uptime check." +"Failure of a Cloud Monitoring uptime check.", +"Alerts from Cloud Alerting", +"Incidents from Service Health" ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1.json b/googleapiclient/discovery_cache/documents/networkservices.v1.json index 931c618bf10..395d27e1c96 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1.json @@ -535,37 +535,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:getIamPolicy", -"httpMethod": "GET", -"id": "networkservices.projects.locations.endpointPolicies.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Lists EndpointPolicies in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", @@ -635,62 +604,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:setIamPolicy", -"httpMethod": "POST", -"id": "networkservices.projects.locations.endpointPolicies.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:testIamPermissions", -"httpMethod": "POST", -"id": "networkservices.projects.locations.endpointPolicies.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, -"response": { -"$ref": "TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } } }, @@ -779,37 +692,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy", -"httpMethod": "GET", -"id": "networkservices.projects.locations.gateways.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Lists Gateways in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways", @@ -879,62 +761,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy", -"httpMethod": "POST", -"id": "networkservices.projects.locations.gateways.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions", -"httpMethod": "POST", -"id": "networkservices.projects.locations.gateways.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, -"response": { -"$ref": "TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } } }, @@ -1701,37 +1527,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy", -"httpMethod": "GET", -"id": "networkservices.projects.locations.meshes.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Lists Meshes in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes", @@ -1801,62 +1596,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy", -"httpMethod": "POST", -"id": "networkservices.projects.locations.meshes.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions", -"httpMethod": "POST", -"id": "networkservices.projects.locations.meshes.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, -"response": { -"$ref": "TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } } }, @@ -2068,37 +1807,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy", -"httpMethod": "GET", -"id": "networkservices.projects.locations.serviceBindings.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Lists ServiceBinding in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings", @@ -2134,62 +1842,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy", -"httpMethod": "POST", -"id": "networkservices.projects.locations.serviceBindings.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions", -"httpMethod": "POST", -"id": "networkservices.projects.locations.serviceBindings.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, -"response": { -"$ref": "TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } } }, @@ -2756,7 +2408,7 @@ } } }, -"revision": "20240626", +"revision": "20240707", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json index d43cffcc44c..806e9ded696 100644 --- a/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkservices.v1beta1.json @@ -262,37 +262,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:getIamPolicy", -"httpMethod": "GET", -"id": "networkservices.projects.locations.endpointPolicies.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:getIamPolicy", -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Lists EndpointPolicies in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies", @@ -362,62 +331,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:setIamPolicy", -"httpMethod": "POST", -"id": "networkservices.projects.locations.endpointPolicies.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/endpointPolicies/{endpointPoliciesId}:testIamPermissions", -"httpMethod": "POST", -"id": "networkservices.projects.locations.endpointPolicies.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/endpointPolicies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, -"response": { -"$ref": "TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } } }, @@ -506,37 +419,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:getIamPolicy", -"httpMethod": "GET", -"id": "networkservices.projects.locations.gateways.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:getIamPolicy", -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Lists Gateways in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways", @@ -606,62 +488,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:setIamPolicy", -"httpMethod": "POST", -"id": "networkservices.projects.locations.gateways.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/gateways/{gatewaysId}:testIamPermissions", -"httpMethod": "POST", -"id": "networkservices.projects.locations.gateways.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/gateways/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, -"response": { -"$ref": "TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } } }, @@ -1428,37 +1254,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:getIamPolicy", -"httpMethod": "GET", -"id": "networkservices.projects.locations.meshes.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:getIamPolicy", -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Lists Meshes in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes", @@ -1528,62 +1323,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:setIamPolicy", -"httpMethod": "POST", -"id": "networkservices.projects.locations.meshes.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/meshes/{meshesId}:testIamPermissions", -"httpMethod": "POST", -"id": "networkservices.projects.locations.meshes.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/meshes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, -"response": { -"$ref": "TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } } }, @@ -1795,37 +1534,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:getIamPolicy", -"httpMethod": "GET", -"id": "networkservices.projects.locations.serviceBindings.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:getIamPolicy", -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "list": { "description": "Lists ServiceBinding in a given project and location.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings", @@ -1861,62 +1569,6 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:setIamPolicy", -"httpMethod": "POST", -"id": "networkservices.projects.locations.serviceBindings.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:setIamPolicy", -"request": { -"$ref": "SetIamPolicyRequest" -}, -"response": { -"$ref": "Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serviceBindings/{serviceBindingsId}:testIamPermissions", -"httpMethod": "POST", -"id": "networkservices.projects.locations.serviceBindings.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/serviceBindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta1/{+resource}:testIamPermissions", -"request": { -"$ref": "TestIamPermissionsRequest" -}, -"response": { -"$ref": "TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] } } }, @@ -2483,7 +2135,7 @@ } } }, -"revision": "20240626", +"revision": "20240707", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index 58952eb054e..b2c0393fb28 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240624", +"revision": "20240709", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1110,10 +1110,6 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." -}, -"vulnerabilityAttestation": { -"$ref": "VulnerabilityAttestation", -"description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -2846,36 +2842,6 @@ }, "type": "object" }, -"VulnerabilityAttestation": { -"description": "The status of an vulnerability attestation generation.", -"id": "VulnerabilityAttestation", -"properties": { -"error": { -"description": "If failure, the error reason for why the attestation generation failed.", -"type": "string" -}, -"lastAttemptTime": { -"description": "The last time we attempted to generate an attestation.", -"format": "google-datetime", -"type": "string" -}, -"state": { -"description": "The success/failure state of the latest attestation attempt.", -"enum": [ -"VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", -"SUCCESS", -"FAILURE" -], -"enumDescriptions": [ -"Default unknown state.", -"Attestation was successfully generated and stored.", -"Attestation was unsuccessfully generated and stored." -], -"type": "string" -} -}, -"type": "object" -}, "VulnerabilityOccurrence": { "description": "An occurrence of a severity vulnerability on a resource.", "id": "VulnerabilityOccurrence", diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index f4e32a89306..2df09cd2fdb 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240624", +"revision": "20240709", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1105,10 +1105,6 @@ "sbomStatus": { "$ref": "SBOMStatus", "description": "The status of an SBOM generation." -}, -"vulnerabilityAttestation": { -"$ref": "VulnerabilityAttestation", -"description": "The status of an vulnerability attestation generation." } }, "type": "object" @@ -2841,36 +2837,6 @@ }, "type": "object" }, -"VulnerabilityAttestation": { -"description": "The status of an vulnerability attestation generation.", -"id": "VulnerabilityAttestation", -"properties": { -"error": { -"description": "If failure, the error reason for why the attestation generation failed.", -"type": "string" -}, -"lastAttemptTime": { -"description": "The last time we attempted to generate an attestation.", -"format": "google-datetime", -"type": "string" -}, -"state": { -"description": "The success/failure state of the latest attestation attempt.", -"enum": [ -"VULNERABILITY_ATTESTATION_STATE_UNSPECIFIED", -"SUCCESS", -"FAILURE" -], -"enumDescriptions": [ -"Default unknown state.", -"Attestation was successfully generated and stored.", -"Attestation was unsuccessfully generated and stored." -], -"type": "string" -} -}, -"type": "object" -}, "VulnerabilityOccurrence": { "description": "An occurrence of a severity vulnerability on a resource.", "id": "VulnerabilityOccurrence", diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index a30bbf55d9a..202d0c942e0 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -105,6 +105,38 @@ }, "protocol": "rest", "resources": { +"deviceRecall": { +"methods": { +"write": { +"description": "Writes recall bits for the device where Play Integrity API token is obtained. The endpoint is available to select Play partners in an early access program (EAP).", +"flatPath": "v1/{v1Id}/deviceRecall:write", +"httpMethod": "POST", +"id": "playintegrity.deviceRecall.write", +"parameterOrder": [ +"packageName" +], +"parameters": { +"packageName": { +"description": "Required. Package name of the app the attached integrity token belongs to.", +"location": "path", +"pattern": "^[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+packageName}/deviceRecall:write", +"request": { +"$ref": "WriteDeviceRecallRequest" +}, +"response": { +"$ref": "WriteDeviceRecallResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/playintegrity" +] +} +} +}, "v1": { "methods": { "decodeIntegrityToken": { @@ -138,7 +170,7 @@ } } }, -"revision": "20240707", +"revision": "20240711", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -491,6 +523,46 @@ } }, "type": "object" +}, +"Values": { +"description": "Contains the recall bits values.", +"id": "Values", +"properties": { +"bitFirst": { +"description": "Required. First recall bit value.", +"type": "boolean" +}, +"bitSecond": { +"description": "Required. Second recall bit value.", +"type": "boolean" +}, +"bitThird": { +"description": "Required. Third recall bit value.", +"type": "boolean" +} +}, +"type": "object" +}, +"WriteDeviceRecallRequest": { +"description": "Request to write device recall bits.", +"id": "WriteDeviceRecallRequest", +"properties": { +"integrityToken": { +"description": "Required. Integrity token obtained from calling Play Integrity API. Note that the integrity token contains the existing device recall bits. The write will only succeed if those bits in the integrity token are up to date.", +"type": "string" +}, +"newValues": { +"$ref": "Values", +"description": "Required. The new values for the device recall bits to be written." +} +}, +"type": "object" +}, +"WriteDeviceRecallResponse": { +"description": "Response for the Write Device Recall action. Currently empty.", +"id": "WriteDeviceRecallResponse", +"properties": {}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json index 63568a8caf2..5d07073f0d8 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2.json +++ b/googleapiclient/discovery_cache/documents/retail.v2.json @@ -2092,7 +2092,7 @@ } } }, -"revision": "20240614", +"revision": "20240702", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2637,14 +2637,6 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" -}, -"mergedFacetValues": { -"deprecated": true, -"description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", -"items": { -"$ref": "GoogleCloudRetailV2CatalogAttributeFacetConfigMergedFacetValue" -}, -"type": "array" } }, "type": "object" @@ -2752,7 +2744,7 @@ }, "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult": { "deprecated": true, -"description": "Recent search of this user.", +"description": "Deprecated: Recent search of this user.", "id": "GoogleCloudRetailV2CompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index c64739109ce..6dfefb6f379 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2557,7 +2557,7 @@ } } }, -"revision": "20240614", +"revision": "20240702", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3610,16 +3610,6 @@ "readOnly": true, "type": "array" }, -"productCounts": { -"additionalProperties": { -"format": "int64", -"type": "string" -}, -"deprecated": true, -"description": "Output only. The number of products in different groups that this branch has. The key is a group representing a set of products, and the value is the number of products in that group. Note: keys in this map may change over time. Possible keys: * \"primary-in-stock\", products have Product.Type.PRIMARY type and Product.Availability.IN_STOCK availability. * \"primary-out-of-stock\", products have Product.Type.PRIMARY type and Product.Availability.OUT_OF_STOCK availability. * \"primary-preorder\", products have Product.Type.PRIMARY type and Product.Availability.PREORDER availability. * \"primary-backorder\", products have Product.Type.PRIMARY type and Product.Availability.BACKORDER availability. * \"variant-in-stock\", products have Product.Type.VARIANT type and Product.Availability.IN_STOCK availability. * \"variant-out-of-stock\", products have Product.Type.VARIANT type and Product.Availability.OUT_OF_STOCK availability. * \"variant-preorder\", products have Product.Type.VARIANT type and Product.Availability.PREORDER availability. * \"variant-backorder\", products have Product.Type.VARIANT type and Product.Availability.BACKORDER availability. * \"price-discounted\", products have [Product.price_info.price] < [Product.price_info.original_price]. This field is not populated in BranchView.BASIC view.", -"readOnly": true, -"type": "object" -}, "qualityMetrics": { "description": "Output only. The quality metrics measured among products of this branch. See QualityMetric.requirement_key for supported metrics. Metrics could be missing if failed to retrieve. This field is not populated in BranchView.BASIC view.", "items": { @@ -3902,14 +3892,6 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" -}, -"mergedFacetValues": { -"deprecated": true, -"description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", -"items": { -"$ref": "GoogleCloudRetailV2alphaCatalogAttributeFacetConfigMergedFacetValue" -}, -"type": "array" } }, "type": "object" @@ -4050,7 +4032,7 @@ }, "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult": { "deprecated": true, -"description": "Recent search of this user.", +"description": "Deprecated: Recent search of this user.", "id": "GoogleCloudRetailV2alphaCompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index e89f5dec6cd..9658a0902e2 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -2120,7 +2120,7 @@ } } }, -"revision": "20240614", +"revision": "20240702", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4113,14 +4113,6 @@ "mergedFacetKey": { "description": "The merged facet key should be a valid facet key that is different than the facet key of the current catalog attribute. We refer this is merged facet key as the child of the current catalog attribute. This merged facet key can't be a parent of another facet key (i.e. no directed path of length 2). This merged facet key needs to be either a textual custom attribute or a numerical custom attribute.", "type": "string" -}, -"mergedFacetValues": { -"deprecated": true, -"description": "Each instance is a list of facet values that map into the same (possibly different) merged facet value. For the current attribute config, each facet value should map to at most one merged facet value.", -"items": { -"$ref": "GoogleCloudRetailV2betaCatalogAttributeFacetConfigMergedFacetValue" -}, -"type": "array" } }, "type": "object" @@ -4228,7 +4220,7 @@ }, "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult": { "deprecated": true, -"description": "Recent search of this user.", +"description": "Deprecated: Recent search of this user.", "id": "GoogleCloudRetailV2betaCompleteQueryResponseRecentSearchResult", "properties": { "recentSearch": { diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 7f7b6a8b342..dc86a4f86ad 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2614,7 +2614,7 @@ } } }, -"revision": "20240628", +"revision": "20240705", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4260,7 +4260,7 @@ false "id": "GoogleDevtoolsCloudbuildV1HttpConfig", "properties": { "proxySecretVersionName": { -"description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have secretmanager.versions.access permissions on this secret. The proxy URL should be in format protocol://@]proxyhost[:port].", +"description": "SecretVersion resource of the HTTP proxy URL. The Service Account used in the build (either the default Service Account or user-specified Service Account) should have `secretmanager.versions.access` permissions on this secret. The proxy URL should be in format `protocol://@]proxyhost[:port]`.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/searchconsole.v1.json b/googleapiclient/discovery_cache/documents/searchconsole.v1.json index cd6d0bee321..68f4f34e3fd 100644 --- a/googleapiclient/discovery_cache/documents/searchconsole.v1.json +++ b/googleapiclient/discovery_cache/documents/searchconsole.v1.json @@ -17,7 +17,7 @@ "canonicalName": "Search Console", "description": "The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)", "discoveryVersion": "v1", -"documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/", +"documentationLink": "https://developers.google.com/webmaster-tools/about", "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -400,7 +400,7 @@ } } }, -"revision": "20240707", +"revision": "20240708", "rootUrl": "https://searchconsole.googleapis.com/", "schemas": { "AmpInspectionResult": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index f9e4acca812..9ad11d4aea6 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, -"revision": "20240623", +"revision": "20240707", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1126,7 +1126,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 09d10be9242..8209ba2aa8e 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -715,7 +715,7 @@ } } }, -"revision": "20240623", +"revision": "20240707", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1211,7 +1211,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index 5c38312c9bb..d945e35592a 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, -"revision": "20240623", +"revision": "20240707", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1147,7 +1147,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index 966a6a752c7..e7809f590ec 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, -"revision": "20240623", +"revision": "20240707", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1724,7 +1724,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index 049fae515d6..82c73538f44 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, -"revision": "20240625", +"revision": "20240708", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -934,7 +934,7 @@ "type": "object" }, "AddDataSourceRequest": { -"description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope.", +"description": "Adds a data source. After the data source is added successfully, an associated DATA_SOURCE sheet is created and an execution is triggered to refresh the sheet to read data from the data source. The request requires an additional `bigquery.readonly` OAuth scope if you are adding a BigQuery data source.", "id": "AddDataSourceRequest", "properties": { "dataSource": { @@ -2330,7 +2330,7 @@ "type": "object" }, "CancelDataSourceRefreshRequest": { -"description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references.", +"description": "Cancels one or multiple refreshes of data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are cancelling a refresh on a BigQuery data source.", "id": "CancelDataSourceRefreshRequest", "properties": { "dataSourceId": { @@ -5960,7 +5960,7 @@ "type": "object" }, "RefreshDataSourceRequest": { -"description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.", +"description": "Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional `bigquery.readonly` OAuth scope if you are refreshing a BigQuery data source. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.", "id": "RefreshDataSourceRequest", "properties": { "dataSourceId": { @@ -7468,7 +7468,7 @@ "type": "object" }, "UpdateDataSourceRequest": { -"description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope.", +"description": "Updates a data source. After the data source is updated successfully, an execution is triggered to refresh the associated DATA_SOURCE sheet to read data from the updated data source. The request requires an additional `bigquery.readonly` OAuth scope if you are updating a BigQuery data source.", "id": "UpdateDataSourceRequest", "properties": { "dataSource": { diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 702cf9968dd..46226e4ea87 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -123,7 +123,7 @@ "instanceConfigOperations": { "methods": { "list": { -"description": "Lists the user-managed instance config long-running operations in the given project. An instance config operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.", +"description": "Lists the user-managed instance configuration long-running operations in the given project. An instance configuration operation has a name of the form `projects//instanceConfigs//operations/`. The long-running operation metadata field type `metadata.type_url` describes the type of the metadata. Operations returned include those that have completed/failed/canceled within the last 7 days, and pending operations. Operations returned are ordered by `operation.metadata.value.start_time` in descending order starting from the most recently started operation.", "flatPath": "v1/projects/{projectsId}/instanceConfigOperations", "httpMethod": "GET", "id": "spanner.projects.instanceConfigOperations.list", @@ -132,7 +132,7 @@ ], "parameters": { "filter": { -"description": "An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance config name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", +"description": "An expression that filters the list of returned operations. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. Colon `:` is the contains operator. Filter rules are not case sensitive. The following fields in the Operation are eligible for filtering: * `name` - The name of the long-running operation * `done` - False if the operation is in progress, else true. * `metadata.@type` - the type of metadata. For example, the type string for CreateInstanceConfigMetadata is `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata`. * `metadata.` - any field in metadata.value. `metadata.@type` must be specified first, if filtering on metadata fields. * `error` - Error associated with the long-running operation. * `response.@type` - the type of response. * `response.` - any field in response.value. You can combine multiple expressions by enclosing each expression in parentheses. By default, expressions are combined with AND logic. However, you can specify AND, OR, and NOT logic explicitly. Here are a few examples: * `done:true` - The operation is complete. * `(metadata.@type=` \\ `type.googleapis.com/google.spanner.admin.instance.v1.CreateInstanceConfigMetadata) AND` \\ `(metadata.instance_config.name:custom-config) AND` \\ `(metadata.progress.start_time < \\\"2021-03-28T14:50:00Z\\\") AND` \\ `(error:*)` - Return operations where: * The operation's metadata type is CreateInstanceConfigMetadata. * The instance configuration name contains \"custom-config\". * The operation started before 2021-03-28T14:50:00Z. * The operation resulted in an error.", "location": "query", "type": "string" }, @@ -148,7 +148,7 @@ "type": "string" }, "parent": { -"description": "Required. The project of the instance config operations. Values are of the form `projects/`.", +"description": "Required. The project of the instance configuration operations. Values are of the form `projects/`.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -169,7 +169,7 @@ "instanceConfigs": { "methods": { "create": { -"description": "Creates an instance config and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance config name is assigned by the caller. If the named instance config already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance config is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance config immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance config are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", +"description": "Creates an instance configuration and begins preparing it to be used. The returned long-running operation can be used to track the progress of preparing the new instance config. The instance configuration name is assigned by the caller. If the named instance configuration already exists, `CreateInstanceConfig` returns `ALREADY_EXISTS`. Immediately after the request returns: * The instance configuration is readable via the API, with all requested attributes. The instance config's reconciling field is set to true. Its state is `CREATING`. While the operation is pending: * Cancelling the operation renders the instance configuration immediately unreadable via the API. * Except for deleting the creating resource, all other attempts to modify the instance configuration are rejected. Upon completion of the returned operation: * Instances can be created using the instance configuration. * The instance config's reconciling field becomes false. Its state becomes `READY`. The returned long-running operation will have a name of the format `/operations/` and can be used to track creation of the instance config. The metadata field type is CreateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.create` permission on the resource parent.", "flatPath": "v1/projects/{projectsId}/instanceConfigs", "httpMethod": "POST", "id": "spanner.projects.instanceConfigs.create", @@ -198,7 +198,7 @@ ] }, "delete": { -"description": "Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", +"description": "Deletes the instance config. Deletion is only allowed when no instances are using the configuration. If any instances are using the config, returns `FAILED_PRECONDITION`. Only user-managed configurations can be deleted. Authorization requires `spanner.instanceConfigs.delete` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "DELETE", "id": "spanner.projects.instanceConfigs.delete", @@ -207,7 +207,7 @@ ], "parameters": { "etag": { -"description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance config from overwriting each other. If not empty, the API only deletes the instance config when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance config without checking the current status of the requested instance config.", +"description": "Used for optimistic concurrency control as a way to help prevent simultaneous deletes of an instance configuration from overwriting each other. If not empty, the API only deletes the instance configuration when the etag provided matches the current status of the requested instance config. Otherwise, deletes the instance configuration without checking the current status of the requested instance config.", "location": "query", "type": "string" }, @@ -260,7 +260,7 @@ ] }, "list": { -"description": "Lists the supported instance configurations for a given project. Returns both Google managed configs and user managed configs.", +"description": "Lists the supported instance configurations for a given project. Returns both Google-managed configurations and user-managed configurations.", "flatPath": "v1/projects/{projectsId}/instanceConfigs", "httpMethod": "GET", "id": "spanner.projects.instanceConfigs.list", @@ -297,7 +297,7 @@ ] }, "patch": { -"description": "Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance config does not exist, returns `NOT_FOUND`. Only user managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance config are rejected. * Reading the instance config via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance config modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", +"description": "Updates an instance config. The returned long-running operation can be used to track the progress of updating the instance. If the named instance configuration does not exist, returns `NOT_FOUND`. Only user-managed configurations can be updated. Immediately after the request returns: * The instance config's reconciling field is set to true. While the operation is pending: * Cancelling the operation sets its metadata's cancel_time. The operation is guaranteed to succeed at undoing all changes, after which point it terminates with a `CANCELLED` status. * All other attempts to modify the instance configuration are rejected. * Reading the instance configuration via the API continues to give the pre-request values. Upon completion of the returned operation: * Creating instances using the instance configuration uses the new values. * The instance config's new values are readable via the API. * The instance config's reconciling field becomes false. The returned long-running operation will have a name of the format `/operations/` and can be used to track the instance configuration modification. The metadata field type is UpdateInstanceConfigMetadata. The response field type is InstanceConfig, if successful. Authorization requires `spanner.instanceConfigs.update` permission on the resource name.", "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", "httpMethod": "PATCH", "id": "spanner.projects.instanceConfigs.patch", @@ -306,7 +306,7 @@ ], "parameters": { "name": { -"description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", +"description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.", "location": "path", "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$", "required": true, @@ -748,7 +748,7 @@ ] }, "move": { -"description": "Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configs are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance config back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with CANCELLED status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).", +"description": "Moves the instance to the target instance config. The returned long-running operation can be used to track the progress of moving the instance. `MoveInstance` returns `FAILED_PRECONDITION` if the instance meets any of the following criteria: * Has an ongoing move to a different instance config * Has backups * Has an ongoing update * Is under free trial * Contains any CMEK-enabled databases While the operation is pending: * All other attempts to modify the instance, including changes to its compute capacity, are rejected. * The following database and backup admin operations are rejected: * DatabaseAdmin.CreateDatabase, * DatabaseAdmin.UpdateDatabaseDdl (Disabled if default_leader is specified in the request.) * DatabaseAdmin.RestoreDatabase * DatabaseAdmin.CreateBackup * DatabaseAdmin.CopyBackup * Both the source and target instance configurations are subject to hourly compute and storage charges. * The instance may experience higher read-write latencies and a higher transaction abort rate. However, moving an instance does not cause any downtime. The returned long-running operation will have a name of the format `/operations/` and can be used to track the move instance operation. The metadata field type is MoveInstanceMetadata. The response field type is Instance, if successful. Cancelling the operation sets its metadata's cancel_time. Cancellation is not immediate since it involves moving any data previously moved to target instance configuration back to the original instance config. The same operation can be used to track the progress of the cancellation. Upon successful completion of the cancellation, the operation terminates with `CANCELLED` status. Upon completion(if not cancelled) of the returned operation: * Instance would be successfully moved to the target instance config. * You are billed for compute and storage in target instance config. Authorization requires `spanner.instances.update` permission on the resource instance. For more details, please see [documentation](https://cloud.google.com/spanner/docs/move-instance).", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:move", "httpMethod": "POST", "id": "spanner.projects.instances.move", @@ -1426,7 +1426,7 @@ ] }, "create": { -"description": "Creates a new Cloud Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.", +"description": "Creates a new Spanner database and starts to prepare it for serving. The returned long-running operation will have a name of the format `/operations/` and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases", "httpMethod": "POST", "id": "spanner.projects.instances.databases.create", @@ -1804,6 +1804,97 @@ } }, "resources": { +"backupSchedules": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy", +"httpMethod": "POST", +"id": "spanner.projects.instances.databases.backupSchedules.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"request": { +"$ref": "GetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy", +"httpMethod": "POST", +"id": "spanner.projects.instances.databases.backupSchedules.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for databases resources.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, +"testIamPermissions": { +"description": "Returns permissions that the caller has on the specified database or backup resource. Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has `spanner.databases.list` permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions. Calling this method on a backup that does not exist will result in a NOT_FOUND error if the user has `spanner.backups.list` permission on the containing instance.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:testIamPermissions", +"httpMethod": "POST", +"id": "spanner.projects.instances.databases.backupSchedules.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects//instances/` for instance resources and `projects//instances//databases/` for database resources.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +} +} +}, "databaseRoles": { "methods": { "list": { @@ -3005,11 +3096,11 @@ } } }, -"revision": "20240628", +"revision": "20240711", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { -"description": "Autoscaling config for an instance.", +"description": "Autoscaling configuration for an instance.", "id": "AutoscalingConfig", "properties": { "autoscalingLimits": { @@ -3620,7 +3711,7 @@ "type": "array" }, "protoDescriptors": { -"description": "Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized [google.protobuf.FileDescriptorSet](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto). To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \\ --include_imports \\ --descriptor_set_out=descriptors.data \\ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).", +"description": "Optional. Proto descriptors used by `CREATE/ALTER PROTO BUNDLE` statements in 'extra_statements'. Contains a protobuf-serialized [`google.protobuf.FileDescriptorSet`](https://github.com/protocolbuffers/protobuf/blob/main/src/google/protobuf/descriptor.proto) descriptor set. To generate it, [install](https://grpc.io/docs/protoc-installation/) and run `protoc` with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run ``` $protoc --proto_path=/app_path --proto_path=/lib_path \\ --include_imports \\ --descriptor_set_out=descriptors.data \\ moon/shot/app.proto ``` For more details, see protobuffer [self description](https://developers.google.com/protocol-buffers/docs/techniques#self-description).", "format": "byte", "type": "string" } @@ -3638,7 +3729,7 @@ }, "instanceConfig": { "$ref": "InstanceConfig", -"description": "The target instance config end state." +"description": "The target instance configuration end state." }, "progress": { "$ref": "InstanceOperationProgress", @@ -3653,10 +3744,10 @@ "properties": { "instanceConfig": { "$ref": "InstanceConfig", -"description": "Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3." +"description": "Required. The InstanceConfig proto of the configuration to create. instance_config.name must be `/instanceConfigs/`. instance_config.base_config must be a Google-managed configuration name, e.g. /instanceConfigs/us-east1, /instanceConfigs/nam3." }, "instanceConfigId": { -"description": "Required. The ID of the instance config to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google managed configurations.", +"description": "Required. The ID of the instance configuration to create. Valid identifiers are of the form `custom-[-a-z0-9]*[a-z0-9]` and must be between 2 and 64 characters in length. The `custom-` prefix is required to avoid name conflicts with Google-managed configurations.", "type": "string" }, "validateOnly": { @@ -4152,7 +4243,7 @@ "enumDescriptions": [ "The default mode. Only the statement results are returned.", "This mode returns only the query plan, without any results or execution statistics information.", -"This mode returns both the query plan and the execution statistics along with the results." +"This mode returns both the query plan and the execution statistics along with the results. This has a performance overhead compared to the NORMAL mode. It is not recommended to use this mode for production traffic." ], "type": "string" }, @@ -4423,12 +4514,12 @@ "type": "string" }, "nodeCount": { -"description": "The number of nodes allocated to this instance. At most one of either node_count or processing_units should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", +"description": "The number of nodes allocated to this instance. At most, one of either `node_count` or `processing_units` should be present in the message. Users can set the node_count field to specify the target number of nodes allocated to the instance. If autoscaling is enabled, node_count is treated as an OUTPUT_ONLY field and reflects the current number of nodes allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. For more information, see [Compute capacity, nodes, and processing units](https://cloud.google.com/spanner/docs/compute-capacity).", "format": "int32", "type": "integer" }, "processingUnits": { -"description": "The number of processing units allocated to this instance. At most one of processing_units or node_count should be present in the message. Users can set the processing_units field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, processing_units is treated as an OUTPUT_ONLY field and reflects the current number of processing units allocated to the instance. This may be zero in API responses for instances that are not yet in state `READY`. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", +"description": "The number of processing units allocated to this instance. At most, one of either `processing_units` or `node_count` should be present in the message. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance. If autoscaling is enabled, `processing_units` is treated as an `OUTPUT_ONLY` field and reflects the current number of processing units allocated to the instance. This might be zero in API responses for instances that are not yet in the `READY` state. See [the documentation](https://cloud.google.com/spanner/docs/compute-capacity) for more information about nodes and processing units.", "format": "int32", "type": "integer" }, @@ -4461,11 +4552,11 @@ "id": "InstanceConfig", "properties": { "baseConfig": { -"description": "Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user managed configurations. `base_config` must refer to a configuration of type GOOGLE_MANAGED in the same project as this configuration.", +"description": "Base configuration name, e.g. projects//instanceConfigs/nam3, based on which this configuration is created. Only set for user-managed configurations. `base_config` must refer to a configuration of type `GOOGLE_MANAGED` in the same project as this configuration.", "type": "string" }, "configType": { -"description": "Output only. Whether this instance config is a Google or User Managed Configuration.", +"description": "Output only. Whether this instance configuration is a Google- or user-managed configuration.", "enum": [ "TYPE_UNSPECIFIED", "GOOGLE_MANAGED", @@ -4473,8 +4564,8 @@ ], "enumDescriptions": [ "Unspecified.", -"Google managed configuration.", -"User managed configuration." +"Google-managed configuration.", +"User-managed configuration." ], "readOnly": true, "type": "string" @@ -4484,7 +4575,7 @@ "type": "string" }, "etag": { -"description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance config from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance config updates in order to avoid race conditions: An etag is returned in the response which contains instance configs, and systems are expected to put that etag in the request to update instance config to ensure that their change will be applied to the same version of the instance config. If no etag is provided in the call to update instance config, then the existing instance config is overwritten blindly.", +"description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a instance configuration from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform instance configuration updates in order to avoid race conditions: An etag is returned in the response which contains instance configurations, and systems are expected to put that etag in the request to update instance configuration to ensure that their change is applied to the same version of the instance configuration. If no etag is provided in the call to update the instance configuration, then the existing instance configuration is overwritten blindly.", "type": "string" }, "freeInstanceAvailability": { @@ -4501,7 +4592,7 @@ "Indicates that free instances are available to be created in this instance config.", "Indicates that free instances are not supported in this instance config.", "Indicates that free instances are currently not available to be created in this instance config.", -"Indicates that additional free instances cannot be created in this instance config because the project has reached its limit of free instances." +"Indicates that additional free instances cannot be created in this instance configuration because the project has reached its limit of free instances." ], "readOnly": true, "type": "string" @@ -4521,11 +4612,11 @@ "type": "array" }, "name": { -"description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance config must start with `custom-`.", +"description": "A unique identifier for the instance configuration. Values are of the form `projects//instanceConfigs/a-z*`. User instance configuration must start with `custom-`.", "type": "string" }, "optionalReplicas": { -"description": "Output only. The available optional replicas to choose from for user managed configurations. Populated for Google managed configurations.", +"description": "Output only. The available optional replicas to choose from for user-managed configurations. Populated for Google-managed configurations.", "items": { "$ref": "ReplicaInfo" }, @@ -4550,19 +4641,19 @@ "type": "string" }, "reconciling": { -"description": "Output only. If true, the instance config is being created or updated. If false, there are no ongoing operations for the instance config.", +"description": "Output only. If true, the instance configuration is being created or updated. If false, there are no ongoing operations for the instance config.", "readOnly": true, "type": "boolean" }, "replicas": { -"description": "The geographic placement of nodes in this instance configuration and their replication properties. To create user managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.", +"description": "The geographic placement of nodes in this instance configuration and their replication properties. To create user-managed configurations, input `replicas` must include all replicas in `replicas` of the `base_config` and include one or more replicas in the `optional_replicas` of the `base_config`.", "items": { "$ref": "ReplicaInfo" }, "type": "array" }, "state": { -"description": "Output only. The current instance config state. Applicable only for USER_MANAGED configs.", +"description": "Output only. The current instance configuration state. Applicable only for `USER_MANAGED` configurations.", "enum": [ "STATE_UNSPECIFIED", "CREATING", @@ -4570,8 +4661,8 @@ ], "enumDescriptions": [ "Not specified.", -"The instance config is still being created.", -"The instance config is fully created and ready to be used to create instances." +"The instance configuration is still being created.", +"The instance configuration is fully created and ready to be used to create instances." ], "readOnly": true, "type": "string" @@ -4634,12 +4725,12 @@ "type": "string" }, "nodeCount": { -"description": "The number of nodes allocated to this instance partition. Users can set the node_count field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", +"description": "The number of nodes allocated to this instance partition. Users can set the `node_count` field to specify the target number of nodes allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", "format": "int32", "type": "integer" }, "processingUnits": { -"description": "The number of processing units allocated to this instance partition. Users can set the processing_units field to specify the target number of processing units allocated to the instance partition. This may be zero in API responses for instance partitions that are not yet in state `READY`.", +"description": "The number of processing units allocated to this instance partition. Users can set the `processing_units` field to specify the target number of processing units allocated to the instance partition. This might be zero in API responses for instance partitions that are not yet in the `READY` state.", "format": "int32", "type": "integer" }, @@ -4915,7 +5006,7 @@ "type": "string" }, "operations": { -"description": "The list of matching instance config long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", +"description": "The list of matching instance configuration long-running operations. Each operation's name will be prefixed by the instance config's name. The operation's metadata field type `metadata.type_url` describes the type of the metadata.", "items": { "$ref": "Operation" }, @@ -5199,7 +5290,7 @@ "id": "MoveInstanceRequest", "properties": { "targetConfig": { -"description": "Required. The target instance config for the instance to move. Values are of the form `projects//instanceConfigs/`.", +"description": "Required. The target instance configuration for the instance to move. Values are of the form `projects//instanceConfigs/`.", "type": "string" } }, @@ -5402,7 +5493,7 @@ "description": "Additional options that affect how many partitions are created." }, "sql": { -"description": "Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.", +"description": "Required. The query request to generate partitions for. The request fails if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, if the query execution plan contains a distributed union operator, then it must be the first operator in the plan. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as `INSERT`, `UPDATE`, or `DELETE`. Use `ExecuteStreamingSql` with a PartitionedDml transaction for large, partition-friendly DML operations.", "type": "string" }, "transaction": { @@ -5933,7 +6024,7 @@ "type": "string" }, "kmsKeyNames": { -"description": "Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configs, specify a single regional location KMS key. * For multi-regional database instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For a database instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.", +"description": "Optional. Specifies the KMS configuration for the one or more keys used to encrypt the database. Values have the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the database instance configuration. Some examples: * For single region database instance configurations, specify a single regional location KMS key. * For multi-regional database instance configurations of type `GOOGLE_MANAGED`, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance configuration. * For a database instance configuration of type `USER_MANAGED`, please specify only regional location KMS keys to cover each region in the instance configuration. Multi-regional location KMS keys are not supported for USER_MANAGED instance configurations.", "items": { "type": "string" }, @@ -6585,7 +6676,7 @@ }, "instanceConfig": { "$ref": "InstanceConfig", -"description": "The desired instance config after updating." +"description": "The desired instance configuration after updating." }, "progress": { "$ref": "InstanceOperationProgress", @@ -6600,7 +6691,7 @@ "properties": { "instanceConfig": { "$ref": "InstanceConfig", -"description": "Required. The user instance config to update, which must always include the instance config name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used." +"description": "Required. The user instance configuration to update, which must always include the instance configuration name. Otherwise, only fields mentioned in update_mask need be included. To prevent conflicts of concurrent updates, etag can be used." }, "updateMask": { "description": "Required. A mask specifying which fields in InstanceConfig should be updated. The field mask must always be specified; this prevents any future fields in InstanceConfig from being erased accidentally by clients that do not know about them. Only display_name and labels can be updated.", diff --git a/googleapiclient/discovery_cache/documents/sts.v1.json b/googleapiclient/discovery_cache/documents/sts.v1.json index d43723d23d0..333d599de7d 100644 --- a/googleapiclient/discovery_cache/documents/sts.v1.json +++ b/googleapiclient/discovery_cache/documents/sts.v1.json @@ -116,7 +116,7 @@ } } }, -"revision": "20240619", +"revision": "20240704", "rootUrl": "https://sts.googleapis.com/", "schemas": { "GoogleIamV1Binding": { @@ -216,6 +216,11 @@ "description": "Response message for ExchangeToken.", "id": "GoogleIdentityStsV1ExchangeTokenResponse", "properties": { +"access_boundary_session_key": { +"description": "The access boundary session key. This key is used along with the access boundary intermediate token to generate Credential Access Boundary tokens at client side. This field is absent when the `requested_token_type` from the request is not `urn:ietf:params:oauth:token-type:access_boundary_intermediate_token`.", +"format": "byte", +"type": "string" +}, "access_token": { "description": "An OAuth 2.0 security token, issued by Google, in response to the token exchange request. Tokens can vary in size, depending in part on the size of mapped claims, up to a maximum of 12288 bytes (12 KB). Google reserves the right to change the token size and the maximum length at any time.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 77bb347b97e..07fa8a94517 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -2280,7 +2280,7 @@ } } }, -"revision": "20240630", +"revision": "20240704", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4946,7 +4946,7 @@ "type": "string" }, "subnetwork": { -"description": "The subnetwork to connect the NIC to.", +"description": "Optional. The subnetwork to connect the NIC to.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 35f06a08b67..405791e82e9 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -2280,7 +2280,7 @@ } } }, -"revision": "20240630", +"revision": "20240704", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4991,7 +4991,7 @@ "type": "string" }, "subnetwork": { -"description": "The subnetwork to connect the NIC to.", +"description": "Optional. The subnetwork to connect the NIC to.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index e5c396201f0..02023de594c 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -772,7 +772,7 @@ } } }, -"revision": "20240626", +"revision": "20240701", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -797,6 +797,10 @@ "description": "Provides the mapping of a cloud asset to a direct physical location or to a proxy that defines the location on its behalf.", "id": "AssetLocation", "properties": { +"ccfeRmsPath": { +"description": "Spanner path of the CCFE RMS database. It is only applicable for CCFE tenants that use CCFE RMS for storing resource metadata.", +"type": "string" +}, "expected": { "$ref": "IsolationExpectations", "description": "Defines the customer expectation around ZI/ZS for this asset and ZI/ZS state of the region at the time of asset creation." diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index 29dc628984f..8c77a7140ec 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1195,7 +1195,7 @@ } } }, -"revision": "20240619", +"revision": "20240709", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1347,11 +1347,11 @@ "type": "object" }, "DomainConfig": { -"description": "Configuration options for private workstation clusters.", +"description": "Configuration options for a custom domain.", "id": "DomainConfig", "properties": { "domain": { -"description": "Immutable. Whether Workstations endpoint is private.", +"description": "Immutable. Domain used by Workstations for HTTP ingress.", "type": "string" } }, @@ -1940,23 +1940,45 @@ }, "type": "object" }, +"PortRange": { +"description": "A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", +"id": "PortRange", +"properties": { +"first": { +"description": "Required. Starting port number for the current range of ports.", +"format": "int32", +"type": "integer" +}, +"last": { +"description": "Required. Ending port number for the current range of ports.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "PrivateClusterConfig": { +"description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { +"description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { +"description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { +"description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { +"description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", "readOnly": true, "type": "string" } @@ -2282,6 +2304,13 @@ "description": "A workstation configuration resource in the Cloud Workstations API. Workstation configurations act as templates for workstations. The workstation configuration defines details such as the workstation virtual machine (VM) instance type, persistent storage, container image defining environment, which IDE or Code Editor to use, and more. Administrators and platform teams can also use [Identity and Access Management (IAM)](https://cloud.google.com/iam/docs/overview) rules to grant access to teams or to individual developers.", "id": "WorkstationConfig", "properties": { +"allowedPorts": { +"description": "Optional. A Single or Range of ports externally accessible in the workstation. If not specified defaults to ports 22, 80 and ports 1024-65535.", +"items": { +"$ref": "PortRange" +}, +"type": "array" +}, "annotations": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 5b482375dd1..8dc060a1552 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1127,7 +1127,7 @@ } } }, -"revision": "20240619", +"revision": "20240709", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1315,11 +1315,11 @@ "type": "object" }, "DomainConfig": { -"description": "Configuration options for private workstation clusters.", +"description": "Configuration options for a custom domain.", "id": "DomainConfig", "properties": { "domain": { -"description": "Immutable. Whether Workstations endpoint is private.", +"description": "Immutable. Domain used by Workstations for HTTP ingress.", "type": "string" } }, @@ -1875,7 +1875,7 @@ "type": "object" }, "PortRange": { -"description": "A PortsConfig defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", +"description": "A PortRange defines a range of ports. Both first and last are inclusive. To specify a single port, both first and last should be the same.", "id": "PortRange", "properties": { "first": { @@ -1892,22 +1892,27 @@ "type": "object" }, "PrivateClusterConfig": { +"description": "Configuration options for private workstation clusters.", "id": "PrivateClusterConfig", "properties": { "allowedProjects": { +"description": "Optional. Additional projects that are allowed to attach to the workstation cluster's service attachment. By default, the workstation cluster's project and the VPC host project (if different) are allowed.", "items": { "type": "string" }, "type": "array" }, "clusterHostname": { +"description": "Output only. Hostname for the workstation cluster. This field will be populated only when private endpoint is enabled. To access workstations in the workstation cluster, create a new DNS zone mapping this domain name to an internal IP address and a forwarding rule mapping that address to the service attachment.", "readOnly": true, "type": "string" }, "enablePrivateEndpoint": { +"description": "Immutable. Whether Workstations endpoint is private.", "type": "boolean" }, "serviceAttachmentUri": { +"description": "Output only. Service attachment URI for the workstation cluster. The service attachemnt is created when private endpoint is enabled. To access workstations in the workstation cluster, configure access to the managed service using [Private Service Connect](https://cloud.google.com/vpc/docs/configure-private-service-connect-services).", "readOnly": true, "type": "string" } @@ -2099,6 +2104,16 @@ "readOnly": true, "type": "boolean" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "sourceWorkstation": { "description": "Optional. The source workstation from which this workstations persistent directories were cloned on creation.", "type": "string" @@ -2219,6 +2234,16 @@ "readOnly": true, "type": "boolean" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "subnetwork": { "description": "Immutable. Name of the Compute Engine subnetwork in which instances associated with this workstation cluster will be created. Must be part of the subnetwork specified for this workstation cluster.", "type": "string" @@ -2366,6 +2391,16 @@ "format": "google-duration", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "uid": { "description": "Output only. A system-assigned unique identifier for this workstation configuration.", "readOnly": true, From 4192262a6edcffde7582051f985ef607d7486ccd Mon Sep 17 00:00:00 2001 From: Anthonios Partheniou Date: Thu, 25 Jul 2024 10:07:27 -0400 Subject: [PATCH 4/8] feat: add support for reading apiVersion in discovery artifacts (#2380) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat: add support for reading apiVersion in discovery artifacts * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot --- googleapiclient/discovery.py | 4 +++- googleapiclient/model.py | 24 ++++++++++++++++++++++-- tests/test_json_model.py | 30 ++++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+), 3 deletions(-) diff --git a/googleapiclient/discovery.py b/googleapiclient/discovery.py index a8f59bca5ab..f7bbd77763c 100644 --- a/googleapiclient/discovery.py +++ b/googleapiclient/discovery.py @@ -1170,9 +1170,11 @@ def method(self, **kwargs): elif "response" not in methodDesc: model = RawModel() + api_version = methodDesc.get("apiVersion", None) + headers = {} headers, params, query, body = model.request( - headers, actual_path_params, actual_query_params, body_value + headers, actual_path_params, actual_query_params, body_value, api_version ) expanded_url = uritemplate.expand(pathUrl, params) diff --git a/googleapiclient/model.py b/googleapiclient/model.py index 4ba27522357..dee1cb7f377 100644 --- a/googleapiclient/model.py +++ b/googleapiclient/model.py @@ -27,10 +27,18 @@ import logging import platform import urllib +import warnings from googleapiclient import version as googleapiclient_version from googleapiclient.errors import HttpError +try: + from google.api_core.version_header import API_VERSION_METADATA_KEY + + HAS_API_VERSION = True +except ImportError: + HAS_API_VERSION = False + _LIBRARY_VERSION = googleapiclient_version.__version__ _PY_VERSION = platform.python_version() @@ -121,7 +129,7 @@ def _log_request(self, headers, path_params, query, body): LOGGER.info("query: %s", query) LOGGER.info("--request-end--") - def request(self, headers, path_params, query_params, body_value): + def request(self, headers, path_params, query_params, body_value, api_version=None): """Updates outgoing requests with a serialized body. Args: @@ -129,7 +137,10 @@ def request(self, headers, path_params, query_params, body_value): path_params: dict, parameters that appear in the request path query_params: dict, parameters that appear in the query body_value: object, the request body as a Python object, which must be - serializable by json. + serializable by json. + api_version: str, The precise API version represented by this request, + which will result in an API Version header being sent along with the + HTTP request. Returns: A tuple of (headers, path_params, query, body) @@ -155,6 +166,15 @@ def request(self, headers, path_params, query_params, body_value): _PY_VERSION, ) + if api_version and HAS_API_VERSION: + headers[API_VERSION_METADATA_KEY] = api_version + elif api_version: + warnings.warn( + "The `api_version` argument is ignored as a newer version of " + "`google-api-core` is required to use this feature." + "Please upgrade `google-api-core` to 2.19.0 or newer." + ) + if body_value is not None: headers["content-type"] = self.content_type body_value = self.serialize(body_value) diff --git a/tests/test_json_model.py b/tests/test_json_model.py index a34cd6d94b5..1bd75e50850 100644 --- a/tests/test_json_model.py +++ b/tests/test_json_model.py @@ -35,6 +35,13 @@ import googleapiclient.model from googleapiclient.model import JsonModel +try: + from google.api_core.version_header import API_VERSION_METADATA_KEY + + HAS_API_VERSION = True +except ImportError: + HAS_API_VERSION = False + _LIBRARY_VERSION = googleapiclient_version.__version__ CSV_TEXT_MOCK = "column1,column2,column3\nstring1,1.2,string2" @@ -172,6 +179,29 @@ def test_x_goog_api_client(self): + platform.python_version(), ) + @unittest.skipIf( + not HAS_API_VERSION, + "Skip this test when an older version of google-api-core is used", + ) + def test_x_goog_api_version(self): + model = JsonModel(data_wrapper=False) + + # test header composition for clients that wrap discovery + headers = {} + path_params = {} + query_params = {} + body = {} + api_version = "20240401" + + headers, _, _, body = model.request( + headers, path_params, query_params, body, api_version + ) + + self.assertEqual( + headers[API_VERSION_METADATA_KEY], + api_version, + ) + def test_bad_response(self): model = JsonModel(data_wrapper=False) resp = httplib2.Response({"status": "401"}) From 11b23179dde21a41e94e7b8de8d82ab2d35c95b3 Mon Sep 17 00:00:00 2001 From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com> Date: Thu, 25 Jul 2024 07:34:18 -0700 Subject: [PATCH 5/8] chore: Update discovery artifacts (#2449) ## Deleted keys were detected in the following stable discovery artifacts: aiplatform v1 https://togithub.com/googleapis/google-api-python-client/commit/747f957e058ba26859b638cb58d4813604d2bca2 backupdr v1 https://togithub.com/googleapis/google-api-python-client/commit/94e533dd77c9920aaf61cf16f22843316deca6f6 firestore v1 https://togithub.com/googleapis/google-api-python-client/commit/7528377e42be5bf2fdfe16c9e864c3559ce2ab87 iam v1 https://togithub.com/googleapis/google-api-python-client/commit/0b7098e661f3656a44000082d21cc2ded3c9bcc0 ## Deleted keys were detected in the following pre-stable discovery artifacts: aiplatform v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/747f957e058ba26859b638cb58d4813604d2bca2 analyticsadmin v1alpha https://togithub.com/googleapis/google-api-python-client/commit/642222f040c25320b0948a29c8cb1ffe7aaa12d8 analyticsadmin v1beta https://togithub.com/googleapis/google-api-python-client/commit/642222f040c25320b0948a29c8cb1ffe7aaa12d8 firebaseml v2beta https://togithub.com/googleapis/google-api-python-client/commit/18f788f8034f124173ea8f3ed0029f66039e2441 ## Discovery Artifact Change Summary: feat(aiplatform): update the api https://togithub.com/googleapis/google-api-python-client/commit/747f957e058ba26859b638cb58d4813604d2bca2 feat(analyticsadmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/642222f040c25320b0948a29c8cb1ffe7aaa12d8 feat(apim): update the api https://togithub.com/googleapis/google-api-python-client/commit/f4f6f4c760f5ecbd785bc84dda38e43168fb6395 feat(artifactregistry): update the api https://togithub.com/googleapis/google-api-python-client/commit/94b103b199d5c4ce07ac02f7bc9c5e4c31bc1938 feat(backupdr): update the api https://togithub.com/googleapis/google-api-python-client/commit/94e533dd77c9920aaf61cf16f22843316deca6f6 feat(cloudcontrolspartner): update the api https://togithub.com/googleapis/google-api-python-client/commit/49a06b974fb44620539ce66df5927125b777d471 feat(composer): update the api https://togithub.com/googleapis/google-api-python-client/commit/df463d0039933b07bd5434aaf577dee9ee3bee8e feat(compute): update the api https://togithub.com/googleapis/google-api-python-client/commit/4b4761e4d4110942b72a0a85c293dcfa4e4bb6e7 feat(connectors): update the api https://togithub.com/googleapis/google-api-python-client/commit/74af8403ef2bcb4a787f2d5426713a666d1f8c98 feat(container): update the api https://togithub.com/googleapis/google-api-python-client/commit/92f07f9106ca51dbe8fad9eefcad1a02f36e8b6a feat(content): update the api https://togithub.com/googleapis/google-api-python-client/commit/187dccd6e9d0ba5d2c2d230b54ba1b8971368608 feat(discoveryengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/ba150f23302f316a1a711970129288c71846aaa5 feat(displayvideo): update the api https://togithub.com/googleapis/google-api-python-client/commit/53bc0c31b3a166f4950f7971d7941f4e8bb4dbb0 feat(docs): update the api https://togithub.com/googleapis/google-api-python-client/commit/7e0a2285275f52daeb5d0f1587f44070ef46cf38 feat(documentai): update the api https://togithub.com/googleapis/google-api-python-client/commit/0e0445b53217eb350348f4cf1f141299397f1e99 feat(firebaseml): update the api https://togithub.com/googleapis/google-api-python-client/commit/18f788f8034f124173ea8f3ed0029f66039e2441 feat(firestore): update the api https://togithub.com/googleapis/google-api-python-client/commit/7528377e42be5bf2fdfe16c9e864c3559ce2ab87 feat(healthcare): update the api https://togithub.com/googleapis/google-api-python-client/commit/3eab6456742fb5d3c61ce1b6043508b8e4e4e5be feat(iam): update the api https://togithub.com/googleapis/google-api-python-client/commit/0b7098e661f3656a44000082d21cc2ded3c9bcc0 feat(manufacturers): update the api https://togithub.com/googleapis/google-api-python-client/commit/886359d58a6971f3fc31ac5e6f1374c1e9f0c786 feat(merchantapi): update the api https://togithub.com/googleapis/google-api-python-client/commit/eca619a5691645c84789ee584d40b1752ca49b8b feat(migrationcenter): update the api https://togithub.com/googleapis/google-api-python-client/commit/aea73cc28f734bf25064285eedbd86efbfc57f2b feat(recaptchaenterprise): update the api https://togithub.com/googleapis/google-api-python-client/commit/4763dcb75a3b510496173997a2ff9493cb61a2de feat(retail): update the api https://togithub.com/googleapis/google-api-python-client/commit/e01a97afee104c9e115bb8692c404f75402b15ac feat(sheets): update the api https://togithub.com/googleapis/google-api-python-client/commit/145e031a5c691e761b2ea7e47ec6785bffeedbf5 feat(spanner): update the api https://togithub.com/googleapis/google-api-python-client/commit/0b4779866edda58077354ac12bb5ce7e65c528ad feat(sqladmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/ba212b8c76588499737a2fbbd7bfdcac9ce27671 feat(translate): update the api https://togithub.com/googleapis/google-api-python-client/commit/8fa1081d40f233074b9fc861c040d1bd7c0d3ae7 feat(vmmigration): update the api https://togithub.com/googleapis/google-api-python-client/commit/5dce2c4fba203ab7a7d26e85d37023f5064212dd feat(walletobjects): update the api https://togithub.com/googleapis/google-api-python-client/commit/a7863fd9a639ac124fb2223e5b8ebeca801ab21c feat(workflowexecutions): update the api https://togithub.com/googleapis/google-api-python-client/commit/7a87be857aeb57dd542db3ed76550351461150b0 feat(workstations): update the api https://togithub.com/googleapis/google-api-python-client/commit/5a10b67fee7f5d0424bade31870d6716496f1369 --- ...anager_v1.accessPolicies.accessLevels.html | 10 +- ...r_v1.accessPolicies.servicePerimeters.html | 40 +- docs/dyn/adsenseplatform_v1.html | 111 + ...platform_v1.platforms.accounts.events.html | 147 + ...adsenseplatform_v1.platforms.accounts.html | 271 + ...eplatform_v1.platforms.accounts.sites.html | 233 + docs/dyn/adsenseplatform_v1.platforms.html | 91 + ...form_v1.projects.locations.customJobs.html | 4 + ...ts.locations.datasets.datasetVersions.html | 12 +- ...atform_v1.projects.locations.datasets.html | 12 +- ...tform_v1.projects.locations.endpoints.html | 136 +- ...ions.featureOnlineStores.featureViews.html | 9 + ...ts.locations.hyperparameterTuningJobs.html | 4 + ...latform_v1.projects.locations.nasJobs.html | 8 + ...jects.locations.notebookExecutionJobs.html | 263 + ...rojects.locations.persistentResources.html | 24 + ....projects.locations.publishers.models.html | 126 +- docs/dyn/aiplatform_v1.publishers.models.html | 7 +- docs/dyn/aiplatform_v1beta1.media.html | 66 + ...ta1.projects.locations.cachedContents.html | 12 +- ...v1beta1.projects.locations.customJobs.html | 4 + ...ts.locations.datasets.datasetVersions.html | 12 +- ...m_v1beta1.projects.locations.datasets.html | 12 +- ..._v1beta1.projects.locations.endpoints.html | 187 +- ...ions.featureOnlineStores.featureViews.html | 9 + ...ts.locations.hyperparameterTuningJobs.html | 4 + ...eta1.projects.locations.modelMonitors.html | 8 + ...rm_v1beta1.projects.locations.nasJobs.html | 8 + ...rojects.locations.persistentResources.html | 24 + ...beta1.projects.locations.pipelineJobs.html | 8 + ....projects.locations.publishers.models.html | 177 +- ...rojects.locations.ragCorpora.ragFiles.html | 99 + ..._v1beta1.projects.locations.schedules.html | 12 + .../aiplatform_v1beta1.publishers.models.html | 9 +- docs/dyn/analyticsadmin_v1alpha.accounts.html | 6 +- ...n_v1alpha.properties.conversionEvents.html | 20 +- ...sadmin_v1alpha.properties.dataStreams.html | 7 +- ...dmin_v1alpha.properties.firebaseLinks.html | 6 +- docs/dyn/analyticsadmin_v1beta.accounts.html | 6 +- ...in_v1beta.properties.conversionEvents.html | 20 +- ...csadmin_v1beta.properties.dataStreams.html | 5 - ...admin_v1beta.properties.firebaseLinks.html | 6 +- ...ement_v1.enterprises.enrollmentTokens.html | 4 +- docs/dyn/apim_v1alpha.projects.locations.html | 44 + ...ionJobs.apiObservations.apiOperations.html | 4 +- ...tions.observationJobs.apiObservations.html | 62 +- ...ha.projects.locations.observationJobs.html | 4 +- ...projects.locations.observationSources.html | 4 +- docs/dyn/artifactregistry_v1.projects.html | 3 + .../artifactregistry_v1beta2.projects.html | 3 + ...place_v1alpha.bidders.auctionPackages.html | 153 + ...tplace_v1alpha.bidders.finalizedDeals.html | 370 + ...izedbuyersmarketplace_v1alpha.bidders.html | 96 + ...tplace_v1alpha.buyers.auctionPackages.html | 388 + ...ersmarketplace_v1alpha.buyers.clients.html | 315 + ...ketplace_v1alpha.buyers.clients.users.html | 272 + ...rketplace_v1alpha.buyers.dataSegments.html | 333 + ...etplace_v1alpha.buyers.finalizedDeals.html | 1686 + ...rizedbuyersmarketplace_v1alpha.buyers.html | 116 + ...tplace_v1alpha.buyers.proposals.deals.html | 1532 + ...smarketplace_v1alpha.buyers.proposals.html | 662 + ...lace_v1alpha.buyers.publisherProfiles.html | 203 + .../authorizedbuyersmarketplace_v1alpha.html | 116 + ...ions.backupVaults.dataSources.backups.html | 9 +- ...dr_v1.projects.locations.backupVaults.html | 5 +- ....projects.locations.dnsAuthorizations.html | 8 +- .../classroom_v1.courses.announcements.html | 2 +- docs/dyn/classroom_v1.courses.courseWork.html | 2 +- ...ssroom_v1.courses.courseWorkMaterials.html | 2 +- docs/dyn/classroom_v1.courses.posts.html | 2 +- docs/dyn/cloudasset_v1.assets.html | 10 +- docs/dyn/cloudasset_v1.v1.html | 20 +- .../dyn/cloudasset_v1beta1.organizations.html | 10 +- docs/dyn/cloudasset_v1beta1.projects.html | 10 +- docs/dyn/cloudasset_v1p5beta1.assets.html | 10 +- ..._v1.organizations.locations.customers.html | 12 +- ...eta.organizations.locations.customers.html | 12 +- ...tions_v1.projects.locations.functions.html | 8 +- ...loudtrace_v2beta1.projects.traceSinks.html | 24 +- ...er_v1.projects.locations.environments.html | 4 + ...beta1.projects.locations.environments.html | 4 + docs/dyn/compute_alpha.html | 15 + .../compute_alpha.instanceGroupManagers.html | 18 + .../compute_alpha.instantSnapshotGroups.html | 490 + docs/dyn/compute_alpha.interconnects.html | 32 + ...ionInstanceGroupManagerResizeRequests.html | 479 + ...ute_alpha.regionInstanceGroupManagers.html | 15 + ...ute_alpha.regionInstantSnapshotGroups.html | 490 + docs/dyn/compute_alpha.regionMultiMigs.html | 24 + ...fig_v1.projects.locations.deployments.html | 16 +- ...jects.locations.deployments.revisions.html | 8 +- ...config_v1.projects.locations.previews.html | 12 +- ...ors_v1.projects.locations.connections.html | 10 + ...cations.providers.connectors.versions.html | 2 + ...tainer_v1.projects.locations.clusters.html | 598 +- ...projects.locations.clusters.nodePools.html | 214 +- ...iner_v1.projects.locations.operations.html | 44 +- .../container_v1.projects.zones.clusters.html | 598 +- ..._v1.projects.zones.clusters.nodePools.html | 214 +- ...ontainer_v1.projects.zones.operations.html | 44 +- ...r_v1beta1.projects.locations.clusters.html | 598 +- ...projects.locations.clusters.nodePools.html | 214 +- ...v1beta1.projects.locations.operations.html | 44 +- ...ainer_v1beta1.projects.zones.clusters.html | 598 +- ...ta1.projects.zones.clusters.nodePools.html | 214 +- ...ner_v1beta1.projects.zones.operations.html | 44 +- docs/dyn/content_v2_1.products.html | 32 +- .../dyn/css_v1.accounts.cssProductInputs.html | 16 +- docs/dyn/css_v1.accounts.cssProducts.html | 16 +- ...1.projects.conversations.participants.html | 2 +- ....locations.conversations.participants.html | 2 +- ...collections.dataStores.servingConfigs.html | 8 +- ...llections.dataStores.sessions.answers.html | 2 +- ...ns.collections.engines.servingConfigs.html | 8 +- ....collections.engines.sessions.answers.html | 2 +- ...s.locations.dataStores.servingConfigs.html | 8 +- ...locations.dataStores.sessions.answers.html | 2 +- ...discoveryengine_v1.projects.locations.html | 5 + ...cts.locations.identity_mapping_stores.html | 91 + ...collections.dataStores.servingConfigs.html | 19 +- ...llections.dataStores.sessions.answers.html | 2 +- ...llections.dataStores.siteSearchEngine.html | 79 + ...ns.collections.engines.servingConfigs.html | 19 +- ....collections.engines.sessions.answers.html | 2 +- ...s.locations.dataStores.servingConfigs.html | 19 +- ...locations.dataStores.sessions.answers.html | 2 +- ...1alpha.projects.locations.evaluations.html | 842 + ...veryengine_v1alpha.projects.locations.html | 5 + ...cts.locations.identity_mapping_stores.html | 91 + ...ha.projects.locations.sampleQuerySets.html | 172 + ...cations.sampleQuerySets.sampleQueries.html | 398 + ...collections.dataStores.servingConfigs.html | 19 +- ...llections.dataStores.sessions.answers.html | 2 +- ...ns.collections.engines.servingConfigs.html | 19 +- ....collections.engines.sessions.answers.html | 2 +- ...s.locations.dataStores.servingConfigs.html | 19 +- ...locations.dataStores.sessions.answers.html | 2 +- ...v1beta.projects.locations.evaluations.html | 830 + ...ta.projects.locations.sampleQuerySets.html | 172 + ...cations.sampleQuerySets.sampleQueries.html | 398 + ...displayvideo_v3.advertisers.creatives.html | 12 +- .../dyn/displayvideo_v3.sdfdownloadtasks.html | 4 +- docs/dyn/docs_v1.documents.html | 56647 ++++++++++++---- ...ocations.processors.processorVersions.html | 30 + ...ocations.processors.processorVersions.html | 30 + ....projects.locations.publishers.models.html | 8 +- ...v1.projects.databases.backupSchedules.html | 84 +- ...store_v1.projects.databases.documents.html | 8 +- ..._v1beta1.projects.databases.documents.html | 8 +- ...ojects.locations.datasets.dicomStores.html | 2 +- ...rojects.locations.datasets.fhirStores.html | 136 +- ...cations.datasets.hl7V2Stores.messages.html | 80 +- ...thcare_v1.projects.locations.datasets.html | 2 +- ...ojects.locations.datasets.dicomStores.html | 2 +- ...rojects.locations.datasets.fhirStores.html | 146 +- ...e_v1beta1.projects.locations.datasets.html | 2 +- docs/dyn/iam_v1.organizations.roles.html | 4 +- docs/dyn/iam_v1.projects.roles.html | 4 +- .../iam_v1.projects.serviceAccounts.keys.html | 82 - docs/dyn/index.md | 6 +- ...ounts.languages.productCertifications.html | 12 + .../manufacturers_v1.accounts.products.html | 6 + docs/dyn/meet_v2.spaces.html | 48 +- ...ccounts.termsOfServiceAgreementStates.html | 6 +- ...roducts_v1beta.accounts.productInputs.html | 8 + ...api_products_v1beta.accounts.products.html | 8 + ...ha1.projects.locations.preferenceSets.html | 8 +- ...jects.locations.reportConfigs.reports.html | 48 +- docs/dyn/pollen_v1.forecast.html | 12 +- docs/dyn/pollen_v1.mapTypes.heatmapTiles.html | 2 +- ...chaenterprise_v1.projects.assessments.html | 4 +- .../recaptchaenterprise_v1.projects.keys.html | 30 +- ...rojects.locations.catalogs.userEvents.html | 55 + ...rojects.locations.catalogs.userEvents.html | 55 + .../dyn/run_v1.namespaces.configurations.html | 4 +- docs/dyn/run_v1.namespaces.revisions.html | 4 +- docs/dyn/run_v1.namespaces.services.html | 12 +- ..._v1.projects.locations.configurations.html | 4 +- .../run_v1.projects.locations.revisions.html | 4 +- .../run_v1.projects.locations.services.html | 12 +- .../run_v2.projects.locations.services.html | 8 +- ...ThreatDetectionSettings.customModules.html | 10 +- ...ectionSettings.effectiveCustomModules.html | 4 +- ....folders.eventThreatDetectionSettings.html | 2 +- ...itycenter_v1.folders.sources.findings.html | 2 +- ...ThreatDetectionSettings.customModules.html | 10 +- ...ectionSettings.effectiveCustomModules.html | 4 +- ...izations.eventThreatDetectionSettings.html | 2 +- ...ter_v1.organizations.sources.findings.html | 2 +- ...ThreatDetectionSettings.customModules.html | 10 +- ...ectionSettings.effectiveCustomModules.html | 4 +- ...projects.eventThreatDetectionSettings.html | 2 +- ...tycenter_v1.projects.sources.findings.html | 2 +- ...ders.containerThreatDetectionSettings.html | 4 +- ....folders.eventThreatDetectionSettings.html | 4 +- docs/dyn/securitycenter_v1beta2.folders.html | 70 +- ...lders.securityHealthAnalyticsSettings.html | 4 +- ...virtualMachineThreatDetectionSettings.html | 4 +- ...a2.folders.webSecurityScannerSettings.html | 4 +- ...ions.containerThreatDetectionSettings.html | 4 +- ...izations.eventThreatDetectionSettings.html | 4 +- .../securitycenter_v1beta2.organizations.html | 70 +- ...tions.securityHealthAnalyticsSettings.html | 4 +- ...virtualMachineThreatDetectionSettings.html | 4 +- ...anizations.webSecurityScannerSettings.html | 4 +- ...ects.containerThreatDetectionSettings.html | 4 +- ...projects.eventThreatDetectionSettings.html | 4 +- docs/dyn/securitycenter_v1beta2.projects.html | 70 +- ...ters.containerThreatDetectionSettings.html | 4 +- ...r_v1beta2.projects.locations.clusters.html | 14 +- ...jects.securityHealthAnalyticsSettings.html | 4 +- ...virtualMachineThreatDetectionSettings.html | 4 +- ...2.projects.webSecurityScannerSettings.html | 4 +- ...servicemanagement_v1.services.configs.html | 32 +- docs/dyn/servicemanagement_v1.services.html | 8 +- docs/dyn/serviceusage_v1.services.html | 6 +- docs/dyn/serviceusage_v1beta1.services.html | 4 +- docs/dyn/sheets_v4.spreadsheets.html | 45 + ...spanner_v1.projects.instances.backups.html | 15 + ...s.instances.databases.backupSchedules.html | 257 + docs/dyn/sqladmin_v1.connect.html | 1 + docs/dyn/sqladmin_v1.instances.html | 18 +- docs/dyn/sqladmin_v1beta4.connect.html | 1 + docs/dyn/sqladmin_v1beta4.instances.html | 18 +- docs/dyn/translate_v3.projects.html | 2 +- ....locations.glossaries.glossaryEntries.html | 14 +- docs/dyn/translate_v3.projects.locations.html | 27 +- ...on_v1.projects.locations.imageImports.html | 282 + ...ocations.imageImports.imageImportJobs.html | 94 + ...ations.sources.migratingVms.cloneJobs.html | 3 + ...ions.sources.migratingVms.cutoverJobs.html | 3 + ...ojects.locations.sources.migratingVms.html | 16 + ...lpha1.projects.locations.imageImports.html | 282 + ...ocations.imageImports.imageImportJobs.html | 94 + ...ations.sources.migratingVms.cloneJobs.html | 9 + ...ions.sources.migratingVms.cutoverJobs.html | 9 + ...ojects.locations.sources.migratingVms.html | 40 + .../walletobjects_v1.eventticketobject.html | 30 + docs/dyn/walletobjects_v1.flightclass.html | 72 +- docs/dyn/walletobjects_v1.flightobject.html | 99 +- docs/dyn/walletobjects_v1.genericobject.html | 27 + docs/dyn/walletobjects_v1.giftcardobject.html | 27 + docs/dyn/walletobjects_v1.jwt.html | 37 +- docs/dyn/walletobjects_v1.loyaltyobject.html | 30 + docs/dyn/walletobjects_v1.offerobject.html | 27 + docs/dyn/walletobjects_v1.transitobject.html | 27 + ...ojects.locations.workflows.executions.html | 5 + ...tions_v1.projects.locations.workflows.html | 1 + ...flows_v1.projects.locations.workflows.html | 10 +- ...orkstationClusters.workstationConfigs.html | 20 +- ...orkstationClusters.workstationConfigs.html | 30 +- ...sters.workstationConfigs.workstations.html | 25 + .../documents/accesscontextmanager.v1.json | 8 +- .../documents/adsenseplatform.v1.json | 721 + .../documents/aiplatform.v1.json | 627 +- .../documents/aiplatform.v1beta1.json | 449 +- .../documents/analyticsadmin.v1alpha.json | 69 +- .../documents/analyticsadmin.v1beta.json | 67 +- .../documents/androidmanagement.v1.json | 12 +- .../documents/apim.v1alpha.json | 163 +- .../documents/artifactregistry.v1.json | 7 +- .../documents/artifactregistry.v1beta2.json | 7 +- .../documents/assuredworkloads.v1.json | 6 +- .../documents/assuredworkloads.v1beta1.json | 6 +- .../authorizedbuyersmarketplace.v1alpha.json | 3513 + .../documents/backupdr.v1.json | 16 +- .../documents/certificatemanager.v1.json | 4 +- .../documents/classroom.v1.json | 10 +- .../documents/cloudasset.v1.json | 8 +- .../documents/cloudasset.v1beta1.json | 8 +- .../documents/cloudasset.v1p1beta1.json | 8 +- .../documents/cloudasset.v1p5beta1.json | 8 +- .../documents/cloudasset.v1p7beta1.json | 8 +- .../documents/cloudcontrolspartner.v1.json | 11 +- .../cloudcontrolspartner.v1beta.json | 11 +- .../documents/cloudfunctions.v1.json | 4 +- .../documents/cloudtrace.v2beta1.json | 6 +- .../documents/composer.v1.json | 7 +- .../documents/composer.v1beta1.json | 7 +- .../documents/compute.alpha.json | 799 +- .../discovery_cache/documents/config.v1.json | 6 +- .../documents/connectors.v1.json | 27 +- .../documents/container.v1.json | 155 +- .../documents/container.v1beta1.json | 154 +- .../documents/content.v2.1.json | 8 +- .../discovery_cache/documents/css.v1.json | 10 +- .../documents/dialogflow.v2beta1.json | 4 +- .../documents/discoveryengine.v1.json | 3858 +- .../documents/discoveryengine.v1alpha.json | 2483 +- .../documents/discoveryengine.v1beta.json | 6941 +- .../documents/displayvideo.v3.json | 17 +- .../discovery_cache/documents/docs.v1.json | 247 +- .../documents/documentai.v1.json | 63 +- .../documents/documentai.v1beta3.json | 63 +- .../firebaseappdistribution.v1alpha.json | 8 +- .../documents/firebaseml.v2beta.json | 27 +- .../documents/firestore.v1.json | 44 +- .../documents/firestore.v1beta1.json | 4 +- .../documents/healthcare.v1.json | 39 +- .../documents/healthcare.v1beta1.json | 60 +- .../discovery_cache/documents/iam.v1.json | 63 +- .../documents/language.v2.json | 10 +- .../documents/manufacturers.v1.json | 10 +- .../discovery_cache/documents/meet.v2.json | 20 +- .../merchantapi.accounts_v1beta.json | 6 +- .../merchantapi.datasources_v1beta.json | 4 +- .../merchantapi.products_v1beta.json | 6 +- .../documents/migrationcenter.v1alpha1.json | 38 +- .../documents/ondemandscanning.v1.json | 8 +- .../documents/ondemandscanning.v1beta1.json | 8 +- .../discovery_cache/documents/pollen.v1.json | 16 +- .../documents/recaptchaenterprise.v1.json | 18 +- .../discovery_cache/documents/redis.v1.json | 5 +- .../documents/redis.v1beta1.json | 5 +- .../documents/retail.v2alpha.json | 45 +- .../documents/retail.v2beta.json | 45 +- .../discovery_cache/documents/run.v1.json | 4 +- .../discovery_cache/documents/run.v2.json | 4 +- .../documents/securitycenter.v1.json | 66 +- .../documents/securitycenter.v1beta1.json | 16 +- .../documents/securitycenter.v1beta2.json | 68 +- .../serviceconsumermanagement.v1.json | 10 +- .../serviceconsumermanagement.v1beta1.json | 10 +- .../documents/servicemanagement.v1.json | 10 +- .../documents/servicenetworking.v1.json | 10 +- .../documents/servicenetworking.v1beta.json | 10 +- .../documents/serviceusage.v1.json | 10 +- .../documents/serviceusage.v1beta1.json | 10 +- .../discovery_cache/documents/sheets.v4.json | 25 +- .../discovery_cache/documents/spanner.v1.json | 293 +- .../documents/sqladmin.v1.json | 51 +- .../documents/sqladmin.v1beta4.json | 51 +- .../documents/translate.v3.json | 79 +- .../documents/vmmigration.v1.json | 164 +- .../documents/vmmigration.v1alpha1.json | 164 +- .../documents/walletobjects.v1.json | 49 +- .../documents/workflowexecutions.v1.json | 16 +- .../documents/workflows.v1.json | 4 +- .../documents/workstations.v1.json | 6 +- .../documents/workstations.v1beta.json | 28 +- 340 files changed, 77751 insertions(+), 21339 deletions(-) create mode 100644 docs/dyn/adsenseplatform_v1.html create mode 100644 docs/dyn/adsenseplatform_v1.platforms.accounts.events.html create mode 100644 docs/dyn/adsenseplatform_v1.platforms.accounts.html create mode 100644 docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html create mode 100644 docs/dyn/adsenseplatform_v1.platforms.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html create mode 100644 docs/dyn/authorizedbuyersmarketplace_v1alpha.html create mode 100644 docs/dyn/compute_alpha.instantSnapshotGroups.html create mode 100644 docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html create mode 100644 docs/dyn/compute_alpha.regionInstantSnapshotGroups.html create mode 100644 docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html create mode 100644 docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html create mode 100644 docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html create mode 100644 googleapiclient/discovery_cache/documents/adsenseplatform.v1.json create mode 100644 googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html index 558a2d04924..fa9f3f99417 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html @@ -154,7 +154,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -299,7 +299,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -385,7 +385,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -474,7 +474,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -577,7 +577,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", diff --git a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html index f2fa669849b..4c57a03e76a 100644 --- a/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html +++ b/docs/dyn/accesscontextmanager_v1.accessPolicies.servicePerimeters.html @@ -177,9 +177,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -261,9 +261,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -431,9 +431,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -515,9 +515,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -627,9 +627,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -711,9 +711,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -829,9 +829,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -913,9 +913,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1047,9 +1047,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1131,9 +1131,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/adsenseplatform_v1.html b/docs/dyn/adsenseplatform_v1.html new file mode 100644 index 00000000000..ba547cb16b8 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.html @@ -0,0 +1,111 @@ + + + +

AdSense Platform API

+

Instance Methods

+

+ platforms() +

+

Returns the platforms 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/adsenseplatform_v1.platforms.accounts.events.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.events.html new file mode 100644 index 00000000000..7f12463dc4b --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.events.html @@ -0,0 +1,147 @@ + + + +

AdSense Platform API . platforms . accounts . events

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates an account event.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates an account event.
+
+Args:
+  parent: string, Required. Account to log events about. Format: platforms/{platform}/accounts/{account} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A platform sub-account event to record spam signals.
+  "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
+    "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
+      "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
+      "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
+      "city": "A String", # City. Max length 60 bytes or 30 characters.
+      "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
+      "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
+      "fax": "A String", # Fax number with international code (i.e. +441234567890).
+      "phone": "A String", # Phone number with international code (i.e. +441234567890).
+      "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
+      "state": "A String", # State. Max length 60 bytes or 30 characters.
+      "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
+    },
+    "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
+  },
+  "eventTime": "A String", # Required. Event timestamp.
+  "eventType": "A String", # Required. Event type.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A platform sub-account event to record spam signals.
+  "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
+    "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
+      "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
+      "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
+      "city": "A String", # City. Max length 60 bytes or 30 characters.
+      "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
+      "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
+      "fax": "A String", # Fax number with international code (i.e. +441234567890).
+      "phone": "A String", # Phone number with international code (i.e. +441234567890).
+      "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
+      "state": "A String", # State. Max length 60 bytes or 30 characters.
+      "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
+    },
+    "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
+  },
+  "eventTime": "A String", # Required. Event timestamp.
+  "eventType": "A String", # Required. Event type.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.accounts.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.html new file mode 100644 index 00000000000..06f3491d1fa --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.html @@ -0,0 +1,271 @@ + + + +

AdSense Platform API . platforms . accounts

+

Instance Methods

+

+ events() +

+

Returns the events Resource.

+ +

+ sites() +

+

Returns the sites Resource.

+ +

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

+

Closes a sub-account.

+

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

+

Creates a sub-account.

+

+ get(name, x__xgafv=None)

+

Gets information about the selected sub-account.

+

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

+

Lists a partial view of sub-accounts for a specific parent account.

+

+ list_next()

+

Retrieves the next page of results.

+

+ lookup(parent, creationRequestId=None, x__xgafv=None)

+

Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.

+

Method Details

+
+ close(name, body=None, x__xgafv=None) +
Closes a sub-account.
+
+Args:
+  name: string, Required. Account to close. Format: platforms/{platform}/accounts/{account_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request definition for the account close rpc.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the account close rpc.
+}
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a sub-account.
+
+Args:
+  parent: string, Required. Platform to create an account for. Format: platforms/{platform} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Representation of an Account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+  "displayName": "A String", # Display name of this account.
+  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+  "state": "A String", # Output only. Approval state of the account.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of an Account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+  "displayName": "A String", # Display name of this account.
+  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+  "state": "A String", # Output only. Approval state of the account.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets information about the selected sub-account.
+
+Args:
+  name: string, Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of an Account.
+  "createTime": "A String", # Output only. Creation time of the account.
+  "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+  "displayName": "A String", # Display name of this account.
+  "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+  "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+  "state": "A String", # Output only. Approval state of the account.
+  "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists a partial view of sub-accounts for a specific parent account.
+
+Args:
+  parent: string, Required. Platform who parents the accounts. Format: platforms/{platform} (required)
+  pageSize: integer, Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the list accounts rpc.
+  "accounts": [ # The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.
+    { # Representation of an Account.
+      "createTime": "A String", # Output only. Creation time of the account.
+      "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+      "displayName": "A String", # Display name of this account.
+      "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+      "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+      "state": "A String", # Output only. Approval state of the account.
+      "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+
+ +
+ 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.
+        
+
+ +
+ lookup(parent, creationRequestId=None, x__xgafv=None) +
Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
+
+Args:
+  parent: string, Required. Platform who parents the account. Format: platforms/{platform} (required)
+  creationRequestId: string, Optional. The creation_request_id provided when calling createAccount.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the lookup account rpc.
+  "name": "A String", # The name of the Account Format: platforms/{platform}/accounts/{account_id}
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html b/docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html new file mode 100644 index 00000000000..4a95b8d4c14 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.accounts.sites.html @@ -0,0 +1,233 @@ + + + +

AdSense Platform API . platforms . accounts . sites

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a site for a specified account.

+

+ delete(name, x__xgafv=None)

+

Deletes a site from a specified account.

+

+ get(name, x__xgafv=None)

+

Gets a site from a specified sub-account.

+

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

+

Lists sites for a specific account.

+

+ list_next()

+

Retrieves the next page of results.

+

+ requestReview(name, x__xgafv=None)

+

Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a site for a specified account.
+
+Args:
+  parent: string, Required. Account to create site. Format: platforms/{platform}/accounts/{account_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Representation of a Site.
+  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+  "state": "A String", # Output only. State of a site.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a Site.
+  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+  "state": "A String", # Output only. State of a site.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a site from a specified account.
+
+Args:
+  name: string, Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a site from a specified sub-account.
+
+Args:
+  name: string, Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Representation of a Site.
+  "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+  "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+  "state": "A String", # Output only. State of a site.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists sites for a specific account.
+
+Args:
+  parent: string, Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account} (required)
+  pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+  pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the site list rpc.
+  "nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this.
+  "sites": [ # The sites returned in this list response.
+    { # Representation of a Site.
+      "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+      "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+      "state": "A String", # Output only. State of a site.
+    },
+  ],
+}
+
+ +
+ 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.
+        
+
+ +
+ requestReview(name, x__xgafv=None) +
Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.
+
+Args:
+  name: string, Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response definition for the site request review rpc.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/adsenseplatform_v1.platforms.html b/docs/dyn/adsenseplatform_v1.platforms.html new file mode 100644 index 00000000000..f29fbe80cf9 --- /dev/null +++ b/docs/dyn/adsenseplatform_v1.platforms.html @@ -0,0 +1,91 @@ + + + +

AdSense Platform API . platforms

+

Instance Methods

+

+ accounts() +

+

Returns the accounts Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html index 6144b94f678..e8f43c5be17 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.customJobs.html @@ -175,6 +175,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -289,6 +290,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -445,6 +447,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -572,6 +575,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html index d834f3c933d..27ac91cb8ce 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.datasetVersions.html @@ -120,7 +120,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -210,7 +210,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }
@@ -243,7 +243,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }, ], @@ -270,7 +270,7 @@

Method Details

Updates a DatasetVersion.
 
 Args:
-  name: string, Output only. The resource name of the DatasetVersion. (required)
+  name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -281,7 +281,7 @@ 

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -301,7 +301,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.html index 039f667f418..b14cce7c329 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.html @@ -163,7 +163,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -336,7 +336,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -449,7 +449,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -490,7 +490,7 @@

Method Details

Updates a Dataset.
 
 Args:
-  name: string, Output only. The resource name of the Dataset. (required)
+  name: string, Output only. Identifier. The resource name of the Dataset. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -510,7 +510,7 @@ 

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -553,7 +553,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index 15a076e84f3..3b52e278156 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -158,7 +158,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -192,10 +192,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -231,7 +231,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -265,10 +265,88 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "fileData": { # URI based data. # Optional. URI based data. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "response": { # Required. The function response in JSON object format. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. Text part (can be code). + "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + }, + "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "default": "", # Optional. Default value of the data. + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + }, + ], + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + }, + "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}` + }, + }, + }, + ], } x__xgafv: string, V1 error format. @@ -296,6 +374,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -1262,7 +1342,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -1333,21 +1413,6 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1395,6 +1460,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1435,6 +1501,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -1639,6 +1707,8 @@

Method Details

"endpoints": [ # List of Endpoints in the requested page. { # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2036,6 +2106,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2227,6 +2299,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2843,7 +2917,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -2914,21 +2988,6 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -2976,6 +3035,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html index a19f08ffba7..4f891b3ba45 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html @@ -570,6 +570,15 @@

Method Details

}, "entityId": "A String", # Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id. "neighborCount": 42, # Optional. The number of similar entities to be retrieved from feature view for each query. + "numericFilters": [ # Optional. The list of numeric filters. + { # Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1 + "name": "A String", # Required. Column name in BigQuery that used as filters. + "op": "A String", # Optional. This MUST be specified for queries and must NOT be specified for database points. + "valueDouble": 3.14, # double value type. + "valueFloat": 3.14, # float value type. + "valueInt": "A String", # int value type. + }, + ], "parameters": { # Parameters that can be overrided in each query to tune query latency and recall. # Optional. Parameters that can be set to tune query on the fly. "approximateNeighborCandidates": 42, # Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count. "leafNodesSearchFraction": 3.14, # Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0. diff --git a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html index db0bc1330e6..b6d1cb1a1cc 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html @@ -276,6 +276,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -525,6 +526,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -816,6 +818,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1078,6 +1081,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html index 3b6a4c7c463..8c5da88f63b 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html @@ -231,6 +231,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -313,6 +314,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -481,6 +483,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -563,6 +566,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -773,6 +777,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -855,6 +860,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1036,6 +1042,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1118,6 +1125,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html index d753195ab0f..a0ec7bf8358 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.notebookExecutionJobs.html @@ -82,10 +82,273 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a NotebookExecutionJob.

+

+ delete(name, x__xgafv=None)

+

Deletes a NotebookExecutionJob.

+

+ get(name, view=None, x__xgafv=None)

+

Gets a NotebookExecutionJob.

+

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

+

Lists NotebookExecutionJobs in a Location.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, notebookExecutionJobId=None, x__xgafv=None) +
Creates a NotebookExecutionJob.
+
+Args:
+  parent: string, Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # NotebookExecutionJob represents an instance of a notebook execution.
+  "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
+  "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
+    "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
+    "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
+  },
+  "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
+    "content": "A String", # The base64-encoded contents of the input notebook file.
+  },
+  "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
+  "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
+  "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+    "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
+    "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+  },
+  "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
+  "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
+  "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
+  "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
+  "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+  "serviceAccount": "A String", # The service account to run the execution as.
+  "status": { # 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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
+    "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.
+  },
+  "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
+}
+
+  notebookExecutionJobId: string, Optional. User specified ID for the NotebookExecutionJob.
+  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, x__xgafv=None) +
Deletes a NotebookExecutionJob.
+
+Args:
+  name: string, Required. The name of the NotebookExecutionJob resource to be deleted. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, view=None, x__xgafv=None) +
Gets a NotebookExecutionJob.
+
+Args:
+  name: string, Required. The name of the NotebookExecutionJob resource. (required)
+  view: string, Optional. The NotebookExecutionJob view. Defaults to BASIC.
+    Allowed values
+      NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED - When unspecified, the API defaults to the BASIC view.
+      NOTEBOOK_EXECUTION_JOB_VIEW_BASIC - Includes all fields except for direct notebook inputs.
+      NOTEBOOK_EXECUTION_JOB_VIEW_FULL - Includes all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # NotebookExecutionJob represents an instance of a notebook execution.
+  "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
+  "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
+    "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
+    "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
+  },
+  "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
+    "content": "A String", # The base64-encoded contents of the input notebook file.
+  },
+  "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+  "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
+  "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
+  "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+    "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
+    "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+  },
+  "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
+  "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
+  "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
+  "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
+  "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+  "serviceAccount": "A String", # The service account to run the execution as.
+  "status": { # 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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
+    "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.
+  },
+  "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None) +
Lists NotebookExecutionJobs in a Location.
+
+Args:
+  parent: string, Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}` (required)
+  filter: string, Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob="123"` * `notebookExecutionJob="my-execution-job"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"`
+  orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.
+  pageSize: integer, Optional. The standard list page size.
+  pageToken: string, Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.
+  view: string, Optional. The NotebookExecutionJob view. Defaults to BASIC.
+    Allowed values
+      NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED - When unspecified, the API defaults to the BASIC view.
+      NOTEBOOK_EXECUTION_JOB_VIEW_BASIC - Includes all fields except for direct notebook inputs.
+      NOTEBOOK_EXECUTION_JOB_VIEW_FULL - Includes all fields.
+  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 [NotebookService.CreateNotebookExecutionJob]
+  "nextPageToken": "A String", # A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page.
+  "notebookExecutionJobs": [ # List of NotebookExecutionJobs in the requested page.
+    { # NotebookExecutionJob represents an instance of a notebook execution.
+      "createTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was created.
+      "dataformRepositorySource": { # The Dataform Repository containing the input notebook. # The Dataform Repository pointing to a single file notebook repository.
+        "commitSha": "A String", # The commit SHA to read repository with. If unset, the file will be read at HEAD.
+        "dataformRepositoryResourceName": "A String", # The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`
+      },
+      "directNotebookSource": { # The content of the input notebook in ipynb format. # The contents of an input notebook file.
+        "content": "A String", # The base64-encoded contents of the input notebook file.
+      },
+      "displayName": "A String", # The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
+      "executionTimeout": "A String", # Max running time of the execution job in seconds (default 86400s / 24 hrs).
+      "executionUser": "A String", # The user email to run the execution as. Only supported by Colab runtimes.
+      "gcsNotebookSource": { # The Cloud Storage uri for the input notebook. # The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+        "generation": "A String", # The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.
+        "uri": "A String", # The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`
+      },
+      "gcsOutputUri": "A String", # The Cloud Storage location to upload the result to. Format: `gs://bucket-name`
+      "jobState": "A String", # Output only. The state of the NotebookExecutionJob.
+      "labels": { # The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`
+      "notebookRuntimeTemplateResourceName": "A String", # The NotebookRuntimeTemplate to source compute configuration from.
+      "scheduleResourceName": "A String", # Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`
+      "serviceAccount": "A String", # The service account to run the execution as.
+      "status": { # 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. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.
+        "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.
+      },
+      "updateTime": "A String", # Output only. Timestamp when this NotebookExecutionJob was most recently updated.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html index 3159bb89dd7..e7e0fc42d12 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html +++ b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html @@ -138,6 +138,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -171,6 +174,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -287,6 +293,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -320,6 +329,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -377,6 +389,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -410,6 +425,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -473,6 +491,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -506,6 +527,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index 7ef17416903..c249a2af3a6 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -117,7 +117,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -151,10 +151,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -190,7 +190,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -224,10 +224,88 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "fileData": { # URI based data. # Optional. URI based data. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "response": { # Required. The function response in JSON object format. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. Text part (can be code). + "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + }, + "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "default": "", # Optional. Default value of the data. + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + }, + ], + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + }, + "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}` + }, + }, + }, + ], } x__xgafv: string, V1 error format. @@ -415,7 +493,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -486,21 +564,6 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -548,6 +611,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1007,7 +1071,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -1078,21 +1142,6 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1140,6 +1189,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index f3d99435a73..6fa9fc561a1 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, languageCode=None, view=None, x__xgafv=None)

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

Gets a Model Garden publisher model.

Method Details

@@ -87,12 +87,13 @@

Method Details

- get(name, languageCode=None, view=None, x__xgafv=None) + get(name, 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)
-  languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).
+  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.
     Allowed values
       PUBLISHER_MODEL_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
diff --git a/docs/dyn/aiplatform_v1beta1.media.html b/docs/dyn/aiplatform_v1beta1.media.html
index 789f4350106..6eeaeafdb35 100644
--- a/docs/dyn/aiplatform_v1beta1.media.html
+++ b/docs/dyn/aiplatform_v1beta1.media.html
@@ -115,9 +115,42 @@ 

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "name": "A String", # Output only. The resource name of the RagFile. "ragFileType": "A String", # Output only. The type of the RagFile. "sizeBytes": "A String", # Output only. The size of the RagFile in bytes. + "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel. + "channels": [ # Required. The Slack channels. + { # SlackChannels contains the Slack channels and corresponding access token. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated. }, "uploadRagFileConfig": { # Config for uploading RagFile. # Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile. @@ -167,9 +200,42 @@

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "name": "A String", # Output only. The resource name of the RagFile. "ragFileType": "A String", # Output only. The type of the RagFile. "sizeBytes": "A String", # Output only. The size of the RagFile in bytes. + "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel. + "channels": [ # Required. The Slack channels. + { # SlackChannels contains the Slack channels and corresponding access token. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated. }, }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index fc9ede35864..587346eeccb 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -257,7 +257,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -438,7 +438,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -644,7 +644,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -836,7 +836,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -1036,7 +1036,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -1218,7 +1218,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html index 2c923abb916..1bae8f70b91 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html @@ -175,6 +175,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -289,6 +290,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -445,6 +447,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -572,6 +575,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html index 254b37f6acf..a2257cdcb87 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html @@ -120,7 +120,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -210,7 +210,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }
@@ -243,7 +243,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }, ], @@ -270,7 +270,7 @@

Method Details

Updates a DatasetVersion.
 
 Args:
-  name: string, Output only. The resource name of the DatasetVersion. (required)
+  name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -281,7 +281,7 @@ 

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. } @@ -301,7 +301,7 @@

Method Details

"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. "metadata": "", # Required. Output only. Additional information about the DatasetVersion. "modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions. - "name": "A String", # Output only. The resource name of the DatasetVersion. + "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion. "updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated. }
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index 9f4aba83646..d4c893e3801 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -163,7 +163,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -328,7 +328,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -441,7 +441,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -482,7 +482,7 @@

Method Details

Updates a Dataset.
 
 Args:
-  name: string, Output only. The resource name of the Dataset. (required)
+  name: string, Output only. Identifier. The resource name of the Dataset. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -502,7 +502,7 @@ 

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. @@ -545,7 +545,7 @@

Method Details

"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`. "metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/. "modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets. - "name": "A String", # Output only. The resource name of the Dataset. + "name": "A String", # Output only. Identifier. The resource name of the Dataset. "savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec. { # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters. "annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index 8f82d31a3db..9264e906835 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -172,7 +172,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -206,10 +206,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -245,7 +245,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -279,10 +279,131 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "fileData": { # URI based data. # Optional. URI based data. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "response": { # Required. The function response in JSON object format. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. Text part (can be code). + "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + }, + "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "default": "", # Optional. Default value of the data. + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "default": "", # Optional. Default value of the data. + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + }, + ], + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + }, + "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}` + }, + "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. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + }, + ], } x__xgafv: string, V1 error format. @@ -310,6 +431,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -1443,7 +1566,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -1529,25 +1652,6 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1598,6 +1702,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1638,6 +1743,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -1881,6 +1988,8 @@

Method Details

"endpoints": [ # List of Endpoints in the requested page. { # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2288,6 +2397,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -2484,6 +2595,8 @@

Method Details

{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations. "createTime": "A String", # Output only. Timestamp when this Endpoint was created. + "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`. + "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon. "deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively. { # A deployment of a Model. Endpoints contain one or more DeployedModels. "automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. @@ -3192,7 +3305,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -3278,25 +3391,6 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -3347,6 +3441,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html index 6bdbea60ea3..f65bfb6047b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html @@ -683,6 +683,15 @@

Method Details

}, "entityId": "A String", # Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id. "neighborCount": 42, # Optional. The number of similar entities to be retrieved from feature view for each query. + "numericFilters": [ # Optional. The list of numeric filters. + { # Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1 + "name": "A String", # Required. Column name in BigQuery that used as filters. + "op": "A String", # Optional. This MUST be specified for queries and must NOT be specified for database points. + "valueDouble": 3.14, # double value type. + "valueFloat": 3.14, # float value type. + "valueInt": "A String", # int value type. + }, + ], "parameters": { # Parameters that can be overrided in each query to tune query latency and recall. # Optional. Parameters that can be set to tune query on the fly. "approximateNeighborCandidates": 42, # Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count. "leafNodesSearchFraction": 3.14, # Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html index 2d9ce0d3080..d1c0026b8bd 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html @@ -289,6 +289,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -551,6 +552,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -855,6 +857,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1130,6 +1133,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html index c8be57a2d1b..464be714079 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html @@ -296,6 +296,8 @@

Method Details

"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective. "featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec. "batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default. @@ -634,6 +636,8 @@

Method Details

"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective. "featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec. "batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default. @@ -913,6 +917,8 @@

Method Details

"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective. "featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec. "batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default. @@ -1198,6 +1204,8 @@

Method Details

"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist. }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective. "featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec. "batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html index f39f32c153c..45ec1d19b02 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html @@ -231,6 +231,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -313,6 +314,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -481,6 +483,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -563,6 +566,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -773,6 +777,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -855,6 +860,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1036,6 +1042,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. @@ -1118,6 +1125,7 @@

Method Details

"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob. "disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false. "restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. + "strategy": "A String", # Optional. This determines which type of scheduling strategy to use. "timeout": "A String", # The maximum job running time. The default is 7 days. }, "serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html index 395f3abe671..576dbd4d5e0 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html @@ -138,6 +138,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -172,6 +175,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -288,6 +294,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -322,6 +331,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -379,6 +391,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -413,6 +428,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, @@ -476,6 +494,9 @@

Method Details

}, "name": "A String", # Immutable. Resource name of a PersistentResource. "network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. + "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource. + "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I. + }, "reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. "A String", ], @@ -510,6 +531,9 @@

Method Details

"raySpec": { # Configuration information for the Ray cluster. For experimental launch, Ray cluster creation and Persistent cluster creation are 1:1 mapping: We will provision all the nodes within the Persistent cluster as Ray nodes. # Optional. Ray cluster configuration. Required when creating a dedicated RayCluster on the PersistentResource. "headNodeResourcePoolId": "A String", # Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. "imageUri": "A String", # Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field. + "rayLogsSpec": { # Configuration for the Ray OSS Logs. # Optional. OSS Ray logging configurations. + "disabled": True or False, # Optional. Flag to disable the export of Ray OSS logs to Cloud Logging. + }, "rayMetricSpec": { # Configuration for the Ray metrics. # Optional. Ray metrics configurations. "disabled": True or False, # Optional. Flag to disable the Ray metrics collection. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html index 44dc124addf..c16eeb2c6c1 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html @@ -438,6 +438,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -663,6 +665,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -929,6 +933,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -1168,6 +1174,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index cb2c9f05c0d..0d4ece94d7a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -120,7 +120,7 @@

Method Details

The object takes the form of: { # Request message for ComputeTokens RPC call. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -154,10 +154,10 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. + "instances": [ # Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/* } x__xgafv: string, V1 error format. @@ -193,7 +193,7 @@

Method Details

The object takes the form of: { # Request message for PredictionService.CountTokens. - "contents": [ # Required. Input content. + "contents": [ # Optional. Input content. { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. @@ -227,10 +227,131 @@

Method Details

"role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. }, ], - "instances": [ # Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. + "instances": [ # Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model. "", ], - "model": "A String", # Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "model": "A String", # Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*` + "systemInstruction": { # The base structured datatype containing multi-part content of a message. A `Content` includes a `role` field designating the producer of the `Content` and a `parts` field containing multi-part data that contains the content of the message turn. # Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph. + "parts": [ # Required. Ordered `Parts` that constitute a single message. Parts may have different IANA MIME types. + { # A datatype containing media that is part of a multi-part `Content` message. A `Part` consists of data which has an associated datatype. A `Part` can only contain one of the accepted types in `Part.data`. A `Part` must have a fixed IANA MIME type identifying the type and subtype of the media if `inline_data` or `file_data` field is filled with raw bytes. + "fileData": { # URI based data. # Optional. URI based data. + "fileUri": "A String", # Required. URI. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "functionCall": { # A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing the parameters and their values. # Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values. + "args": { # Optional. Required. The function parameters and values in JSON object format. See [FunctionDeclaration.parameters] for parameter details. + "a_key": "", # Properties of the object. + }, + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name]. + }, + "functionResponse": { # The result output from a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a [FunctionCall] made based on model prediction. # Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model. + "name": "A String", # Required. The name of the function to call. Matches [FunctionDeclaration.name] and [FunctionCall.name]. + "response": { # Required. The function response in JSON object format. + "a_key": "", # Properties of the object. + }, + }, + "inlineData": { # Content blob. It's preferred to send as text directly rather than raw bytes. # Optional. Inlined bytes data. + "data": "A String", # Required. Raw bytes. + "mimeType": "A String", # Required. The IANA standard MIME type of the source data. + }, + "text": "A String", # Optional. Text part (can be code). + "videoMetadata": { # Metadata describes the input video content. # Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data. + "endOffset": "A String", # Optional. The end offset of the video. + "startOffset": "A String", # Optional. The start offset of the video. + }, + }, + ], + "role": "A String", # Optional. The producer of the content. Must be either 'user' or 'model'. Useful to set for multi-turn conversations, otherwise can be left blank or unset. + }, + "tools": [ # Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. + { # Tool details that the model may use to generate response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval). + "functionDeclarations": [ # Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided. + { # Structured representation of a function declaration as defined by the [OpenAPI 3.0 specification](https://spec.openapis.org/oas/v3.0.3). Included in this declaration are the function name and parameters. This FunctionDeclaration is a representation of a block of code that can be used as a `Tool` by the model and executed by the client. + "description": "A String", # Optional. Description and purpose of the function. Model uses it to decide how and whether to call the function. + "name": "A String", # Required. The name of the function to call. Must start with a letter or an underscore. Must be a-z, A-Z, 0-9, or contain underscores, dots and dashes, with a maximum length of 64. + "parameters": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the parameters to this function in JSON Schema Object format. Reflects the Open API 3.03 Parameter Object. string Key: the name of the parameter. Parameter names are case sensitive. Schema Value: the Schema defining the type used for the parameter. For function with no parameters, this can be left unset. Parameter names must start with a letter or an underscore and must only contain chars a-z, A-Z, 0-9, or underscores with a maximum length of 64. Example with 1 required and 1 optional parameter: type: OBJECT properties: param1: type: STRING param2: type: INTEGER required: - param1 + "default": "", # Optional. Default value of the data. + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + "response": { # Schema is used to define the format of input/output data. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). More fields may be added in the future as needed. # Optional. Describes the output from this function in JSON Schema format. Reflects the Open API 3.03 Response Object. The Schema defines the type used for the response value of the function. + "default": "", # Optional. Default value of the data. + "description": "A String", # Optional. The description of the data. + "enum": [ # Optional. Possible values of the element of Type.STRING with enum format. For example we can define an Enum Direction as : {type:STRING, format:enum, enum:["EAST", NORTH", "SOUTH", "WEST"]} + "A String", + ], + "example": "", # Optional. Example of the object. Will only populated when the object is the root. + "format": "A String", # Optional. The format of the data. Supported formats: for NUMBER type: "float", "double" for INTEGER type: "int32", "int64" for STRING type: "email", "byte", etc + "items": # Object with schema name: GoogleCloudAiplatformV1beta1Schema # Optional. SCHEMA FIELDS FOR TYPE ARRAY Schema of the elements of Type.ARRAY. + "maxItems": "A String", # Optional. Maximum number of the elements for Type.ARRAY. + "maxLength": "A String", # Optional. Maximum length of the Type.STRING + "maxProperties": "A String", # Optional. Maximum number of the properties for Type.OBJECT. + "maximum": 3.14, # Optional. Maximum value of the Type.INTEGER and Type.NUMBER + "minItems": "A String", # Optional. Minimum number of the elements for Type.ARRAY. + "minLength": "A String", # Optional. SCHEMA FIELDS FOR TYPE STRING Minimum length of the Type.STRING + "minProperties": "A String", # Optional. Minimum number of the properties for Type.OBJECT. + "minimum": 3.14, # Optional. SCHEMA FIELDS FOR TYPE INTEGER and NUMBER Minimum value of the Type.INTEGER and Type.NUMBER + "nullable": True or False, # Optional. Indicates if the value may be null. + "pattern": "A String", # Optional. Pattern of the Type.STRING to restrict a string to a regular expression. + "properties": { # Optional. SCHEMA FIELDS FOR TYPE OBJECT Properties of Type.OBJECT. + "a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema + }, + "required": [ # Optional. Required properties of Type.OBJECT. + "A String", + ], + "title": "A String", # Optional. The title of the Schema. + "type": "A String", # Optional. The type of the data. + }, + }, + ], + "googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. + }, + "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}` + }, + "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. + "A String", + ], + "ragResources": [ # Optional. The representation of the rag source. It can be used to specify corpus only or ragfiles. Currently only support one corpus or multiple files from one corpus. In the future we may open up multiple corpora support. + { # The definition of the Rag resource. + "ragCorpus": "A String", # Optional. RagCorpora resource name. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` + "ragFileIds": [ # Optional. rag_file_id. The files should be in the same rag_corpus set in rag_corpus field. + "A String", + ], + }, + ], + "similarityTopK": 42, # Optional. Number of top k results to return from the selected corpora. + "vectorDistanceThreshold": 3.14, # Optional. Only return results with vector distance smaller than the threshold. + }, + }, + }, + ], } x__xgafv: string, V1 error format. @@ -447,7 +568,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -533,25 +654,6 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -602,6 +704,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -1125,7 +1228,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -1211,25 +1314,6 @@

Method Details

"finishMessage": "A String", # Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when `finish_reason` is set. "finishReason": "A String", # Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens. "groundingMetadata": { # Metadata returned to client when grounding is enabled. # Output only. Metadata specifies sources used to ground generated content. - "groundingAttributions": [ # Optional. List of grounding attributions. - { # Grounding attribution. - "confidenceScore": 3.14, # Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident. - "retrievedContext": { # Attribution from context retrieved by the retrieval tools. # Optional. Attribution from context retrieved by the retrieval tools. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - "segment": { # Segment of the content. # Output only. Segment of the content this attribution belongs to. - "endIndex": 42, # Output only. End index in the given Part, measured in bytes. Offset from the start of the Part, exclusive, starting at zero. - "partIndex": 42, # Output only. The index of a Part object within its parent Content object. - "startIndex": 42, # Output only. Start index in the given Part, measured in bytes. Offset from the start of the Part, inclusive, starting at zero. - "text": "A String", # Output only. The text corresponding to the segment from the response. - }, - "web": { # Attribution from the web. # Optional. Attribution from the web. - "title": "A String", # Output only. Title of the attribution. - "uri": "A String", # Output only. URI reference of the attribution. - }, - }, - ], "groundingChunks": [ # List of supporting references retrieved from specified grounding source. { # Grounding chunk. "retrievedContext": { # Chunk from context retrieved by the retrieval tools. # Grounding chunk from context retrieved by the retrieval tools. @@ -1280,6 +1364,7 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], + "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html index 62ebe65c71b..fe542508d91 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html @@ -171,9 +171,42 @@

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "name": "A String", # Output only. The resource name of the RagFile. "ragFileType": "A String", # Output only. The type of the RagFile. "sizeBytes": "A String", # Output only. The size of the RagFile in bytes. + "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel. + "channels": [ # Required. The Slack channels. + { # SlackChannels contains the Slack channels and corresponding access token. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated. }
@@ -202,11 +235,44 @@

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # Jira queries with their corresponding authentication. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "maxEmbeddingRequestsPerMin": 42, # Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used. "ragFileChunkingConfig": { # Specifies the size and overlap of chunks for RagFiles. # Specifies the size and overlap of chunks after importing RagFiles. "chunkOverlap": 42, # The overlap between chunks. "chunkSize": 42, # The size of the chunks. }, + "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. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, }, } @@ -277,9 +343,42 @@

Method Details

}, ], }, + "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query. + "jiraQueries": [ # Required. The Jira queries. + { # JiraQueries contains the Jira queries and corresponding authentication. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/). + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/ + "A String", + ], + "email": "A String", # Required. The Jira email address. + "projects": [ # A list of Jira projects to import in their entirety. + "A String", + ], + "serverUri": "A String", # Required. The Jira server URI. + }, + ], + }, "name": "A String", # Output only. The resource name of the RagFile. "ragFileType": "A String", # Output only. The type of the RagFile. "sizeBytes": "A String", # Output only. The size of the RagFile in bytes. + "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel. + "channels": [ # Required. The Slack channels. + { # SlackChannels contains the Slack channels and corresponding access token. + "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token. + "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version} + }, + "channels": [ # Required. The Slack channel IDs. + { # SlackChannel contains the Slack channel ID and the time range to import. + "channelId": "A String", # Required. The Slack channel ID. + "endTime": "A String", # Optional. The ending timestamp for messages to import. + "startTime": "A String", # Optional. The starting timestamp for messages to import. + }, + ], + }, + ], + }, "updateTime": "A String", # Output only. Timestamp when this RagFile was last updated. }, ], diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html index 3b47bbc3a91..1b7bdb0ff45 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html @@ -680,6 +680,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -1279,6 +1281,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -1920,6 +1924,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -2533,6 +2539,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -3150,6 +3158,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. @@ -3750,6 +3760,8 @@

Method Details

}, }, }, + "satisfiesPzi": True or False, # Output only. Reserved for future use. + "satisfiesPzs": True or False, # Output only. Reserved for future use. "scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API. "serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account. "startTime": "A String", # Output only. Pipeline start time. diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index f4b7e8076e0..06a848f6991 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, languageCode=None, view=None, x__xgafv=None)

+ get(name, 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,12 +93,13 @@

Method Details

- get(name, languageCode=None, view=None, x__xgafv=None) + get(name, 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)
-  languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).
+  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.
     Allowed values
       PUBLISHER_MODEL_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
@@ -394,7 +395,7 @@ 

Method Details

Args: parent: string, Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}` (required) filter: string, Optional. The standard list filter. - languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en). + languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en). orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. pageSize: integer, Optional. The standard list page size. pageToken: string, Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call. diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html index e8b0bc7d2b8..15cb1feda2f 100644 --- a/docs/dyn/analyticsadmin_v1alpha.accounts.html +++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html @@ -166,7 +166,7 @@

Method Details

Get data sharing settings on an account. Data sharing settings are singletons.
 
 Args:
-  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)
+  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -502,7 +502,7 @@ 

Method Details

Searches through all changes to an account or its children given the specified set of filters.
 
 Args:
-  account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: "accounts/100" (required)
+  account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -517,7 +517,7 @@ 

Method Details

"latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive). "pageSize": 42, # Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum). "pageToken": "A String", # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token. - "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: "properties/100" + "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100` "resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types. "A String", ], diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html b/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html index 94c5e06a8c9..2fe1b64766b 100644 --- a/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html +++ b/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a conversion event with the specified attributes.

+

Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.

delete(name, x__xgafv=None)

-

Deletes a conversion event in a property.

+

Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.

get(name, x__xgafv=None)

-

Retrieve a single conversion event.

+

Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.

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

-

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

+

Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

list_next()

Retrieves the next page of results.

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

-

Updates a conversion event with the specified attributes.

+

Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.

Method Details

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

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a conversion event with the specified attributes.
+  
Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.
 
 Args:
   parent: string, Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 (required)
@@ -147,7 +147,7 @@ 

Method Details

delete(name, x__xgafv=None) -
Deletes a conversion event in a property.
+  
Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.
 
 Args:
   name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -165,7 +165,7 @@ 

Method Details

get(name, x__xgafv=None) -
Retrieve a single conversion event.
+  
Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
 
 Args:
   name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -193,7 +193,7 @@ 

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+  
Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
 
 Args:
   parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
@@ -242,7 +242,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a conversion event with the specified attributes.
+  
Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
 
 Args:
   name: string, Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html
index 23e2ba6562b..397abbaef32 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html
@@ -79,11 +79,6 @@ 

Instance Methods

Returns the eventCreateRules Resource.

-

- eventEditRules() -

-

Returns the eventEditRules Resource.

-

measurementProtocolSecrets()

@@ -308,7 +303,7 @@

Method Details

Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
 
 Args:
-  name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag" (required)
+  name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html
index ceb2fd7c37c..5df2bec7b91 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html
@@ -100,7 +100,7 @@ 

Method Details

Creates a FirebaseLink. Properties can have at most one FirebaseLink.
 
 Args:
-  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -130,7 +130,7 @@ 

Method Details

Deletes a FirebaseLink on a property
 
 Args:
-  name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required)
+  name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -148,7 +148,7 @@ 

Method Details

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
 
 Args:
-  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
   pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
   pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/analyticsadmin_v1beta.accounts.html b/docs/dyn/analyticsadmin_v1beta.accounts.html
index fe5ed33c84b..fce75e43add 100644
--- a/docs/dyn/analyticsadmin_v1beta.accounts.html
+++ b/docs/dyn/analyticsadmin_v1beta.accounts.html
@@ -161,7 +161,7 @@ 

Method Details

Get data sharing settings on an account. Data sharing settings are singletons.
 
 Args:
-  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)
+  name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -497,7 +497,7 @@ 

Method Details

Searches through all changes to an account or its children given the specified set of filters.
 
 Args:
-  account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: "accounts/100" (required)
+  account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -512,7 +512,7 @@ 

Method Details

"latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive). "pageSize": 42, # Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum). "pageToken": "A String", # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token. - "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: "properties/100" + "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100` "resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types. "A String", ], diff --git a/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html index cf252513141..042317e3ef5 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html @@ -79,22 +79,22 @@

Instance Methods

Close httplib2 connections.

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

-

Creates a conversion event with the specified attributes.

+

Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.

delete(name, x__xgafv=None)

-

Deletes a conversion event in a property.

+

Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.

get(name, x__xgafv=None)

-

Retrieve a single conversion event.

+

Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.

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

-

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

+

Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.

list_next()

Retrieves the next page of results.

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

-

Updates a conversion event with the specified attributes.

+

Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.

Method Details

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

Method Details

create(parent, body=None, x__xgafv=None) -
Creates a conversion event with the specified attributes.
+  
Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.
 
 Args:
   parent: string, Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 (required)
@@ -147,7 +147,7 @@ 

Method Details

delete(name, x__xgafv=None) -
Deletes a conversion event in a property.
+  
Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.
 
 Args:
   name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -165,7 +165,7 @@ 

Method Details

get(name, x__xgafv=None) -
Retrieve a single conversion event.
+  
Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
 
 Args:
   name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -193,7 +193,7 @@ 

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+  
Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
 
 Args:
   parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
@@ -242,7 +242,7 @@ 

Method Details

patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a conversion event with the specified attributes.
+  
Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
 
 Args:
   name: string, Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html
index b3a1636bb64..ffa13534241 100644
--- a/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html
+++ b/docs/dyn/analyticsadmin_v1beta.properties.dataStreams.html
@@ -74,11 +74,6 @@
 
 

Google Analytics Admin API . properties . dataStreams

Instance Methods

-

- eventEditRules() -

-

Returns the eventEditRules Resource.

-

measurementProtocolSecrets()

diff --git a/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html index 939d87d0477..77cae83ee4a 100644 --- a/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html +++ b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html @@ -100,7 +100,7 @@

Method Details

Creates a FirebaseLink. Properties can have at most one FirebaseLink.
 
 Args:
-  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -130,7 +130,7 @@ 

Method Details

Deletes a FirebaseLink on a property
 
 Args:
-  name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required)
+  name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -148,7 +148,7 @@ 

Method Details

Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
 
 Args:
-  parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+  parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
   pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
   pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html
index 11d52e788a4..9fb2dd67e3e 100644
--- a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html
+++ b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html
@@ -79,7 +79,7 @@ 

Instance Methods

Close httplib2 connections.

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

-

Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.

+

Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore.

delete(name, x__xgafv=None)

Deletes an enrollment token. This operation invalidates the token, preventing its future use.

@@ -100,7 +100,7 @@

Method Details

create(parent, body=None, x__xgafv=None) -
Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.
+  
Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore.
 
 Args:
   parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.html b/docs/dyn/apim_v1alpha.projects.locations.html
index 804b5f88be2..7c0dbb7de19 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.html
@@ -98,6 +98,12 @@ 

Instance Methods

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

Lists information about the supported locations for this service.

+

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

+

ListApiObservationTags lists all extant tags on any observation in the given project.

+

+ listApiObservationTags_next()

+

Retrieves the next page of results.

list_next()

Retrieves the next page of results.

@@ -169,6 +175,44 @@

Method Details

}
+
+ listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None) +
ListApiObservationTags lists all extant tags on any observation in the given project.
+
+Args:
+  parent: string, Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location} (required)
+  pageSize: integer, Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+  pageToken: string, Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message for response to listing tags
+  "apiObservationTags": [ # The tags from the specified project
+    "A String",
+  ],
+  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listApiObservationTags_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.
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html
index 358500ee4a6..e4eec036770 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html
@@ -82,7 +82,7 @@ 

Instance Methods

GetApiOperation retrieves a single ApiOperation by name.

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

-

ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation

+

ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.

list_next()

Retrieves the next page of results.

@@ -154,7 +154,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation
+  
ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.
 
 Args:
   parent: string, Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html
index 95b3e84f734..3712e36d21a 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html
@@ -79,6 +79,9 @@ 

Instance Methods

Returns the apiOperations Resource.

+

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

+

BatchEditTagsApiObservations adds or removes Tags for ApiObservations.

close()

Close httplib2 connections.

@@ -87,11 +90,66 @@

Instance Methods

GetApiObservation retrieves a single ApiObservation by name.

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

-

ListApiObservations gets all ApiObservations for a given project and location and ObservationJob

+

ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.

list_next()

Retrieves the next page of results.

Method Details

+
+ batchEditTags(parent, body=None, x__xgafv=None) +
BatchEditTagsApiObservations adds or removes Tags for ApiObservations.
+
+Args:
+  parent: string, Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Message for requesting batch edit tags for ApiObservations
+  "requests": [ # Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.
+    { # Message for requesting edit tags for ApiObservation
+      "apiObservationId": "A String", # Required. Identifier of ApiObservation need to be edit tags Format example: "apigee.googleapis.com|us-west1|443"
+      "tagActions": [ # Required. Tag actions to be applied
+        { # Message for edit tag action
+          "action": "A String", # Required. Action to be applied
+          "tag": "A String", # Required. Tag to be added or removed
+        },
+      ],
+    },
+  ],
+}
+
+  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 edit Tags for ApiObservations
+  "apiObservations": [ # ApiObservations that were changed
+    { # Message describing ApiObservation object
+      "apiOperationCount": "A String", # The number of observed API Operations.
+      "createTime": "A String", # Create time stamp
+      "hostname": "A String", # The hostname of requests processed for this Observation.
+      "lastEventDetectedTime": "A String", # Last event detected time stamp
+      "name": "A String", # Identifier. Name of resource
+      "serverIps": [ # The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `"192.168.1.1"`, `"10.0.0.1:80"`, `"FE80::0202:B3FF:FE1E:8329"`.
+        "A String",
+      ],
+      "sourceLocations": [ # Location of the Observation Source, for example "us-central1" or "europe-west1."
+        "A String",
+      ],
+      "style": "A String", # Style of ApiObservation
+      "tags": [ # User-defined tags to organize and sort
+        "A String",
+      ],
+      "updateTime": "A String", # Update time stamp
+    },
+  ],
+}
+
+
close()
Close httplib2 connections.
@@ -133,7 +191,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
ListApiObservations gets all ApiObservations for a given project and location and ObservationJob
+  
ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.
 
 Args:
   parent: string, Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
index 13878a4ac0e..b8008fb41a7 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
@@ -99,7 +99,7 @@ 

Instance Methods

GetObservationJob retrieves a single ObservationJob by name.

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

-

ListObservationJobs gets all ObservationJobs for a given project and location

+

ListObservationJobs gets all ObservationJobs for a given project and location.

list_next()

Retrieves the next page of results.

@@ -303,7 +303,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
ListObservationJobs gets all ObservationJobs for a given project and location
+  
ListObservationJobs gets all ObservationJobs for a given project and location.
 
 Args:
   parent: string, Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location} (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationSources.html b/docs/dyn/apim_v1alpha.projects.locations.observationSources.html
index 2bc60f346a2..da4f26b7893 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationSources.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationSources.html
@@ -88,7 +88,7 @@ 

Instance Methods

GetObservationSource retrieves a single ObservationSource by name.

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

-

ListObservationSources gets all ObservationSources for a given project and location

+

ListObservationSources gets all ObservationSources for a given project and location.

list_next()

Retrieves the next page of results.

@@ -220,7 +220,7 @@

Method Details

list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
ListObservationSources gets all ObservationSources for a given project and location
+  
ListObservationSources gets all ObservationSources for a given project and location.
 
 Args:
   parent: string, Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location} (required)
diff --git a/docs/dyn/artifactregistry_v1.projects.html b/docs/dyn/artifactregistry_v1.projects.html
index 2640ccae90e..492035a1368 100644
--- a/docs/dyn/artifactregistry_v1.projects.html
+++ b/docs/dyn/artifactregistry_v1.projects.html
@@ -111,6 +111,7 @@ 

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. }
@@ -126,6 +127,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. } updateMask: string, Field mask to support partial updates. @@ -140,6 +142,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. }
diff --git a/docs/dyn/artifactregistry_v1beta2.projects.html b/docs/dyn/artifactregistry_v1beta2.projects.html index dca13789dfb..e077a698a58 100644 --- a/docs/dyn/artifactregistry_v1beta2.projects.html +++ b/docs/dyn/artifactregistry_v1beta2.projects.html @@ -111,6 +111,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. }
@@ -126,6 +127,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. } updateMask: string, Field mask to support partial updates. @@ -140,6 +142,7 @@

Method Details

{ # The Artifact Registry settings that apply to a Project. "legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project. "name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set + "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection. }
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html new file mode 100644 index 00000000000..ce09eeb54af --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html @@ -0,0 +1,153 @@ + + + +

Authorized Buyers Marketplace API . bidders . auctionPackages

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
+
+Args:
+  parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`. (required)
+  filter: string, Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
+  orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
+  pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
+  pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken
+  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 listing auction packages.
+  "auctionPackages": [ # The list of auction packages.
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+      "createTime": "A String", # Output only. Time the auction package was created.
+      "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+      "description": "A String", # Output only. A description of the auction package.
+      "displayName": "A String", # The display_name assigned to the auction package.
+      "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+        "A String",
+      ],
+      "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+      "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+        "A String",
+      ],
+      "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+        "A String",
+      ],
+      "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+        { # Describes a single Media Planner account.
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+      ],
+      "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html new file mode 100644 index 00000000000..4cb42775a21 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html @@ -0,0 +1,370 @@ + + + +

Authorized Buyers Marketplace API . bidders . finalizedDeals

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+Args:
+  parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required)
+  filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
+  orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+  pageToken: string, The page token as returned from ListFinalizedDealsResponse.
+  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 listing finalized deals.
+  "finalizedDeals": [ # The list of finalized deals.
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+      "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+        "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+        "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+        "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+        "createTime": "A String", # Output only. The time of the deal creation.
+        "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+          "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+          "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+          "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+          "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+          "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+          "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+        },
+        "dealType": "A String", # Output only. Type of deal.
+        "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+          "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+          "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+          "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+          "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+            { # Message contains details about publisher-set frequency caps of the delivery.
+              "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+              "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+              "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+            },
+          ],
+          "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+        },
+        "description": "A String", # Output only. Free text description for the deal terms.
+        "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+        "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+          "A String",
+        ],
+        "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+          "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.
+        },
+        "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+        "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+        "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+        "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+        "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+        },
+        "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+          "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+        },
+        "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+          "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+          "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+          "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+          "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+        },
+        "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+        "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+        "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+          "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+          "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+        },
+        "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+          "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+            "dayParts": [ # The targeted weekdays and times
+              { # Defines targeting for a period of time on a specific week day.
+                "dayOfWeek": "A String", # Day of week for the period.
+                "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+                "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+              },
+            ],
+            "timeZoneType": "A String", # The time zone type of the day parts
+          },
+          "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+            "A String",
+          ],
+          "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+            "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+            "targetedInventorySizes": [ # A list of inventory sizes to be included.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+          },
+          "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+            "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+              "A String",
+            ],
+          },
+          "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+            "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+              "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+                "excludedAppIds": [ # A list of application IDs to be excluded.
+                  "A String",
+                ],
+                "targetedAppIds": [ # A list of application IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+            "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+              "excludedUris": [ # A list of URLs to be excluded.
+                "A String",
+              ],
+              "targetedUris": [ # A list of URLs to be included.
+                "A String",
+              ],
+            },
+          },
+          "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+            "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+              "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+              "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+            "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+              "A String",
+            ],
+            "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+              "A String",
+            ],
+          },
+        },
+        "updateTime": "A String", # Output only. The time when the deal was last updated.
+      },
+      "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+        "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+        "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+        "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+      },
+      "dealServingStatus": "A String", # Serving status of the deal.
+      "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+      "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+      "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+        "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+        "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+        "bidRequests7Days": "A String", # Bid requests in last 7 days.
+        "bids7Days": "A String", # Bids in last 7 days.
+        "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+        "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.html new file mode 100644 index 00000000000..48973331492 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.html @@ -0,0 +1,96 @@ + + + +

Authorized Buyers Marketplace API . bidders

+

Instance Methods

+

+ auctionPackages() +

+

Returns the auctionPackages Resource.

+ +

+ finalizedDeals() +

+

Returns the finalizedDeals Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html new file mode 100644 index 00000000000..6e169cf72c4 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html @@ -0,0 +1,388 @@ + + + +

Authorized Buyers Marketplace API . buyers . auctionPackages

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets an auction package given its name.

+

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

+

List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.

+

+ subscribeClients(auctionPackage, body=None, x__xgafv=None)

+

Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.

+

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

+

Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.

+

+ unsubscribeClients(auctionPackage, body=None, x__xgafv=None)

+

Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets an auction package given its name.
+
+Args:
+  name: string, Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
+
+Args:
+  parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`. (required)
+  filter: string, Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
+  orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
+  pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
+  pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken
+  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 listing auction packages.
+  "auctionPackages": [ # The list of auction packages.
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+      "createTime": "A String", # Output only. Time the auction package was created.
+      "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+      "description": "A String", # Output only. A description of the auction package.
+      "displayName": "A String", # The display_name assigned to the auction package.
+      "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+        "A String",
+      ],
+      "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+      "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+        "A String",
+      ],
+      "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+        "A String",
+      ],
+      "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+        { # Describes a single Media Planner account.
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+      ],
+      "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ subscribe(name, body=None, x__xgafv=None) +
Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.
+
+Args:
+  name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SubscribeAuctionPackage.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ +
+ subscribeClients(auctionPackage, body=None, x__xgafv=None) +
Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.
+
+Args:
+  auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SubscribeAuctionPackageClients.
+  "clients": [ # Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ +
+ unsubscribe(name, body=None, x__xgafv=None) +
Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.
+
+Args:
+  name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UnsubscribeAuctionPackage.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ +
+ unsubscribeClients(auctionPackage, body=None, x__xgafv=None) +
Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
+
+Args:
+  auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for UnsubscribeAuctionPackage.
+  "clients": [ # Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+  "createTime": "A String", # Output only. Time the auction package was created.
+  "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+  "description": "A String", # Output only. A description of the auction package.
+  "displayName": "A String", # The display_name assigned to the auction package.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+  "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+    "A String",
+  ],
+  "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+    "A String",
+  ],
+  "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+    { # Describes a single Media Planner account.
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+  ],
+  "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html new file mode 100644 index 00000000000..76696aa4535 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html @@ -0,0 +1,315 @@ + + + +

Authorized Buyers Marketplace API . buyers . clients

+

Instance Methods

+

+ users() +

+

Returns the users Resource.

+ +

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

+

Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new client.

+

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

+

Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.

+

+ get(name, x__xgafv=None)

+

Gets a client with a given resource name.

+

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

+

Lists all the clients for the current buyer.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates an existing client.

+

Method Details

+
+ activate(name, body=None, x__xgafv=None) +
Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for activating a client.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new client.
+
+Args:
+  parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ +
+ deactivate(name, body=None, x__xgafv=None) +
Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for disabling a client.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a client with a given resource name.
+
+Args:
+  name: string, Required. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the clients for the current buyer.
+
+Args:
+  parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
+  filter: string, Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be `partnerClientId = "1234"`, in order to get only the client whose partnerClientId is "1234" in the response.
+  pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the list method.
+  "clients": [ # The returned list of clients.
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+      "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+      "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+      "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+      "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+      "sellerVisible": True or False, # Whether the client will be visible to sellers.
+      "state": "A String", # Output only. The state of the client.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates an existing client.
+
+Args:
+  name: string, Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+  updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+  "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+  "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+  "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+  "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+  "sellerVisible": True or False, # Whether the client will be visible to sellers.
+  "state": "A String", # Output only. The state of the client.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html new file mode 100644 index 00000000000..6d95bba3457 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html @@ -0,0 +1,272 @@ + + + +

Authorized Buyers Marketplace API . buyers . clients . users

+

Instance Methods

+

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

+

Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.

+

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

+

Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.

+

+ delete(name, x__xgafv=None)

+

Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.

+

+ get(name, x__xgafv=None)

+

Retrieves an existing client user.

+

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

+

Lists all client users for a specified client.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ activate(name, body=None, x__xgafv=None) +
Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for activating a client user.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.
+
+Args:
+  parent: string, Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+ +
+ deactivate(name, body=None, x__xgafv=None) +
Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for deactivating a client user.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Retrieves an existing client user.
+
+Args:
+  name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+  "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+  "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+  "state": "A String", # Output only. The state of the client user.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all client users for a specified client.
+
+Args:
+  parent: string, Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+  pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
+  pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for the list method.
+  "clientUsers": [ # The returned list of client users.
+    { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+      "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+      "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+      "state": "A String", # Output only. The state of the client user.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html new file mode 100644 index 00000000000..20c834f345c --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html @@ -0,0 +1,333 @@ + + + +

Authorized Buyers Marketplace API . buyers . dataSegments

+

Instance Methods

+

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

+

Activates a data segment.

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.

+

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

+

Deactivates a data segment.

+

+ get(name, x__xgafv=None)

+

Gets a data segment given its name.

+

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

+

List the data segments owned by a curator.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a data segment.

+

Method Details

+
+ activate(name, body=None, x__xgafv=None) +
Activates a data segment.
+
+Args:
+  name: string, Required. Name of data segment to activate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for activating a data segment
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.
+
+Args:
+  parent: string, Required. The parent resource where this data segment will be created. Format: `buyers/{accountId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ +
+ deactivate(name, body=None, x__xgafv=None) +
Deactivates a data segment.
+
+Args:
+  name: string, Required. Name of data segment to deactivate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for deactivating a data segment
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a data segment given its name.
+
+Args:
+  name: string, Required. Name of data segment to get. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
List the data segments owned by a curator.
+
+Args:
+  parent: string, Required. Name of the parent buyer that can access the data segment. Format: `buyers/{accountId}` (required)
+  pageSize: integer, Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.
+  pageToken: string, Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken
+  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 listing data segments.
+  "dataSegments": [ # The list of data segments.
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+      "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+        "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.
+      },
+      "createTime": "A String", # Output only. Time the data segment was created.
+      "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+      "state": "A String", # Output only. The state of the data segment.
+      "updateTime": "A String", # Output only. Time the data segment was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a data segment.
+
+Args:
+  name: string, Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+  updateMask: string, Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+  "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+    "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.
+  },
+  "createTime": "A String", # Output only. Time the data segment was created.
+  "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+  "state": "A String", # Output only. The state of the data segment.
+  "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html new file mode 100644 index 00000000000..e491e3c0a1e --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html @@ -0,0 +1,1686 @@ + + + +

Authorized Buyers Marketplace API . buyers . finalizedDeals

+

Instance Methods

+

+ addCreative(deal, body=None, x__xgafv=None)

+

Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a finalized deal given its name.

+

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

+

Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.

+

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

+

Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.

+

+ setReadyToServe(deal, body=None, x__xgafv=None)

+

Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.

+

Method Details

+
+ addCreative(deal, body=None, x__xgafv=None) +
Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.
+
+Args:
+  deal: string, Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for adding creative to be used in the bidding process for the finalized deal.
+  "creative": "A String", # Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a finalized deal given its name.
+
+Args:
+  name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+Args:
+  parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required)
+  filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
+  orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+  pageToken: string, The page token as returned from ListFinalizedDealsResponse.
+  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 listing finalized deals.
+  "finalizedDeals": [ # The list of finalized deals.
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+      "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+        "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+        "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+        "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+        "createTime": "A String", # Output only. The time of the deal creation.
+        "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+          "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+          "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+          "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+          "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+          "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+          "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+        },
+        "dealType": "A String", # Output only. Type of deal.
+        "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+          "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+          "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+          "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+          "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+            { # Message contains details about publisher-set frequency caps of the delivery.
+              "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+              "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+              "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+            },
+          ],
+          "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+        },
+        "description": "A String", # Output only. Free text description for the deal terms.
+        "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+        "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+          "A String",
+        ],
+        "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+          "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.
+        },
+        "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+        "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+        "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+        "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+        "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+        },
+        "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+          "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+        },
+        "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+          "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+          "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+          "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+          "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+        },
+        "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+        "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+        "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+          "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+          "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+        },
+        "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+          "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+            "dayParts": [ # The targeted weekdays and times
+              { # Defines targeting for a period of time on a specific week day.
+                "dayOfWeek": "A String", # Day of week for the period.
+                "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+                "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+              },
+            ],
+            "timeZoneType": "A String", # The time zone type of the day parts
+          },
+          "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+            "A String",
+          ],
+          "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+            "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+            "targetedInventorySizes": [ # A list of inventory sizes to be included.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+          },
+          "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+            "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+              "A String",
+            ],
+          },
+          "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+            "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+              "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+                "excludedAppIds": [ # A list of application IDs to be excluded.
+                  "A String",
+                ],
+                "targetedAppIds": [ # A list of application IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+            "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+              "excludedUris": [ # A list of URLs to be excluded.
+                "A String",
+              ],
+              "targetedUris": [ # A list of URLs to be included.
+                "A String",
+              ],
+            },
+          },
+          "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+            "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+              "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+              "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+            "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+              "A String",
+            ],
+            "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+              "A String",
+            ],
+          },
+        },
+        "updateTime": "A String", # Output only. The time when the deal was last updated.
+      },
+      "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+        "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+        "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+        "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+      },
+      "dealServingStatus": "A String", # Serving status of the deal.
+      "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+      "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+      "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+        "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+        "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+        "bidRequests7Days": "A String", # Bid requests in last 7 days.
+        "bids7Days": "A String", # Bids in last 7 days.
+        "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+        "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+      },
+    },
+  ],
+  "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ pause(name, body=None, x__xgafv=None) +
Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.
+
+Args:
+  name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for pausing a finalized deal.
+  "reason": "A String", # The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ +
+ resume(name, body=None, x__xgafv=None) +
Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.
+
+Args:
+  name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for resuming a finalized deal.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ +
+ setReadyToServe(deal, body=None, x__xgafv=None) +
Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.
+
+Args:
+  deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for setting ready to serve for a finalized deal.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+  "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+    "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+    "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+    "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+    "createTime": "A String", # Output only. The time of the deal creation.
+    "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+      "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+      "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+      "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+      "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+      "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+      "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+    },
+    "dealType": "A String", # Output only. Type of deal.
+    "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+      "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+      "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+      "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+      "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+        { # Message contains details about publisher-set frequency caps of the delivery.
+          "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+          "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+          "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+        },
+      ],
+      "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+    },
+    "description": "A String", # Output only. Free text description for the deal terms.
+    "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+    "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+      "A String",
+    ],
+    "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+      "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.
+    },
+    "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+    "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+    "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+      "accountId": "A String", # Output only. Account ID of the media planner.
+    },
+    "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+    "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+    },
+    "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+      "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+    },
+    "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+      "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+        "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+          "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.
+        },
+        "type": "A String", # The pricing type for the deal.
+      },
+      "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+      "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+      "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+      "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+      "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+    },
+    "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+    "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+    "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+      "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+      "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+    },
+    "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+      "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+        "dayParts": [ # The targeted weekdays and times
+          { # Defines targeting for a period of time on a specific week day.
+            "dayOfWeek": "A String", # Day of week for the period.
+            "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+            "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+              "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+              "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+              "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+              "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+            },
+          },
+        ],
+        "timeZoneType": "A String", # The time zone type of the day parts
+      },
+      "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+        "A String",
+      ],
+      "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+        "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+        "targetedInventorySizes": [ # A list of inventory sizes to be included.
+          { # Represents size of a single ad slot, or a creative.
+            "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            "type": "A String", # The type of the ad slot size.
+            "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          },
+        ],
+      },
+      "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+        "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+          "A String",
+        ],
+      },
+      "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+        "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+          "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+            "excludedAppIds": [ # A list of application IDs to be excluded.
+              "A String",
+            ],
+            "targetedAppIds": [ # A list of application IDs to be included.
+              "A String",
+            ],
+          },
+        },
+        "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+          "excludedUris": [ # A list of URLs to be excluded.
+            "A String",
+          ],
+          "targetedUris": [ # A list of URLs to be included.
+            "A String",
+          ],
+        },
+      },
+      "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+        "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+          "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+        },
+      },
+      "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+        "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+          "A String",
+        ],
+        "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+          "A String",
+        ],
+      },
+    },
+    "updateTime": "A String", # Output only. The time when the deal was last updated.
+  },
+  "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+    "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+    "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+    "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+  },
+  "dealServingStatus": "A String", # Serving status of the deal.
+  "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+  "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+  "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+    "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+    "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+    "bidRequests7Days": "A String", # Bid requests in last 7 days.
+    "bids7Days": "A String", # Bids in last 7 days.
+    "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+    "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html new file mode 100644 index 00000000000..0780b4d9f13 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html @@ -0,0 +1,116 @@ + + + +

Authorized Buyers Marketplace API . buyers

+

Instance Methods

+

+ auctionPackages() +

+

Returns the auctionPackages Resource.

+ +

+ clients() +

+

Returns the clients Resource.

+ +

+ dataSegments() +

+

Returns the dataSegments Resource.

+ +

+ finalizedDeals() +

+

Returns the finalizedDeals Resource.

+ +

+ proposals() +

+

Returns the proposals Resource.

+ +

+ publisherProfiles() +

+

Returns the publisherProfiles Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html new file mode 100644 index 00000000000..1268be967fd --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html @@ -0,0 +1,1532 @@ + + + +

Authorized Buyers Marketplace API . buyers . proposals . deals

+

Instance Methods

+

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

+

Batch updates multiple deals in the same proposal.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a deal given its name. The deal is returned at its head revision.

+

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

+

Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.

+

Method Details

+
+ batchUpdate(parent, body=None, x__xgafv=None) +
Batch updates multiple deals in the same proposal.
+
+Args:
+  parent: string, Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for batch updating deals.
+  "requests": [ # Required. List of request messages to update deals.
+    { # Request message for updating the deal at the given revision number.
+      "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+        "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+        "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+        "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+        "createTime": "A String", # Output only. The time of the deal creation.
+        "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+          "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+          "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+          "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+          "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+          "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+          "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+        },
+        "dealType": "A String", # Output only. Type of deal.
+        "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+          "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+          "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+          "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+          "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+            { # Message contains details about publisher-set frequency caps of the delivery.
+              "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+              "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+              "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+            },
+          ],
+          "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+        },
+        "description": "A String", # Output only. Free text description for the deal terms.
+        "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+        "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+          "A String",
+        ],
+        "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+          "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.
+        },
+        "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+        "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+        "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+          "accountId": "A String", # Output only. Account ID of the media planner.
+        },
+        "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+        "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+        },
+        "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+          "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+        },
+        "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+          "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+            "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+              "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.
+            },
+            "type": "A String", # The pricing type for the deal.
+          },
+          "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+          "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+          "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+          "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+          "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+        },
+        "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+        "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+        "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+          "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+          "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+        },
+        "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+          "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+            "dayParts": [ # The targeted weekdays and times
+              { # Defines targeting for a period of time on a specific week day.
+                "dayOfWeek": "A String", # Day of week for the period.
+                "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+                "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                  "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                  "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                  "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                  "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+                },
+              },
+            ],
+            "timeZoneType": "A String", # The time zone type of the day parts
+          },
+          "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+            "A String",
+          ],
+          "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+            "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+            "targetedInventorySizes": [ # A list of inventory sizes to be included.
+              { # Represents size of a single ad slot, or a creative.
+                "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+                "type": "A String", # The type of the ad slot size.
+                "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              },
+            ],
+          },
+          "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+            "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+              "A String",
+            ],
+          },
+          "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+            "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+              "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+                "excludedAppIds": [ # A list of application IDs to be excluded.
+                  "A String",
+                ],
+                "targetedAppIds": [ # A list of application IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+            "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+              "excludedUris": [ # A list of URLs to be excluded.
+                "A String",
+              ],
+              "targetedUris": [ # A list of URLs to be included.
+                "A String",
+              ],
+            },
+          },
+          "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+            "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+              "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+              "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+                "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                  "A String",
+                ],
+                "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+            "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+              "A String",
+            ],
+            "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+              "A String",
+            ],
+          },
+        },
+        "updateTime": "A String", # Output only. The time when the deal was last updated.
+      },
+      "updateMask": "A String", # List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+    },
+  ],
+}
+
+  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 batch updating deals.
+  "deals": [ # Deals updated.
+    { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+      "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+      "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+      "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+      "createTime": "A String", # Output only. The time of the deal creation.
+      "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+        "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+        "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+        "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+        "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+        "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+        "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+      },
+      "dealType": "A String", # Output only. Type of deal.
+      "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+        "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+        "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+        "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+        "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+          { # Message contains details about publisher-set frequency caps of the delivery.
+            "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+            "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+            "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+          },
+        ],
+        "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+      },
+      "description": "A String", # Output only. Free text description for the deal terms.
+      "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+      "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+        "A String",
+      ],
+      "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+        "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.
+      },
+      "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+      "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+      "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+        "accountId": "A String", # Output only. Account ID of the media planner.
+      },
+      "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+      "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+        "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+      },
+      "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+        "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+        "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+      },
+      "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+        "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+        "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+        "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+        "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+        "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+        "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+      },
+      "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+      "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+      "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+      },
+      "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+        "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+          "dayParts": [ # The targeted weekdays and times
+            { # Defines targeting for a period of time on a specific week day.
+              "dayOfWeek": "A String", # Day of week for the period.
+              "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+              "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+            },
+          ],
+          "timeZoneType": "A String", # The time zone type of the day parts
+        },
+        "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+          "A String",
+        ],
+        "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+          "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+            { # Represents size of a single ad slot, or a creative.
+              "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              "type": "A String", # The type of the ad slot size.
+              "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            },
+          ],
+          "targetedInventorySizes": [ # A list of inventory sizes to be included.
+            { # Represents size of a single ad slot, or a creative.
+              "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              "type": "A String", # The type of the ad slot size.
+              "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            },
+          ],
+        },
+        "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+          "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+            "A String",
+          ],
+        },
+        "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+          "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+            "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+              "excludedAppIds": [ # A list of application IDs to be excluded.
+                "A String",
+              ],
+              "targetedAppIds": [ # A list of application IDs to be included.
+                "A String",
+              ],
+            },
+          },
+          "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+            "excludedUris": [ # A list of URLs to be excluded.
+              "A String",
+            ],
+            "targetedUris": [ # A list of URLs to be included.
+              "A String",
+            ],
+          },
+        },
+        "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+          "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+            "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+          },
+        },
+        "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+          "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+            "A String",
+          ],
+          "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+            "A String",
+          ],
+        },
+      },
+      "updateTime": "A String", # Output only. The time when the deal was last updated.
+    },
+  ],
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a deal given its name. The deal is returned at its head revision.
+
+Args:
+  name: string, Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "createTime": "A String", # Output only. The time of the deal creation.
+  "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+    "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+    "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+    "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+    "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+    "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+    "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+  },
+  "dealType": "A String", # Output only. Type of deal.
+  "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+    "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+    "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+    "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+    "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+      { # Message contains details about publisher-set frequency caps of the delivery.
+        "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+        "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+        "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+      },
+    ],
+    "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+  },
+  "description": "A String", # Output only. Free text description for the deal terms.
+  "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+    "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.
+  },
+  "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+  "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+  "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+    "accountId": "A String", # Output only. Account ID of the media planner.
+  },
+  "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+  "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+  },
+  "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+    "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+  },
+  "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+    "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+    "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+    "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+    "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+  },
+  "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+  "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+  "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+    "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+      "dayParts": [ # The targeted weekdays and times
+        { # Defines targeting for a period of time on a specific week day.
+          "dayOfWeek": "A String", # Day of week for the period.
+          "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+      "timeZoneType": "A String", # The time zone type of the day parts
+    },
+    "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+      "A String",
+    ],
+    "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+      "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+      "targetedInventorySizes": [ # A list of inventory sizes to be included.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+    },
+    "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+      "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+        "A String",
+      ],
+    },
+    "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+      "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+        "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+          "excludedAppIds": [ # A list of application IDs to be excluded.
+            "A String",
+          ],
+          "targetedAppIds": [ # A list of application IDs to be included.
+            "A String",
+          ],
+        },
+      },
+      "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+        "excludedUris": [ # A list of URLs to be excluded.
+          "A String",
+        ],
+        "targetedUris": [ # A list of URLs to be included.
+          "A String",
+        ],
+      },
+    },
+    "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+      "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+        "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+      },
+    },
+    "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+      "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+        "A String",
+      ],
+      "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+        "A String",
+      ],
+    },
+  },
+  "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
+
+Args:
+  parent: string, Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId} (required)
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+  pageToken: string, The page token as returned from ListDealsResponse.
+  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 listing deals in a proposal.
+  "deals": [ # The list of deals.
+    { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+      "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+      "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+      "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+      "createTime": "A String", # Output only. The time of the deal creation.
+      "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+        "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+        "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+        "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+        "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+        "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+        "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+      },
+      "dealType": "A String", # Output only. Type of deal.
+      "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+        "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+        "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+        "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+        "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+          { # Message contains details about publisher-set frequency caps of the delivery.
+            "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+            "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+            "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+          },
+        ],
+        "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+      },
+      "description": "A String", # Output only. Free text description for the deal terms.
+      "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+      "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+        "A String",
+      ],
+      "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+        "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.
+      },
+      "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+      "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+      "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+        "accountId": "A String", # Output only. Account ID of the media planner.
+      },
+      "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+      "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+        "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+      },
+      "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+        "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+        "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+      },
+      "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+        "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+          "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+            "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.
+          },
+          "type": "A String", # The pricing type for the deal.
+        },
+        "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+        "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+        "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+        "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+        "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+      },
+      "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+      "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+      "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+        "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+        "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+      },
+      "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+        "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+          "dayParts": [ # The targeted weekdays and times
+            { # Defines targeting for a period of time on a specific week day.
+              "dayOfWeek": "A String", # Day of week for the period.
+              "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+              "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+                "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+                "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+                "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+                "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+              },
+            },
+          ],
+          "timeZoneType": "A String", # The time zone type of the day parts
+        },
+        "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+          "A String",
+        ],
+        "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+          "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+            { # Represents size of a single ad slot, or a creative.
+              "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              "type": "A String", # The type of the ad slot size.
+              "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            },
+          ],
+          "targetedInventorySizes": [ # A list of inventory sizes to be included.
+            { # Represents size of a single ad slot, or a creative.
+              "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+              "type": "A String", # The type of the ad slot size.
+              "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+            },
+          ],
+        },
+        "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+          "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+            "A String",
+          ],
+        },
+        "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+          "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+            "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+              "excludedAppIds": [ # A list of application IDs to be excluded.
+                "A String",
+              ],
+              "targetedAppIds": [ # A list of application IDs to be included.
+                "A String",
+              ],
+            },
+          },
+          "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+            "excludedUris": [ # A list of URLs to be excluded.
+              "A String",
+            ],
+            "targetedUris": [ # A list of URLs to be included.
+              "A String",
+            ],
+          },
+        },
+        "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+          "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+            "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+              "A String",
+            ],
+            "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+              "A String",
+            ],
+          },
+          "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+            "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+            "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+              "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+                "A String",
+              ],
+              "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+                "A String",
+              ],
+            },
+          },
+        },
+        "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+          "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+            "A String",
+          ],
+          "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+            "A String",
+          ],
+        },
+      },
+      "updateTime": "A String", # Output only. The time when the deal was last updated.
+    },
+  ],
+  "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.
+
+Args:
+  name: string, Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "createTime": "A String", # Output only. The time of the deal creation.
+  "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+    "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+    "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+    "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+    "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+    "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+    "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+  },
+  "dealType": "A String", # Output only. Type of deal.
+  "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+    "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+    "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+    "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+    "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+      { # Message contains details about publisher-set frequency caps of the delivery.
+        "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+        "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+        "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+      },
+    ],
+    "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+  },
+  "description": "A String", # Output only. Free text description for the deal terms.
+  "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+    "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.
+  },
+  "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+  "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+  "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+    "accountId": "A String", # Output only. Account ID of the media planner.
+  },
+  "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+  "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+  },
+  "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+    "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+  },
+  "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+    "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+    "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+    "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+    "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+  },
+  "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+  "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+  "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+    "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+      "dayParts": [ # The targeted weekdays and times
+        { # Defines targeting for a period of time on a specific week day.
+          "dayOfWeek": "A String", # Day of week for the period.
+          "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+      "timeZoneType": "A String", # The time zone type of the day parts
+    },
+    "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+      "A String",
+    ],
+    "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+      "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+      "targetedInventorySizes": [ # A list of inventory sizes to be included.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+    },
+    "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+      "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+        "A String",
+      ],
+    },
+    "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+      "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+        "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+          "excludedAppIds": [ # A list of application IDs to be excluded.
+            "A String",
+          ],
+          "targetedAppIds": [ # A list of application IDs to be included.
+            "A String",
+          ],
+        },
+      },
+      "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+        "excludedUris": [ # A list of URLs to be excluded.
+          "A String",
+        ],
+        "targetedUris": [ # A list of URLs to be included.
+          "A String",
+        ],
+      },
+    },
+    "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+      "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+        "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+      },
+    },
+    "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+      "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+        "A String",
+      ],
+      "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+        "A String",
+      ],
+    },
+  },
+  "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+  updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "createTime": "A String", # Output only. The time of the deal creation.
+  "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+    "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+    "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+    "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+    "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+    "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+    "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+  },
+  "dealType": "A String", # Output only. Type of deal.
+  "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+    "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+    "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+    "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+    "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+      { # Message contains details about publisher-set frequency caps of the delivery.
+        "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+        "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+        "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+      },
+    ],
+    "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+  },
+  "description": "A String", # Output only. Free text description for the deal terms.
+  "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+  "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+    "A String",
+  ],
+  "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+    "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.
+  },
+  "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+  "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+  "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+    "accountId": "A String", # Output only. Account ID of the media planner.
+  },
+  "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+  "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+  },
+  "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+    "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+  },
+  "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+    "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+    "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+    "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+    "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+  },
+  "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+  "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+    "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+    "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+  },
+  "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+    "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+      "dayParts": [ # The targeted weekdays and times
+        { # Defines targeting for a period of time on a specific week day.
+          "dayOfWeek": "A String", # Day of week for the period.
+          "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+          "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+            "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+            "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+            "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+            "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+          },
+        },
+      ],
+      "timeZoneType": "A String", # The time zone type of the day parts
+    },
+    "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+      "A String",
+    ],
+    "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+      "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+      "targetedInventorySizes": [ # A list of inventory sizes to be included.
+        { # Represents size of a single ad slot, or a creative.
+          "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+          "type": "A String", # The type of the ad slot size.
+          "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        },
+      ],
+    },
+    "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+      "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+        "A String",
+      ],
+    },
+    "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+      "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+        "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+          "excludedAppIds": [ # A list of application IDs to be excluded.
+            "A String",
+          ],
+          "targetedAppIds": [ # A list of application IDs to be included.
+            "A String",
+          ],
+        },
+      },
+      "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+        "excludedUris": [ # A list of URLs to be excluded.
+          "A String",
+        ],
+        "targetedUris": [ # A list of URLs to be included.
+          "A String",
+        ],
+      },
+    },
+    "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+      "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+        "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+          "A String",
+        ],
+        "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+          "A String",
+        ],
+      },
+      "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+        "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+        "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+          "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+            "A String",
+          ],
+          "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+            "A String",
+          ],
+        },
+      },
+    },
+    "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+      "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+        "A String",
+      ],
+      "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+        "A String",
+      ],
+    },
+    "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+      "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+        "A String",
+      ],
+      "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+        "A String",
+      ],
+    },
+  },
+  "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html new file mode 100644 index 00000000000..ab878fd59cf --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html @@ -0,0 +1,662 @@ + + + +

Authorized Buyers Marketplace API . buyers . proposals

+

Instance Methods

+

+ deals() +

+

Returns the deals Resource.

+ +

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

+

Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.

+

+ addNote(proposal, body=None, x__xgafv=None)

+

Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.

+

+ cancelNegotiation(proposal, body=None, x__xgafv=None)

+

Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets a proposal using its resource name. The proposal is returned at the latest revision.

+

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

+

Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.

+

+ sendRfp(buyer, body=None, x__xgafv=None)

+

Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.

+

Method Details

+
+ accept(name, body=None, x__xgafv=None) +
Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.
+
+Args:
+  name: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any.
+  "proposalRevision": "A String", # The last known client revision number of the proposal.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ addNote(proposal, body=None, x__xgafv=None) +
Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.
+
+Args:
+  proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to add a note.
+  "note": { # A text note attached to the proposal to facilitate the communication between buyers and sellers. # The note to add.
+    "createTime": "A String", # Output only. When this note was created.
+    "creatorRole": "A String", # Output only. The role who created the note.
+    "note": "A String", # The text of the note. Maximum length is 1024 characters.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ cancelNegotiation(proposal, body=None, x__xgafv=None) +
Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
+
+Args:
+  proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to cancel an ongoing negotiation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets a proposal using its resource name. The proposal is returned at the latest revision.
+
+Args:
+  name: string, Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.
+
+Args:
+  parent: string, Required. Parent that owns the collection of proposals Format: `buyers/{accountId}` (required)
+  filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.
+  pageToken: string, The page token as returned from ListProposalsResponse.
+  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 listing proposals.
+  "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+  "proposals": [ # The list of proposals.
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+      "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+      "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+      "buyerContacts": [ # Contact information for the buyer.
+        { # Contains information on how a buyer or seller can be reached.
+          "displayName": "A String", # The display_name of the contact.
+          "email": "A String", # Email address for the contact.
+        },
+      ],
+      "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+        "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+      },
+      "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+      "dealType": "A String", # Output only. Type of deal the proposal contains.
+      "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+      "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+      "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+      "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+      "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+        { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+          "createTime": "A String", # Output only. When this note was created.
+          "creatorRole": "A String", # Output only. The role who created the note.
+          "note": "A String", # The text of the note. Maximum length is 1024 characters.
+        },
+      ],
+      "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+      "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+      "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+      "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+      "sellerContacts": [ # Output only. Contact information for the seller.
+        { # Contains information on how a buyer or seller can be reached.
+          "displayName": "A String", # The display_name of the contact.
+          "email": "A String", # Email address for the contact.
+        },
+      ],
+      "state": "A String", # Output only. Indicates the state of the proposal.
+      "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+      "updateTime": "A String", # Output only. The time when the proposal was last revised.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.
+
+Args:
+  name: string, Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+  updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ +
+ sendRfp(buyer, body=None, x__xgafv=None) +
Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.
+
+Args:
+  buyer: string, Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation.
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "client": "A String", # If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId}/clients/{clientAccountid}`.
+  "displayName": "A String", # Required. The display name of the proposal being created by this RFP.
+  "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+    "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.
+  },
+  "flightEndTime": "A String", # Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
+  "flightStartTime": "A String", # Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
+  "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Geo criteria IDs to be targeted. Refer to Geo tables.
+    "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+      "A String",
+    ],
+    "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+      "A String",
+    ],
+  },
+  "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Inventory sizes to be targeted.
+    "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+      { # Represents size of a single ad slot, or a creative.
+        "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        "type": "A String", # The type of the ad slot size.
+        "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+      },
+    ],
+    "targetedInventorySizes": [ # A list of inventory sizes to be included.
+      { # Represents size of a single ad slot, or a creative.
+        "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+        "type": "A String", # The type of the ad slot size.
+        "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+      },
+    ],
+  },
+  "note": "A String", # A message that is sent to the publisher. Maximum length is 1024 characters.
+  "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+  },
+  "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+    "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+      "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+        "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.
+      },
+      "type": "A String", # The pricing type for the deal.
+    },
+    "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+    "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+    "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+    "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+    "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+  },
+  "publisherProfile": "A String", # Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+  "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+  "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+  "buyerContacts": [ # Contact information for the buyer.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+    "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+  },
+  "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+  "dealType": "A String", # Output only. Type of deal the proposal contains.
+  "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+  "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+  "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+  "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+  "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+    { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+      "createTime": "A String", # Output only. When this note was created.
+      "creatorRole": "A String", # Output only. The role who created the note.
+      "note": "A String", # The text of the note. Maximum length is 1024 characters.
+    },
+  ],
+  "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+  "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+  "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+  "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+  "sellerContacts": [ # Output only. Contact information for the seller.
+    { # Contains information on how a buyer or seller can be reached.
+      "displayName": "A String", # The display_name of the contact.
+      "email": "A String", # Email address for the contact.
+    },
+  ],
+  "state": "A String", # Output only. Indicates the state of the proposal.
+  "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+  "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html new file mode 100644 index 00000000000..f81b3defa29 --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html @@ -0,0 +1,203 @@ + + + +

Authorized Buyers Marketplace API . buyers . publisherProfiles

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Gets the requested publisher profile by name.

+

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

+

Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Gets the requested publisher profile by name.
+
+Args:
+  name: string, Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}` (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
+  "audienceDescription": "A String", # Description on the publisher's audience.
+  "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+  "displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
+  "domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
+    "A String",
+  ],
+  "isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to "is_parent: true".
+  "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
+  "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
+  "mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
+    { # A mobile application that contains a external app ID, name, and app store.
+      "appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
+      "externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
+      "name": "A String", # The name of the app.
+    },
+  ],
+  "name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
+  "overview": "A String", # Overview of the publisher.
+  "pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
+  "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+  "publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
+  "samplePageUrl": "A String", # URL to a sample content page.
+  "topHeadlines": [ # Up to three key metrics and rankings. For example, "#1 Mobile News Site for 20 Straight Months".
+    "A String",
+  ],
+}
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.
+
+Args:
+  parent: string, Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}` (required)
+  filter: string, Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax.
+  pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+  pageToken: string, The page token as returned from a previous ListPublisherProfilesResponse.
+  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 profiles visible to the buyer.
+  "nextPageToken": "A String", # Token to fetch the next page of results.
+  "publisherProfiles": [ # The list of matching publisher profiles.
+    { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
+      "audienceDescription": "A String", # Description on the publisher's audience.
+      "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+      "displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
+      "domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
+        "A String",
+      ],
+      "isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to "is_parent: true".
+      "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
+      "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
+      "mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
+        { # A mobile application that contains a external app ID, name, and app store.
+          "appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
+          "externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
+          "name": "A String", # The name of the app.
+        },
+      ],
+      "name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
+      "overview": "A String", # Overview of the publisher.
+      "pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
+      "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+      "publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
+      "samplePageUrl": "A String", # URL to a sample content page.
+      "topHeadlines": [ # Up to three key metrics and rankings. For example, "#1 Mobile News Site for 20 Straight Months".
+        "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/authorizedbuyersmarketplace_v1alpha.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.html new file mode 100644 index 00000000000..b2211770e4b --- /dev/null +++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.html @@ -0,0 +1,116 @@ + + + +

Authorized Buyers Marketplace API

+

Instance Methods

+

+ bidders() +

+

Returns the bidders Resource.

+ +

+ buyers() +

+

Returns the buyers 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/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html index 744d6089bfd..9eb2465f3d8 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html @@ -189,6 +189,7 @@

Method Details

"diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. "diskSizeGb": "A String", # Optional. The size of the disk in GB. "diskType": "A String", # Optional. Specifies the type of the disk. + "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -301,7 +302,7 @@

Method Details

], }, ], - "sourceInstanceName": "A String", # Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035. + "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. "A String", @@ -405,6 +406,7 @@

Method Details

"diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. "diskSizeGb": "A String", # Optional. The size of the disk in GB. "diskType": "A String", # Optional. Specifies the type of the disk. + "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -517,7 +519,7 @@

Method Details

], }, ], - "sourceInstanceName": "A String", # Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035. + "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. "A String", @@ -630,6 +632,7 @@

Method Details

"diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk. "diskSizeGb": "A String", # Optional. The size of the disk in GB. "diskType": "A String", # Optional. Specifies the type of the disk. + "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd "guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images. { # Feature type of the Guest OS. "type": "A String", # The ID of a supported feature. @@ -742,7 +745,7 @@

Method Details

], }, ], - "sourceInstanceName": "A String", # Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035. + "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance "tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt). "items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035. "A String", diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html index 8245ff0edeb..b79c4ff9268 100644 --- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html +++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html @@ -104,7 +104,7 @@

Instance Methods

list_next()

Retrieves the next page of results.

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

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

Updates the settings of a BackupVault.

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

@@ -386,7 +386,7 @@

Method Details

- patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) + patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the settings of a BackupVault.
 
 Args:
@@ -417,6 +417,7 @@ 

Method Details

"updateTime": "A String", # Output only. The time when the instance was updated. } + force: boolean, Optional. If set to true, will not check plan duration against backup vault enforcement duration. Non-standard field. 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 since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the BackupVault resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail. validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is 'false'. diff --git a/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html b/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html index 9b951663993..f12d788cc46 100644 --- a/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html +++ b/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html @@ -123,7 +123,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. - "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD. + "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. } @@ -219,7 +219,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. - "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD. + "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. }
@@ -257,7 +257,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. - "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD. + "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. }, ], @@ -304,7 +304,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`. - "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD. + "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD. "updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization. } diff --git a/docs/dyn/classroom_v1.courses.announcements.html b/docs/dyn/classroom_v1.courses.announcements.html index 0d8b5afa2f9..a2858be0b3d 100644 --- a/docs/dyn/classroom_v1.courses.announcements.html +++ b/docs/dyn/classroom_v1.courses.announcements.html @@ -317,7 +317,7 @@

Method Details

courseId: string, Required. Identifier of the course. (required) itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required) addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post. - attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). postId: string, Optional. Deprecated, use item_id instead. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/classroom_v1.courses.courseWork.html b/docs/dyn/classroom_v1.courses.courseWork.html index f772b9376fa..cb566efb8b4 100644 --- a/docs/dyn/classroom_v1.courses.courseWork.html +++ b/docs/dyn/classroom_v1.courses.courseWork.html @@ -427,7 +427,7 @@

Method Details

courseId: string, Required. Identifier of the course. (required) itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required) addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post. - attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). postId: string, Optional. Deprecated, use item_id instead. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/classroom_v1.courses.courseWorkMaterials.html b/docs/dyn/classroom_v1.courses.courseWorkMaterials.html index 60dc67f5b2e..db4cef97d3e 100644 --- a/docs/dyn/classroom_v1.courses.courseWorkMaterials.html +++ b/docs/dyn/classroom_v1.courses.courseWorkMaterials.html @@ -320,7 +320,7 @@

Method Details

courseId: string, Required. Identifier of the course. (required) itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required) addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post. - attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). postId: string, Optional. Deprecated, use item_id instead. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/classroom_v1.courses.posts.html b/docs/dyn/classroom_v1.courses.posts.html index ce6012db225..69854c1fe07 100644 --- a/docs/dyn/classroom_v1.courses.posts.html +++ b/docs/dyn/classroom_v1.courses.posts.html @@ -99,7 +99,7 @@

Method Details

courseId: string, Required. Identifier of the course. (required) postId: string, Optional. Deprecated, use item_id instead. (required) addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post. - attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned. + attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe). itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/cloudasset_v1.assets.html b/docs/dyn/cloudasset_v1.assets.html index e8682327109..74785f6737d 100644 --- a/docs/dyn/cloudasset_v1.assets.html +++ b/docs/dyn/cloudasset_v1.assets.html @@ -158,7 +158,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -466,9 +466,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -550,9 +550,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html index eda1a58ed4b..61088d6130c 100644 --- a/docs/dyn/cloudasset_v1.v1.html +++ b/docs/dyn/cloudasset_v1.v1.html @@ -1046,7 +1046,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -1354,9 +1354,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1438,9 +1438,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1555,7 +1555,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -1863,9 +1863,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -1947,9 +1947,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudasset_v1beta1.organizations.html b/docs/dyn/cloudasset_v1beta1.organizations.html index 00d3ecdd0e0..a26d702ee7d 100644 --- a/docs/dyn/cloudasset_v1beta1.organizations.html +++ b/docs/dyn/cloudasset_v1beta1.organizations.html @@ -153,7 +153,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -268,9 +268,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -352,9 +352,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudasset_v1beta1.projects.html b/docs/dyn/cloudasset_v1beta1.projects.html index 1ff73a11d59..9c99f0d09c9 100644 --- a/docs/dyn/cloudasset_v1beta1.projects.html +++ b/docs/dyn/cloudasset_v1beta1.projects.html @@ -153,7 +153,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -268,9 +268,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -352,9 +352,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudasset_v1p5beta1.assets.html b/docs/dyn/cloudasset_v1p5beta1.assets.html index 12bef1eaf69..eca1de91d8e 100644 --- a/docs/dyn/cloudasset_v1p5beta1.assets.html +++ b/docs/dyn/cloudasset_v1p5beta1.assets.html @@ -155,7 +155,7 @@

Method Details

], "vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`. { # The originating network source in Google Cloud. - "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. "network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1` "vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed. "A String", @@ -273,9 +273,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, @@ -357,9 +357,9 @@

Method Details

], "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. "sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`. - "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. { # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries. - "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out. + "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. }, ], }, diff --git a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html index a53b33136d5..d0450779025 100644 --- a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html +++ b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html @@ -112,7 +112,7 @@

Method Details

An object of the form: { # Contains metadata around a Cloud Controls Partner Customer - "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps + "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps "onboardingSteps": [ # List of customer onboarding steps { # Container for customer onboarding information "completionState": "A String", # Output only. Current state of the step @@ -122,8 +122,8 @@

Method Details

}, ], }, - "displayName": "A String", # The customer organization's display name. E.g. "google.com". - "isOnboarded": True or False, # Indicates whether a customer is fully onboarded + "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com". + "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }
@@ -149,7 +149,7 @@

Method Details

{ # Response message for list customer Customers requests "customers": [ # List of customers { # Contains metadata around a Cloud Controls Partner Customer - "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps + "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps "onboardingSteps": [ # List of customer onboarding steps { # Container for customer onboarding information "completionState": "A String", # Output only. Current state of the step @@ -159,8 +159,8 @@

Method Details

}, ], }, - "displayName": "A String", # The customer organization's display name. E.g. "google.com". - "isOnboarded": True or False, # Indicates whether a customer is fully onboarded + "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com". + "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }, ], diff --git a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html index eb0754056d8..0a8609c2d8f 100644 --- a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html +++ b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html @@ -112,7 +112,7 @@

Method Details

An object of the form: { # Contains metadata around a Cloud Controls Partner Customer - "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps + "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps "onboardingSteps": [ # List of customer onboarding steps { # Container for customer onboarding information "completionState": "A String", # Output only. Current state of the step @@ -122,8 +122,8 @@

Method Details

}, ], }, - "displayName": "A String", # The customer organization's display name. E.g. "google.com". - "isOnboarded": True or False, # Indicates whether a customer is fully onboarded + "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com". + "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }
@@ -149,7 +149,7 @@

Method Details

{ # Response message for list customer Customers requests "customers": [ # List of customers { # Contains metadata around a Cloud Controls Partner Customer - "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps + "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps "onboardingSteps": [ # List of customer onboarding steps { # Container for customer onboarding information "completionState": "A String", # Output only. Current state of the step @@ -159,8 +159,8 @@

Method Details

}, ], }, - "displayName": "A String", # The customer organization's display name. E.g. "google.com". - "isOnboarded": True or False, # Indicates whether a customer is fully onboarded + "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com". + "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded "name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}` }, ], diff --git a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html index 5a3b311fea1..f0f796c78a6 100644 --- a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html +++ b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html @@ -225,7 +225,7 @@

Method Details

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function. "sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted. "deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. - "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. + "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL. }, "sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List) @@ -437,7 +437,7 @@

Method Details

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function. "sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted. "deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. - "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. + "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL. }, "sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List) @@ -585,7 +585,7 @@

Method Details

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function. "sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted. "deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. - "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. + "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL. }, "sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List) @@ -696,7 +696,7 @@

Method Details

"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function. "sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted. "deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above. - "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. + "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL. }, "sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. "sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List) diff --git a/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html b/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html index 8792212b774..1967ebdddc2 100644 --- a/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html +++ b/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html @@ -111,9 +111,9 @@

Method Details

The object takes the form of: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" } @@ -127,9 +127,9 @@

Method Details

An object of the form: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" }
@@ -168,9 +168,9 @@

Method Details

An object of the form: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" }
@@ -196,9 +196,9 @@

Method Details

"nextPageToken": "A String", # A paginated response where more pages might be available has `next_page_token` set. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`. "sinks": [ # A list of sinks. { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" }, @@ -230,9 +230,9 @@

Method Details

The object takes the form of: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" } @@ -247,9 +247,9 @@

Method Details

An object of the form: { # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project. - "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. + "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods. "outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination. - "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" + "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]" }, "writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com" }
diff --git a/docs/dyn/composer_v1.projects.locations.environments.html b/docs/dyn/composer_v1.projects.locations.environments.html index 537fa162fd9..2a6e2251d38 100644 --- a/docs/dyn/composer_v1.projects.locations.environments.html +++ b/docs/dyn/composer_v1.projects.locations.environments.html @@ -347,6 +347,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -685,6 +686,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -869,6 +871,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -1107,6 +1110,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.html b/docs/dyn/composer_v1beta1.projects.locations.environments.html index 518a43c16d8..82dd8d0b9b1 100644 --- a/docs/dyn/composer_v1beta1.projects.locations.environments.html +++ b/docs/dyn/composer_v1beta1.projects.locations.environments.html @@ -352,6 +352,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -692,6 +693,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -878,6 +880,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. @@ -1118,6 +1121,7 @@

Method Details

"a_key": "A String", }, "name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen. + "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "state": "A String", # The current state of the environment. "storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment. diff --git a/docs/dyn/compute_alpha.html b/docs/dyn/compute_alpha.html index 79f8b7810f0..20547da92bb 100644 --- a/docs/dyn/compute_alpha.html +++ b/docs/dyn/compute_alpha.html @@ -224,6 +224,11 @@

Instance Methods

Returns the instances Resource.

+

+ instantSnapshotGroups() +

+

Returns the instantSnapshotGroups Resource.

+

instantSnapshots()

@@ -384,6 +389,11 @@

Instance Methods

Returns the regionHealthChecks Resource.

+

+ regionInstanceGroupManagerResizeRequests() +

+

Returns the regionInstanceGroupManagerResizeRequests Resource.

+

regionInstanceGroupManagers()

@@ -404,6 +414,11 @@

Instance Methods

Returns the regionInstances Resource.

+

+ regionInstantSnapshotGroups() +

+

Returns the regionInstantSnapshotGroups Resource.

+

regionInstantSnapshots()

diff --git a/docs/dyn/compute_alpha.instanceGroupManagers.html b/docs/dyn/compute_alpha.instanceGroupManagers.html index c3fd7e97f85..9a80e32b2b2 100644 --- a/docs/dyn/compute_alpha.instanceGroupManagers.html +++ b/docs/dyn/compute_alpha.instanceGroupManagers.html @@ -441,6 +441,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1402,6 +1405,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1602,6 +1608,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1932,6 +1941,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -2485,6 +2497,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -4357,6 +4372,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. diff --git a/docs/dyn/compute_alpha.instantSnapshotGroups.html b/docs/dyn/compute_alpha.instantSnapshotGroups.html new file mode 100644 index 00000000000..b85ea5aa722 --- /dev/null +++ b/docs/dyn/compute_alpha.instantSnapshotGroups.html @@ -0,0 +1,490 @@ + + + +

Compute Engine API . instantSnapshotGroups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, zone, instantSnapshotGroup, requestId=None, x__xgafv=None)

+

deletes a Zonal InstantSnapshotGroup resource

+

+ get(project, zone, instantSnapshotGroup, x__xgafv=None)

+

returns the specified InstantSnapshotGroup resource in the specified zone.

+

+ insert(project, zone, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None)

+

inserts a Zonal InstantSnapshotGroup resource

+

+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

retrieves the list of InstantSnapshotGroup resources contained within the specified zone.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, zone, instantSnapshotGroup, requestId=None, x__xgafv=None) +
deletes a Zonal InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  instantSnapshotGroup: string, Name of the InstantSnapshot resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ get(project, zone, instantSnapshotGroup, x__xgafv=None) +
returns the specified InstantSnapshotGroup resource in the specified zone.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  instantSnapshotGroup: string, Name of the instantSnapshotGroup resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # [Output Only]
+    "sourceInfo": { # [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "status": "A String", # [Output Only]
+  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+}
+
+ +
+ insert(project, zone, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None) +
inserts a Zonal InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, Name of the zone for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # [Output Only]
+    "sourceInfo": { # [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "status": "A String", # [Output Only]
+  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  sourceConsistencyGroup: string, begin_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ list(project, zone, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
retrieves the list of InstantSnapshotGroup resources contained within the specified zone.
+
+Args:
+  project: string, Project ID for this request. (required)
+  zone: string, The name of the zone for this request. (required)
+  filter: string, 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.
+  maxResults: integer, 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`)
+  orderBy: string, 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.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of InstantSnapshotGroup resources.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of InstantSnapshotGroup resources.
+    {
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+      "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+      "resourceStatus": {
+        "consistencyMembershipResolutionTime": "A String", # [Output Only]
+        "sourceInfo": { # [Output Only]
+          "consistencyGroup": "A String",
+          "consistencyGroupId": "A String",
+        },
+      },
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+      "status": "A String", # [Output Only]
+      "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+    },
+  ],
+  "kind": "compute#instantSnapshotGroupsList", # Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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/compute_alpha.interconnects.html b/docs/dyn/compute_alpha.interconnects.html index d070351c802..6789842e579 100644 --- a/docs/dyn/compute_alpha.interconnects.html +++ b/docs/dyn/compute_alpha.interconnects.html @@ -271,6 +271,14 @@

Method Details

}, ], }, + "egressMinBandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, @@ -554,6 +562,14 @@

Method Details

}, ], }, + "egressMinBandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, @@ -777,6 +793,14 @@

Method Details

}, ], }, + "egressMinBandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, @@ -900,6 +924,14 @@

Method Details

}, ], }, + "egressMinBandwidthPercentagePolicy": { + "bandwidthPercentages": [ # Specify bandwidth percentages for various traffic classes for queuing type Bandwidth Percent. + { # Specify bandwidth percentages [1-100] for various traffic classes in BandwidthPercentagePolicy. The sum of all percentages must equal 100. All traffic classes must have a percentage value specified. + "percentage": 42, # Bandwidth percentage for a specific traffic class. + "trafficClass": "A String", # TrafficClass whose bandwidth percentage is being specified. + }, + ], + }, "profileDescription": "A String", # A description for the AAI profile on this interconnect. "strictPriorityPolicy": { # Specify configuration for StrictPriorityPolicy. }, diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html new file mode 100644 index 00000000000..3d327f613e8 --- /dev/null +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagerResizeRequests.html @@ -0,0 +1,479 @@ + + + +

Compute Engine API . regionInstanceGroupManagerResizeRequests

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(project, region, instanceGroupManager, resizeRequest, x__xgafv=None)

+

Returns all of the details about the specified resize request.

+

+ insert(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None)

+

Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(project, region, instanceGroupManager, resizeRequest, x__xgafv=None) +
Returns all of the details about the specified resize request.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, The name of the managed instance group. Name should conform to RFC1035 or be a resource ID. (required)
+  resizeRequest: string, The name of the resize request. Name should conform to RFC1035 or be a resource ID. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.
+  "count": 42, # This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.
+  "creationTimestamp": "A String", # [Output Only] The creation timestamp for this resize request in RFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#instanceGroupManagerResizeRequest", # [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
+  "name": "A String", # The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
+  "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible.
+    "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
+      "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+      "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    },
+    "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
+  },
+  "requestedRunDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
+    "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+    "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+  },
+  "resizeBy": 42, # The number of instances to be created by this resize request. The group's target size will be increased by this number.
+  "selfLink": "A String", # [Output Only] The URL for this resize request. The server defines this URL.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "state": "A String", # [Output only] Current state of the request.
+  "status": { # [Output only] Status of the request.
+    "error": { # [Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+            {
+              "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                  "a_key": "A String",
+                },
+                "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+              },
+              "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                "links": [ # URL(s) pointing to additional information on handling the current error.
+                  { # Describes a URL link.
+                    "description": "A String", # Describes what the link offers.
+                    "url": "A String", # The URL of the link.
+                  },
+                ],
+              },
+              "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                "message": "A String", # The localized error message in the above locale.
+              },
+              "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                "dimensions": { # The map holding related quota dimensions.
+                  "a_key": "A String",
+                },
+                "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+                "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                "limitName": "A String", # The name of the quota limit.
+                "metricName": "A String", # The Compute Engine quota metric name.
+                "rolloutStatus": "A String", # Rollout status of the future quota limit.
+              },
+            },
+          ],
+          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+        },
+      ],
+    },
+    "lastAttempt": { # [Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the "error" field only.
+      "error": { # Errors that prevented the ResizeRequest to be fulfilled.
+        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+          {
+            "code": "A String", # [Output Only] The error type identifier for this error.
+            "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+              {
+                "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                  "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                  "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                    "a_key": "A String",
+                  },
+                  "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+                },
+                "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                  "links": [ # URL(s) pointing to additional information on handling the current error.
+                    { # Describes a URL link.
+                      "description": "A String", # Describes what the link offers.
+                      "url": "A String", # The URL of the link.
+                    },
+                  ],
+                },
+                "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                  "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                  "message": "A String", # The localized error message in the above locale.
+                },
+                "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                  "dimensions": { # The map holding related quota dimensions.
+                    "a_key": "A String",
+                  },
+                  "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+                  "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                  "limitName": "A String", # The name of the quota limit.
+                  "metricName": "A String", # The Compute Engine quota metric name.
+                  "rolloutStatus": "A String", # Rollout status of the future quota limit.
+                },
+              },
+            ],
+            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+            "message": "A String", # [Output Only] An optional, human-readable error message.
+          },
+        ],
+      },
+    },
+    "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, setting queueing policy is no longer supported. Constraints for the time when the instances start provisioning. Always exposed as absolute time.
+      "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
+        "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+        "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+      },
+      "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
+    },
+  },
+  "zone": "A String", # [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
+}
+
+ +
+ insert(project, region, instanceGroupManager, body=None, requestId=None, x__xgafv=None) +
Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region scoping this request. Name should conform to RFC1035. (required)
+  instanceGroupManager: string, Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # InstanceGroupManagerResizeRequest represents a request to create a number of VMs: either immediately or by queuing the request for the specified time. This resize request is nested under InstanceGroupManager and the VMs created by this request are added to the owning InstanceGroupManager.
+  "count": 42, # This field is deprecated, please use resize_by instead. The count of instances to create as part of this resize request.
+  "creationTimestamp": "A String", # [Output Only] The creation timestamp for this resize request in RFC3339 text format.
+  "description": "A String", # An optional description of this resource.
+  "id": "A String", # [Output Only] A unique identifier for this resource type. The server generates this identifier.
+  "kind": "compute#instanceGroupManagerResizeRequest", # [Output Only] The resource type, which is always compute#instanceGroupManagerResizeRequest for resize requests.
+  "name": "A String", # The name of this resize request. The name must be 1-63 characters long, and comply with RFC1035.
+  "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, ResizeRequests would not be provisioned immediately and would stay in the queue until explicitly cancelled. When set, defines queing parameters for the requested deferred capacity. When unset, the request starts provisioning immediately, or fails if immediate provisioning is not possible.
+    "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
+      "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+      "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+    },
+    "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
+  },
+  "requestedRunDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Requested run duration for instances that will be created by this request. At the end of the run duration instance will be deleted.
+    "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+    "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+  },
+  "resizeBy": 42, # The number of instances to be created by this resize request. The group's target size will be increased by this number.
+  "selfLink": "A String", # [Output Only] The URL for this resize request. The server defines this URL.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "state": "A String", # [Output only] Current state of the request.
+  "status": { # [Output only] Status of the request.
+    "error": { # [Output only] Fatal errors encountered during the queueing or provisioning phases of the ResizeRequest that caused the transition to the FAILED state. Contrary to the last_attempt errors, this field is final and errors are never removed from here, as the ResizeRequest is not going to retry.
+      "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+        {
+          "code": "A String", # [Output Only] The error type identifier for this error.
+          "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+            {
+              "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                  "a_key": "A String",
+                },
+                "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+              },
+              "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                "links": [ # URL(s) pointing to additional information on handling the current error.
+                  { # Describes a URL link.
+                    "description": "A String", # Describes what the link offers.
+                    "url": "A String", # The URL of the link.
+                  },
+                ],
+              },
+              "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                "message": "A String", # The localized error message in the above locale.
+              },
+              "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                "dimensions": { # The map holding related quota dimensions.
+                  "a_key": "A String",
+                },
+                "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+                "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                "limitName": "A String", # The name of the quota limit.
+                "metricName": "A String", # The Compute Engine quota metric name.
+                "rolloutStatus": "A String", # Rollout status of the future quota limit.
+              },
+            },
+          ],
+          "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+          "message": "A String", # [Output Only] An optional, human-readable error message.
+        },
+      ],
+    },
+    "lastAttempt": { # [Output only] Information about the last attempt to fulfill the request. The value is temporary since the ResizeRequest can retry, as long as it's still active and the last attempt value can either be cleared or replaced with a different error. Since ResizeRequest retries infrequently, the value may be stale and no longer show an active problem. The value is cleared when ResizeRequest transitions to the final state (becomes inactive). If the final state is FAILED the error describing it will be storred in the "error" field only.
+      "error": { # Errors that prevented the ResizeRequest to be fulfilled.
+        "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+          {
+            "code": "A String", # [Output Only] The error type identifier for this error.
+            "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+              {
+                "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+                  "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+                  "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                    "a_key": "A String",
+                  },
+                  "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+                },
+                "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+                  "links": [ # URL(s) pointing to additional information on handling the current error.
+                    { # Describes a URL link.
+                      "description": "A String", # Describes what the link offers.
+                      "url": "A String", # The URL of the link.
+                    },
+                  ],
+                },
+                "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+                  "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+                  "message": "A String", # The localized error message in the above locale.
+                },
+                "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+                  "dimensions": { # The map holding related quota dimensions.
+                    "a_key": "A String",
+                  },
+                  "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+                  "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+                  "limitName": "A String", # The name of the quota limit.
+                  "metricName": "A String", # The Compute Engine quota metric name.
+                  "rolloutStatus": "A String", # Rollout status of the future quota limit.
+                },
+              },
+            ],
+            "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+            "message": "A String", # [Output Only] An optional, human-readable error message.
+          },
+        ],
+      },
+    },
+    "queuingPolicy": { # Queuing parameters for the requested deferred capacity. # This field is deprecated, setting queueing policy is no longer supported. Constraints for the time when the instances start provisioning. Always exposed as absolute time.
+      "validUntilDuration": { # A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. # Relative deadline for waiting for capacity.
+        "nanos": 42, # Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
+        "seconds": "A String", # Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
+      },
+      "validUntilTime": "A String", # Absolute deadline for waiting for capacity in RFC3339 text format.
+    },
+  },
+  "zone": "A String", # [Output Only] The URL of a zone where the resize request is located. Populated only for zonal resize requests.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html index c73db1a04e9..43d462f6f32 100644 --- a/docs/dyn/compute_alpha.regionInstanceGroupManagers.html +++ b/docs/dyn/compute_alpha.regionInstanceGroupManagers.html @@ -1133,6 +1133,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1333,6 +1336,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1663,6 +1669,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -2216,6 +2225,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -4088,6 +4100,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. diff --git a/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html new file mode 100644 index 00000000000..3de09899788 --- /dev/null +++ b/docs/dyn/compute_alpha.regionInstantSnapshotGroups.html @@ -0,0 +1,490 @@ + + + +

Compute Engine API . regionInstantSnapshotGroups

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ delete(project, region, instantSnapshotGroup, requestId=None, x__xgafv=None)

+

deletes a Regional InstantSnapshotGroup resource

+

+ get(project, region, instantSnapshot, x__xgafv=None)

+

returns the specified InstantSnapshotGroup resource in the specified region.

+

+ insert(project, region, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None)

+

creates a Regional InstantSnapshotGroup resource

+

+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)

+

retrieves the list of InstantSnapshotGroup resources contained within the specified region.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ delete(project, region, instantSnapshotGroup, requestId=None, x__xgafv=None) +
deletes a Regional InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  instantSnapshotGroup: string, Name of the InstantSnapshotGroup resource to delete. (required)
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ get(project, region, instantSnapshot, x__xgafv=None) +
returns the specified InstantSnapshotGroup resource in the specified region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  instantSnapshot: string, Name of the InstantSnapshotGroup resource to return. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # [Output Only]
+    "sourceInfo": { # [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "status": "A String", # [Output Only]
+  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+}
+
+ +
+ insert(project, region, body=None, requestId=None, sourceConsistencyGroup=None, x__xgafv=None) +
creates a Regional InstantSnapshotGroup resource
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, Name of the region for this request. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+  "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+  "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+  "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+  "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+  "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+  "resourceStatus": {
+    "consistencyMembershipResolutionTime": "A String", # [Output Only]
+    "sourceInfo": { # [Output Only]
+      "consistencyGroup": "A String",
+      "consistencyGroupId": "A String",
+    },
+  },
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+  "status": "A String", # [Output Only]
+  "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+}
+
+  requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
+  sourceConsistencyGroup: string, begin_interface: MixerMutationRequestBuilder
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Represents an Operation resource. Google Compute Engine has three Operation resources: * [Global](/compute/docs/reference/rest/alpha/globalOperations) * [Regional](/compute/docs/reference/rest/alpha/regionOperations) * [Zonal](/compute/docs/reference/rest/alpha/zoneOperations) You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses. Operations can be global, regional or zonal. - For global operations, use the `globalOperations` resource. - For regional operations, use the `regionOperations` resource. - For zonal operations, use the `zoneOperations` resource. For more information, read Global, Regional, and Zonal Resources. Note that completed Operation resources have a limited retention period.
+  "clientOperationId": "A String", # [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
+  "creationTimestamp": "A String", # [Deprecated] This field is deprecated.
+  "description": "A String", # [Output Only] A textual description of the operation, which is set when the operation is created.
+  "endTime": "A String", # [Output Only] The time that this operation was completed. This value is in RFC3339 text format.
+  "error": { # [Output Only] If errors are generated during processing of the operation, this field will be populated.
+    "errors": [ # [Output Only] The array of errors encountered while processing this operation.
+      {
+        "code": "A String", # [Output Only] The error type identifier for this error.
+        "errorDetails": [ # [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
+          {
+            "errorInfo": { # Describes the cause of the error with structured details. Example of an error when contacting the "pubsub.googleapis.com" API when it is not enabled: { "reason": "API_DISABLED" "domain": "googleapis.com" "metadata": { "resource": "projects/123", "service": "pubsub.googleapis.com" } } This response indicates that the pubsub.googleapis.com API is not enabled. Example of an error that is returned when attempting to create a Spanner instance in a region that is out of stock: { "reason": "STOCKOUT" "domain": "spanner.googleapis.com", "metadata": { "availableRegions": "us-central1,us-east2" } }
+              "domain": "A String", # The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
+              "metadatas": { # Additional structured details about this error. Keys must match /a-z+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
+                "a_key": "A String",
+              },
+              "reason": "A String", # The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `A-Z+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
+            },
+            "help": { # Provides links to documentation or for performing an out of band action. For example, if a quota check failed with an error indicating the calling project hasn't enabled the accessed service, this can contain a URL pointing directly to the right place in the developer console to flip the bit.
+              "links": [ # URL(s) pointing to additional information on handling the current error.
+                { # Describes a URL link.
+                  "description": "A String", # Describes what the link offers.
+                  "url": "A String", # The URL of the link.
+                },
+              ],
+            },
+            "localizedMessage": { # Provides a localized error message that is safe to return to the user which can be attached to an RPC error.
+              "locale": "A String", # The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
+              "message": "A String", # The localized error message in the above locale.
+            },
+            "quotaInfo": { # Additional details for quota exceeded error for resource quota.
+              "dimensions": { # The map holding related quota dimensions.
+                "a_key": "A String",
+              },
+              "futureLimit": 3.14, # Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
+              "limit": 3.14, # Current effective quota limit. The limit's unit depends on the quota type or metric.
+              "limitName": "A String", # The name of the quota limit.
+              "metricName": "A String", # The Compute Engine quota metric name.
+              "rolloutStatus": "A String", # Rollout status of the future quota limit.
+            },
+          },
+        ],
+        "location": "A String", # [Output Only] Indicates the field in the request that caused the error. This property is optional.
+        "message": "A String", # [Output Only] An optional, human-readable error message.
+      },
+    ],
+  },
+  "httpErrorMessage": "A String", # [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
+  "httpErrorStatusCode": 42, # [Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a `404` means the resource was not found.
+  "id": "A String", # [Output Only] The unique identifier for the operation. This identifier is defined by the server.
+  "insertTime": "A String", # [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
+  "instancesBulkInsertOperationMetadata": {
+    "perLocationStatus": { # Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "createdVmCount": 42, # [Output Only] Count of VMs successfully created so far.
+        "deletedVmCount": 42, # [Output Only] Count of VMs that got deleted during rollback.
+        "failedToCreateVmCount": 42, # [Output Only] Count of VMs that started creating but encountered an error.
+        "status": "A String", # [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
+        "targetVmCount": 42, # [Output Only] Count of VMs originally planned to be created.
+      },
+    },
+  },
+  "kind": "compute#operation", # [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
+  "name": "A String", # [Output Only] Name of the operation.
+  "operationGroupId": "A String", # [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
+  "operationType": "A String", # [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
+  "progress": 42, # [Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses.
+  "region": "A String", # [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
+  "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+  "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id.
+  "setCommonInstanceMetadataOperationMetadata": { # [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
+    "clientOperationId": "A String", # [Output Only] The client operation id.
+    "perLocationOperations": { # [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
+      "a_key": {
+        "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
+          "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.
+        },
+        "state": "A String", # [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
+      },
+    },
+  },
+  "startTime": "A String", # [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
+  "status": "A String", # [Output Only] The status of the operation, which can be one of the following: `PENDING`, `RUNNING`, or `DONE`.
+  "statusMessage": "A String", # [Output Only] An optional textual description of the current status of the operation.
+  "targetId": "A String", # [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
+  "targetLink": "A String", # [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from.
+  "user": "A String", # [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
+  "warnings": [ # [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
+    {
+      "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+      "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+        {
+          "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+          "value": "A String", # [Output Only] A warning data value corresponding to the key.
+        },
+      ],
+      "message": "A String", # [Output Only] A human-readable description of the warning code.
+    },
+  ],
+  "zone": "A String", # [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
+}
+
+ +
+ list(project, region, filter=None, maxResults=None, orderBy=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None) +
retrieves the list of InstantSnapshotGroup resources contained within the specified region.
+
+Args:
+  project: string, Project ID for this request. (required)
+  region: string, The name of the region for this request. (required)
+  filter: string, 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.
+  maxResults: integer, 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`)
+  orderBy: string, 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.
+  pageToken: string, Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.
+  returnPartialSuccess: boolean, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Contains a list of InstantSnapshotGroup resources.
+  "etag": "A String",
+  "id": "A String", # [Output Only] Unique identifier for the resource; defined by the server.
+  "items": [ # A list of InstantSnapshotGroup resources.
+    {
+      "creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.
+      "description": "A String", # Optional. An optional description of this resource. Provide this property when you create the resource.
+      "id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.
+      "kind": "compute#instantSnapshotGroup", # [Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.
+      "name": "A String", # Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
+      "region": "A String", # [Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+      "resourceStatus": {
+        "consistencyMembershipResolutionTime": "A String", # [Output Only]
+        "sourceInfo": { # [Output Only]
+          "consistencyGroup": "A String",
+          "consistencyGroupId": "A String",
+        },
+      },
+      "selfLink": "A String", # [Output Only] Server-defined URL for the resource.
+      "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource's resource id.
+      "status": "A String", # [Output Only]
+      "zone": "A String", # [Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.
+    },
+  ],
+  "kind": "compute#instantSnapshotGroupsList", # Type of resource.
+  "nextPageToken": "A String", # [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
+  "selfLink": "A String", # [Output Only] Server-defined URL for this resource.
+  "unreachables": [ # [Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder
+    "A String",
+  ],
+  "warning": { # [Output Only] Informational warning message.
+    "code": "A String", # [Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.
+    "data": [ # [Output Only] Metadata about this warning in key: value format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
+      {
+        "key": "A String", # [Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).
+        "value": "A String", # [Output Only] A warning data value corresponding to the key.
+      },
+    ],
+    "message": "A String", # [Output Only] A human-readable description of the warning code.
+  },
+}
+
+ +
+ 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/compute_alpha.regionMultiMigs.html b/docs/dyn/compute_alpha.regionMultiMigs.html index a683dc258e9..537897dedec 100644 --- a/docs/dyn/compute_alpha.regionMultiMigs.html +++ b/docs/dyn/compute_alpha.regionMultiMigs.html @@ -357,6 +357,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -450,6 +453,11 @@

Method Details

}, "selfLink": "A String", # [Output only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "status": { + "memberInstanceGroupManagers": [ + "A String", + ], + }, }
@@ -580,6 +588,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -673,6 +684,11 @@

Method Details

}, "selfLink": "A String", # [Output only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "status": { + "memberInstanceGroupManagers": [ + "A String", + ], + }, } requestId: string, An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). @@ -934,6 +950,9 @@

Method Details

}, }, "region": "A String", # [Output Only] The URL of the region where the managed instance group resides (for regional resources). + "resourcePolicies": { # Resource policies for this managed instance group. + "workloadPolicy": "A String", # The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy + }, "satisfiesPzi": True or False, # [Output Only] Reserved for future use. "satisfiesPzs": True or False, # [Output Only] Reserved for future use. "selfLink": "A String", # [Output Only] The URL for this managed instance group. The server defines this URL. @@ -1027,6 +1046,11 @@

Method Details

}, "selfLink": "A String", # [Output only] Server-defined URL for the resource. "selfLinkWithId": "A String", # [Output Only] Server-defined URL for this resource with the resource id. + "status": { + "memberInstanceGroupManagers": [ + "A String", + ], + }, }, ], "kind": "compute#multiMigList", # Type of resource. diff --git a/docs/dyn/config_v1.projects.locations.deployments.html b/docs/dyn/config_v1.projects.locations.deployments.html index 3c7aab9d3ab..14453a45672 100644 --- a/docs/dyn/config_v1.projects.locations.deployments.html +++ b/docs/dyn/config_v1.projects.locations.deployments.html @@ -174,8 +174,8 @@

Method Details

"state": "A String", # Output only. Current state of the deployment. "stateDetail": "A String", # Output only. Additional information regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -402,8 +402,8 @@

Method Details

"state": "A String", # Output only. Current state of the deployment. "stateDetail": "A String", # Output only. Additional information regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -563,8 +563,8 @@

Method Details

"state": "A String", # Output only. Current state of the deployment. "stateDetail": "A String", # Output only. Additional information regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -700,8 +700,8 @@

Method Details

"state": "A String", # Output only. Current state of the deployment. "stateDetail": "A String", # Output only. Additional information regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' diff --git a/docs/dyn/config_v1.projects.locations.deployments.revisions.html b/docs/dyn/config_v1.projects.locations.deployments.revisions.html index c3cb6a5a466..5e4a1798a03 100644 --- a/docs/dyn/config_v1.projects.locations.deployments.revisions.html +++ b/docs/dyn/config_v1.projects.locations.deployments.revisions.html @@ -164,8 +164,8 @@

Method Details

"state": "A String", # Output only. Current state of the revision. "stateDetail": "A String", # Output only. Additional info regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # Output only. A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -245,8 +245,8 @@

Method Details

"state": "A String", # Output only. Current state of the revision. "stateDetail": "A String", # Output only. Additional info regarding the current state. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # Output only. A blueprint described using Terraform's HashiCorp Configuration Language as a root module. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' diff --git a/docs/dyn/config_v1.projects.locations.previews.html b/docs/dyn/config_v1.projects.locations.previews.html index 176959165a6..44d4ac2ed8a 100644 --- a/docs/dyn/config_v1.projects.locations.previews.html +++ b/docs/dyn/config_v1.projects.locations.previews.html @@ -142,8 +142,8 @@

Method Details

"serviceAccount": "A String", # Optional. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` "state": "A String", # Output only. Current state of the preview. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # The terraform blueprint to preview. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -316,8 +316,8 @@

Method Details

"serviceAccount": "A String", # Optional. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` "state": "A String", # Output only. Current state of the preview. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # The terraform blueprint to preview. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' @@ -403,8 +403,8 @@

Method Details

"serviceAccount": "A String", # Optional. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}` "state": "A String", # Output only. Current state of the preview. "terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # The terraform blueprint to preview. - "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` - "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo. + "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}` + "gitSource": { # A set of files in a Git repository. # URI of a public Git repo. "directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package' "ref": "A String", # Optional. Git reference (e.g. branch or tag). "repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git' diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html index 0739667e877..495752c1f73 100644 --- a/docs/dyn/connectors_v1.projects.locations.connections.html +++ b/docs/dyn/connectors_v1.projects.locations.connections.html @@ -155,6 +155,7 @@

Method Details

The object takes the form of: { # 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. @@ -243,6 +244,7 @@

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. @@ -629,6 +631,7 @@

Method Details

An object of the form: { # 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. @@ -717,6 +720,7 @@

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. @@ -1122,6 +1126,7 @@

Method Details

{ # Response message for ConnectorsService.ListConnections "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. @@ -1210,6 +1215,7 @@

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. @@ -1569,6 +1575,7 @@

Method Details

The object takes the form of: { # 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. @@ -1657,6 +1664,7 @@

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. @@ -2149,6 +2157,7 @@

Method Details

], }, "connection": { # Connection represents an instance of connector. # Output only. Connection details + "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. @@ -2237,6 +2246,7 @@

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. 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 c098918d86e..677f038795c 100644 --- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html +++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html @@ -268,6 +268,7 @@

Method Details

"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. }, "internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd. + "migrateDeploymentModel": True or False, # Indicate whether connector is being migrated to cloud run deployment model. "ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests. "resourceLimits": { # Resource limits defined for connection pods of a given connector type. # System resource limits. "cpu": "A String", # Output only. CPU limit. @@ -993,6 +994,7 @@

Method Details

"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling. }, "internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd. + "migrateDeploymentModel": True or False, # Indicate whether connector is being migrated to cloud run deployment model. "ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests. "resourceLimits": { # Resource limits defined for connection pods of a given connector type. # System resource limits. "cpu": "A String", # Output only. CPU limit. diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index b3502ea1674..fddc1650534 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -213,8 +213,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -224,8 +224,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -233,8 +233,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -249,12 +249,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -341,8 +341,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -396,10 +396,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -426,15 +426,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -443,15 +443,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -462,7 +462,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -471,10 +471,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -484,7 +484,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -500,7 +500,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -525,12 +525,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -752,7 +752,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -983,7 +983,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -993,8 +993,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1026,7 +1026,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1034,14 +1034,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1120,22 +1120,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. @@ -1158,8 +1158,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1169,8 +1169,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1178,8 +1178,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1194,12 +1194,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1228,8 +1228,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1239,8 +1239,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1248,8 +1248,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1264,12 +1264,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -1363,8 +1363,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -1418,10 +1418,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1448,15 +1448,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -1465,15 +1465,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -1484,7 +1484,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1493,10 +1493,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -1506,7 +1506,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -1522,7 +1522,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -1547,12 +1547,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -1774,7 +1774,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2005,7 +2005,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2015,8 +2015,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2048,7 +2048,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2056,14 +2056,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -2142,22 +2142,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }
@@ -2288,8 +2288,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -2343,10 +2343,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2373,15 +2373,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -2390,15 +2390,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -2409,7 +2409,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2418,10 +2418,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -2431,7 +2431,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -2447,7 +2447,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -2472,12 +2472,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -2699,7 +2699,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2930,7 +2930,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2940,8 +2940,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2973,7 +2973,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2981,14 +2981,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -3067,22 +3067,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3171,8 +3171,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3182,8 +3182,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3191,8 +3191,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3207,12 +3207,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3249,8 +3249,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3260,8 +3260,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3269,8 +3269,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3285,12 +3285,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3329,8 +3329,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3340,8 +3340,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3349,8 +3349,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3365,12 +3365,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3407,8 +3407,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3418,8 +3418,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3427,8 +3427,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3443,12 +3443,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }
@@ -3467,7 +3467,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -3512,8 +3512,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3523,8 +3523,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3532,8 +3532,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3548,12 +3548,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3572,12 +3572,12 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -3600,8 +3600,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3611,8 +3611,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3620,8 +3620,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3636,12 +3636,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3678,8 +3678,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3689,8 +3689,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3698,8 +3698,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3714,12 +3714,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3759,8 +3759,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3770,8 +3770,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3779,8 +3779,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3795,12 +3795,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3840,8 +3840,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3851,8 +3851,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3860,8 +3860,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3876,12 +3876,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3918,8 +3918,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3929,8 +3929,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3938,8 +3938,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3954,12 +3954,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3978,10 +3978,10 @@

Method Details

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4061,8 +4061,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -4146,8 +4146,8 @@

Method Details

"desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "desiredGatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # The desired config of Gateway API on this cluster. @@ -4322,10 +4322,10 @@

Method Details

}, "etag": "A String", # The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned. "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4352,8 +4352,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4363,8 +4363,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4372,8 +4372,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4388,12 +4388,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4430,8 +4430,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4441,8 +4441,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4450,8 +4450,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4466,12 +4466,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html index daa25d9f7c1..ea57bac531b 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.locations.clusters.nodePools.html @@ -324,7 +324,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -334,8 +334,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -367,7 +367,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -375,14 +375,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -431,8 +431,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -442,8 +442,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -451,8 +451,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -467,12 +467,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -502,8 +502,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -513,8 +513,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -522,8 +522,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -538,12 +538,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -741,7 +741,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -751,8 +751,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -784,7 +784,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -792,14 +792,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1024,7 +1024,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1034,8 +1034,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1067,7 +1067,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1075,14 +1075,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1148,8 +1148,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1159,8 +1159,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1168,8 +1168,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1184,12 +1184,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1235,8 +1235,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1246,8 +1246,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1255,8 +1255,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1271,12 +1271,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1295,8 +1295,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. @@ -1321,8 +1321,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1332,8 +1332,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1341,8 +1341,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1357,12 +1357,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1400,8 +1400,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1411,8 +1411,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1420,8 +1420,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1436,12 +1436,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1558,7 +1558,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. @@ -1629,8 +1629,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1640,8 +1640,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1649,8 +1649,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1665,12 +1665,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.locations.operations.html b/docs/dyn/container_v1.projects.locations.operations.html index 37086edd12f..6c0e4e223c7 100644 --- a/docs/dyn/container_v1.projects.locations.operations.html +++ b/docs/dyn/container_v1.projects.locations.operations.html @@ -145,8 +145,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -156,8 +156,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -165,8 +165,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -181,12 +181,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -219,8 +219,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -230,8 +230,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -239,8 +239,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -255,12 +255,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index 37702af9bb6..138ed928f8a 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -216,8 +216,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -227,8 +227,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -236,8 +236,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -252,12 +252,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -300,8 +300,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -311,8 +311,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -320,8 +320,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -336,12 +336,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -429,8 +429,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -484,10 +484,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -514,15 +514,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -531,15 +531,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -550,7 +550,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -559,10 +559,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -572,7 +572,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -588,7 +588,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -613,12 +613,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -840,7 +840,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -1071,7 +1071,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1081,8 +1081,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1114,7 +1114,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1122,14 +1122,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1208,22 +1208,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. @@ -1246,8 +1246,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1257,8 +1257,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1266,8 +1266,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1282,12 +1282,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1316,8 +1316,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1327,8 +1327,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1336,8 +1336,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1352,12 +1352,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1451,8 +1451,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -1506,10 +1506,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1536,15 +1536,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -1553,15 +1553,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -1572,7 +1572,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1581,10 +1581,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -1594,7 +1594,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -1610,7 +1610,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -1635,12 +1635,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -1862,7 +1862,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2093,7 +2093,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2103,8 +2103,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2136,7 +2136,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2144,14 +2144,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -2230,22 +2230,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. } @@ -2284,8 +2284,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -2295,8 +2295,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -2304,8 +2304,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -2320,12 +2320,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -2420,8 +2420,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -2475,10 +2475,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2505,15 +2505,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -2522,15 +2522,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -2541,7 +2541,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2550,10 +2550,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false. "stackType": "A String", # The IP stack type of the cluster - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -2563,7 +2563,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -2579,7 +2579,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -2604,12 +2604,12 @@

Method Details

}, }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -2831,7 +2831,7 @@

Method Details

"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -3062,7 +3062,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -3072,8 +3072,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -3105,7 +3105,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3113,14 +3113,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -3199,22 +3199,22 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, "workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3260,8 +3260,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3271,8 +3271,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3280,8 +3280,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3296,12 +3296,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3340,8 +3340,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3351,8 +3351,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3360,8 +3360,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3376,12 +3376,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3420,8 +3420,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3431,8 +3431,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3440,8 +3440,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3456,12 +3456,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3500,8 +3500,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3511,8 +3511,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3520,8 +3520,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3536,12 +3536,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3583,8 +3583,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3594,8 +3594,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3603,8 +3603,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3619,12 +3619,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3645,7 +3645,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS". "startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -3690,8 +3690,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3701,8 +3701,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3710,8 +3710,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3726,12 +3726,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3752,12 +3752,12 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster. + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -3780,8 +3780,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3791,8 +3791,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3800,8 +3800,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3816,12 +3816,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3863,8 +3863,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3874,8 +3874,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3883,8 +3883,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3899,12 +3899,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3943,8 +3943,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3954,8 +3954,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3963,8 +3963,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3979,12 +3979,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4005,10 +4005,10 @@

Method Details

"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4088,8 +4088,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -4173,8 +4173,8 @@

Method Details

"desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "desiredGatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # The desired config of Gateway API on this cluster. @@ -4349,10 +4349,10 @@

Method Details

}, "etag": "A String", # The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned. "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4379,8 +4379,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4390,8 +4390,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4399,8 +4399,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4415,12 +4415,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html index 228b0101ff4..f31b1d958b5 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1.projects.zones.clusters.nodePools.html @@ -150,8 +150,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -161,8 +161,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -170,8 +170,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -186,12 +186,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -389,7 +389,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -399,8 +399,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -432,7 +432,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -440,14 +440,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -496,8 +496,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -507,8 +507,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -516,8 +516,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -532,12 +532,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -567,8 +567,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -578,8 +578,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -587,8 +587,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -603,12 +603,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -806,7 +806,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -816,8 +816,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -849,7 +849,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -857,14 +857,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1089,7 +1089,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1099,8 +1099,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1132,7 +1132,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1140,14 +1140,14 @@

Method Details

"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1216,8 +1216,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1227,8 +1227,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1236,8 +1236,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1252,12 +1252,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1279,8 +1279,8 @@

Method Details

"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered. "autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. @@ -1305,8 +1305,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1316,8 +1316,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1325,8 +1325,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1341,12 +1341,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1387,8 +1387,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1398,8 +1398,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1407,8 +1407,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1423,12 +1423,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1548,7 +1548,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. @@ -1619,8 +1619,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1630,8 +1630,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1639,8 +1639,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1655,12 +1655,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1.projects.zones.operations.html b/docs/dyn/container_v1.projects.zones.operations.html index da587481a06..ba1fa70d5f9 100644 --- a/docs/dyn/container_v1.projects.zones.operations.html +++ b/docs/dyn/container_v1.projects.zones.operations.html @@ -147,8 +147,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -158,8 +158,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -167,8 +167,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -183,12 +183,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -221,8 +221,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -232,8 +232,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -241,8 +241,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -257,12 +257,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index 8330b06f737..d07e8a99e5f 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -213,8 +213,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -224,8 +224,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -233,8 +233,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -249,12 +249,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -351,8 +351,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -424,10 +424,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -454,15 +454,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -471,15 +471,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -491,7 +491,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -500,10 +500,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -513,7 +513,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -529,7 +529,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -556,12 +556,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -798,7 +798,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # 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 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -1051,7 +1051,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1061,8 +1061,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1095,7 +1095,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1103,14 +1103,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1204,20 +1204,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -1232,7 +1232,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. @@ -1255,8 +1255,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1266,8 +1266,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1275,8 +1275,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1291,12 +1291,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1325,8 +1325,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1336,8 +1336,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1345,8 +1345,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1361,12 +1361,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1470,8 +1470,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -1543,10 +1543,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1573,15 +1573,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -1590,15 +1590,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -1610,7 +1610,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1619,10 +1619,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -1632,7 +1632,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -1648,7 +1648,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -1675,12 +1675,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -1917,7 +1917,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # 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 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2170,7 +2170,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2180,8 +2180,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2214,7 +2214,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2222,14 +2222,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -2323,20 +2323,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -2351,7 +2351,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. } @@ -2492,8 +2492,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -2565,10 +2565,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2595,15 +2595,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -2612,15 +2612,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -2632,7 +2632,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2641,10 +2641,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -2654,7 +2654,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -2670,7 +2670,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -2697,12 +2697,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -2939,7 +2939,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # 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 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -3192,7 +3192,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -3202,8 +3202,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -3236,7 +3236,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3244,14 +3244,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -3345,20 +3345,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -3373,7 +3373,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3469,8 +3469,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3480,8 +3480,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3489,8 +3489,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3505,12 +3505,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3547,8 +3547,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3558,8 +3558,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3567,8 +3567,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3583,12 +3583,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3627,8 +3627,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3638,8 +3638,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3647,8 +3647,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3663,12 +3663,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3705,8 +3705,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3716,8 +3716,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3725,8 +3725,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3741,12 +3741,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3765,7 +3765,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -3810,8 +3810,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3821,8 +3821,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3830,8 +3830,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3846,12 +3846,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3870,12 +3870,12 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -3898,8 +3898,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3909,8 +3909,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3918,8 +3918,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3934,12 +3934,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3976,8 +3976,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3987,8 +3987,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3996,8 +3996,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4012,12 +4012,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4057,8 +4057,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4068,8 +4068,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4077,8 +4077,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4093,12 +4093,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4138,8 +4138,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4149,8 +4149,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4158,8 +4158,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4174,12 +4174,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4216,8 +4216,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4227,8 +4227,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4236,8 +4236,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4252,12 +4252,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4276,10 +4276,10 @@

Method Details

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4371,8 +4371,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -4461,8 +4461,8 @@

Method Details

"desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "desiredGatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # The desired config of Gateway API on this cluster. @@ -4684,10 +4684,10 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4714,8 +4714,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4725,8 +4725,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4734,8 +4734,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4750,12 +4750,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4792,8 +4792,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4803,8 +4803,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4812,8 +4812,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4828,12 +4828,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html index 0889533a1cb..d84299fdb5b 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.nodePools.html @@ -338,7 +338,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -348,8 +348,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -382,7 +382,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -390,14 +390,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -448,8 +448,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -459,8 +459,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -468,8 +468,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -484,12 +484,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -519,8 +519,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -530,8 +530,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -539,8 +539,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -555,12 +555,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -772,7 +772,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -782,8 +782,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -816,7 +816,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -824,14 +824,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1072,7 +1072,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1082,8 +1082,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1116,7 +1116,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1124,14 +1124,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1199,8 +1199,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1210,8 +1210,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1219,8 +1219,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1235,12 +1235,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1286,8 +1286,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1297,8 +1297,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1306,8 +1306,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1322,12 +1322,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1346,8 +1346,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. @@ -1372,8 +1372,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1383,8 +1383,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1392,8 +1392,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1408,12 +1408,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1451,8 +1451,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1462,8 +1462,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1471,8 +1471,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1487,12 +1487,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1611,7 +1611,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. @@ -1685,8 +1685,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1696,8 +1696,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1705,8 +1705,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1721,12 +1721,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.locations.operations.html b/docs/dyn/container_v1beta1.projects.locations.operations.html index c1fbe846fab..3aff4a47316 100644 --- a/docs/dyn/container_v1beta1.projects.locations.operations.html +++ b/docs/dyn/container_v1beta1.projects.locations.operations.html @@ -145,8 +145,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -156,8 +156,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -165,8 +165,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -181,12 +181,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -219,8 +219,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -230,8 +230,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -239,8 +239,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -255,12 +255,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 04e76c331ee..3fe4f478c1d 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -223,8 +223,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -234,8 +234,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -243,8 +243,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -259,12 +259,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -307,8 +307,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -318,8 +318,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -327,8 +327,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -343,12 +343,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -446,8 +446,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -519,10 +519,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -549,15 +549,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -566,15 +566,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -586,7 +586,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -595,10 +595,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -608,7 +608,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -624,7 +624,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -651,12 +651,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -893,7 +893,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # 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 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -1146,7 +1146,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1156,8 +1156,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1190,7 +1190,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1198,14 +1198,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1299,20 +1299,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -1327,7 +1327,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, "parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. @@ -1350,8 +1350,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1361,8 +1361,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1370,8 +1370,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1386,12 +1386,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1420,8 +1420,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1431,8 +1431,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1440,8 +1440,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1456,12 +1456,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1565,8 +1565,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -1638,10 +1638,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -1668,15 +1668,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -1685,15 +1685,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -1705,7 +1705,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -1714,10 +1714,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -1727,7 +1727,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -1743,7 +1743,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -1770,12 +1770,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -2012,7 +2012,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # 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 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -2265,7 +2265,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -2275,8 +2275,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -2309,7 +2309,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -2317,14 +2317,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -2418,20 +2418,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -2446,7 +2446,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. } @@ -2485,8 +2485,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -2496,8 +2496,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -2505,8 +2505,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -2521,12 +2521,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -2631,8 +2631,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -2704,10 +2704,10 @@

Method Details

"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. "enabled": True or False, # Whether the feature is enabled or not. }, - "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint. - "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. - "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. + "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint. + "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. + "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes. "databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. "currentState": "A String", # Output only. The current state of etcd encryption. "decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource. @@ -2734,15 +2734,15 @@

Method Details

}, "enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation. "enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead. - "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. + "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information. "enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration. - "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster. + "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster. }, "etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. - "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "id": "A String", # Output only. Unique id for the cluster. @@ -2751,15 +2751,15 @@

Method Details

}, "initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version "initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead. - "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls. + "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls. "A String", ], "ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation. - "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -2771,7 +2771,7 @@

Method Details

"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. "clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true. - "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true "nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block. "nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. @@ -2780,10 +2780,10 @@

Method Details

}, "servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block. "servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. - "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster. + "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster. "servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases and create_subnetwork is false. "stackType": "A String", # IP stack type - "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods. + "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods. "subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork. "tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use. This field is deprecated, use cluster.tpu_config.ipv4_cidr_block instead. "useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode @@ -2793,7 +2793,7 @@

Method Details

"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode. "enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed. "A String", ], @@ -2809,7 +2809,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -2836,12 +2836,12 @@

Method Details

"master": { # Master is the configuration for components on master. # Configuration for master components. }, "masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -3078,7 +3078,7 @@

Method Details

"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node. }, }, - "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. + "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode. "nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. "networkTags": { # 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 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 creation. Each tag within the list must comply with RFC1035. "tags": [ # List of network tags. @@ -3331,7 +3331,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -3341,8 +3341,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -3375,7 +3375,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -3383,14 +3383,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -3484,20 +3484,20 @@

Method Details

"mode": "A String", # Sets which mode to use for Security Posture features. "vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR. "shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration. "enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster. }, - "status": "A String", # [Output only] The current status of this cluster. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. + "status": "A String", # Output only. The current status of this cluster. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. "subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name. "tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support; "enabled": True or False, # Whether Cloud TPU integration is enabled or not. "ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC. "useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not. }, - "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). + "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). "verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration. "enabled": True or False, # Enables vertical pod autoscaling. }, @@ -3512,7 +3512,7 @@

Method Details

"identityProvider": "A String", # identity provider is the third party identity provider. "workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to. }, - "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead. }, ], "missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones. @@ -3558,8 +3558,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3569,8 +3569,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3578,8 +3578,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3594,12 +3594,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3638,8 +3638,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3649,8 +3649,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3658,8 +3658,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3674,12 +3674,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3718,8 +3718,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3729,8 +3729,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3738,8 +3738,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3754,12 +3754,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3798,8 +3798,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3809,8 +3809,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3818,8 +3818,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3834,12 +3834,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3881,8 +3881,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3892,8 +3892,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -3901,8 +3901,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -3917,12 +3917,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -3943,7 +3943,7 @@

Method Details

"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy. "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed. "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window. - "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. + "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT. }, "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. @@ -3988,8 +3988,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -3999,8 +3999,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4008,8 +4008,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4024,12 +4024,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4050,12 +4050,12 @@

Method Details

"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`. "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update. - "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. + "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. "issueClientCertificate": True or False, # Issue a client certificate. }, - "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint. - "clusterCaCertificate": "A String", + "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. + "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster. "password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication "username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication }, @@ -4078,8 +4078,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4089,8 +4089,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4098,8 +4098,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4114,12 +4114,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4161,8 +4161,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4172,8 +4172,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4181,8 +4181,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4197,12 +4197,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4241,8 +4241,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4252,8 +4252,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4261,8 +4261,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4277,12 +4277,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -4303,10 +4303,10 @@

Method Details

"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. "update": { # ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided. # Required. A description of the update. "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4398,8 +4398,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value. @@ -4488,8 +4488,8 @@

Method Details

"desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster "desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. "desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster. - "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. - "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API. + "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`. + "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API. "project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered. }, "desiredGatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # The desired config of Gateway API on this cluster. @@ -4711,10 +4711,10 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. }, "removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument. - "podRangeInfo": [ # Output only. [Output only] Information for additional pod range. + "podRangeInfo": [ # Output only. Information for additional pod range. { # RangeInfo contains the range name and the range utilization by this cluster. - "rangeName": "A String", # Output only. [Output only] Name of a range. - "utilization": 3.14, # Output only. [Output only] The utilization of the range. + "rangeName": "A String", # Output only. Name of a range. + "utilization": 3.14, # Output only. The utilization of the range. }, ], "podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead. @@ -4741,8 +4741,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -4752,8 +4752,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -4761,8 +4761,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -4777,12 +4777,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html index ad25f5b6d22..f4436a1ca2c 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.nodePools.html @@ -150,8 +150,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -161,8 +161,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -170,8 +170,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -186,12 +186,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -403,7 +403,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -413,8 +413,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -447,7 +447,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -455,14 +455,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -513,8 +513,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -524,8 +524,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -533,8 +533,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -549,12 +549,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -584,8 +584,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -595,8 +595,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -604,8 +604,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -620,12 +620,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -837,7 +837,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -847,8 +847,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -881,7 +881,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -889,14 +889,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1137,7 +1137,7 @@

Method Details

}, "etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding. "initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. - "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. + "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources. "A String", ], "locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. @@ -1147,8 +1147,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool. @@ -1181,7 +1181,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy. @@ -1189,14 +1189,14 @@

Method Details

"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies "type": "A String", # The type of placement. }, - "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool. + "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool. "queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning. "enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API. }, - "selfLink": "A String", # [Output only] Server-defined URL for the resource. - "status": "A String", # [Output only] The status of the nodes in this pool instance. - "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. - "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update. + "selfLink": "A String", # Output only. Server-defined URL for the resource. + "status": "A String", # Output only. The status of the nodes in this pool instance. + "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. + "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update. "blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade. "blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool. "A String", @@ -1267,8 +1267,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1278,8 +1278,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1287,8 +1287,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1303,12 +1303,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1330,8 +1330,8 @@

Method Details

"autoRepair": True or False, # Whether the nodes will be automatically repaired. "autoUpgrade": True or False, # Whether the nodes will be automatically upgraded. "upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool. - "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade. + "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade. }, }, "name": "A String", # The name (project, location, cluster, node pool id) of the node pool to set management properties. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`. @@ -1356,8 +1356,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1367,8 +1367,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1376,8 +1376,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1392,12 +1392,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1438,8 +1438,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1449,8 +1449,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1458,8 +1458,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1474,12 +1474,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -1601,7 +1601,7 @@

Method Details

"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default. }, "podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. - "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. + "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode. "podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created. }, "nodePoolId": "A String", # Required. Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. @@ -1675,8 +1675,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -1686,8 +1686,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -1695,8 +1695,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -1711,12 +1711,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } diff --git a/docs/dyn/container_v1beta1.projects.zones.operations.html b/docs/dyn/container_v1beta1.projects.zones.operations.html index d5197b70b4f..15b6c861abb 100644 --- a/docs/dyn/container_v1beta1.projects.zones.operations.html +++ b/docs/dyn/container_v1beta1.projects.zones.operations.html @@ -147,8 +147,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -158,8 +158,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -167,8 +167,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -183,12 +183,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. } @@ -221,8 +221,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "detail": "A String", # Detailed operation progress, if available. - "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "detail": "A String", # Output only. Detailed operation progress, if available. + "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. "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. "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. @@ -232,8 +232,8 @@

Method Details

], "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. }, - "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. - "name": "A String", # The server-assigned ID for the operation. + "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides. + "name": "A String", # Output only. The server-assigned ID for the operation. "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead. { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED). "canonicalCode": "A String", # Canonical code of the condition. @@ -241,8 +241,8 @@

Method Details

"message": "A String", # Human-friendly representation of the condition }, ], - "operationType": "A String", # The operation type. - "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation. + "operationType": "A String", # Output only. The operation type. + "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation. "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}] { # Progress metric is (string, int|float|string) pair. "doubleValue": 3.14, # For metrics with floating point value. @@ -257,12 +257,12 @@

Method Details

], "status": "A String", # Status of an operation stage. Unset for single-stage operations. }, - "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. - "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. - "status": "A String", # The current status of the operation. + "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`. + "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. + "status": "A String", # Output only. The current status of the operation. "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead. - "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` - "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. + "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node` + "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead. }, ], } diff --git a/docs/dyn/content_v2_1.products.html b/docs/dyn/content_v2_1.products.html index 8a6d0ad90d6..4da57c62e1d 100644 --- a/docs/dyn/content_v2_1.products.html +++ b/docs/dyn/content_v2_1.products.html @@ -247,6 +247,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -261,6 +262,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -368,7 +370,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -567,6 +569,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -581,6 +584,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -688,7 +692,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -893,6 +897,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -907,6 +912,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1014,7 +1020,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -1194,6 +1200,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1208,6 +1215,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1315,7 +1323,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -1494,6 +1502,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1508,6 +1517,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1615,7 +1625,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -1806,6 +1816,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1820,6 +1831,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -1927,7 +1939,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -2124,6 +2136,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -2138,6 +2151,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -2245,7 +2259,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" @@ -2424,6 +2438,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -2438,6 +2453,7 @@

Method Details

"value": "A String", # The price represented as a number. }, "loyaltyPoints": "A String", # Optional. The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": "A String", # Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. "price": { # Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price. "currency": "A String", # The currency of the price. "value": "A String", # The price represented as a number. @@ -2545,7 +2561,7 @@

Method Details

"sizes": [ # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see size definition). "A String", ], - "source": "A String", # The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" + "source": "A String", # Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - "`api`" - "`crawl`" - "`feed`" "structuredDescription": { # Structured description, for algorithmically (AI)-generated descriptions. See [description](https://support.google.com/merchants/answer/6324468#When_to_use) for more information. # Structured description, for algorithmically (AI)-generated descriptions. "content": "A String", # Required. The description text. Maximum length is 5000 characters. "digitalSourceType": "A String", # Optional. The digital source type. Acceptable values are: - "`trained_algorithmic_media`" - "`default`" diff --git a/docs/dyn/css_v1.accounts.cssProductInputs.html b/docs/dyn/css_v1.accounts.cssProductInputs.html index a4eb2da60a5..0135c320fd3 100644 --- a/docs/dyn/css_v1.accounts.cssProductInputs.html +++ b/docs/dyn/css_v1.accounts.cssProductInputs.html @@ -126,10 +126,10 @@

Method Details

"ageGroup": "A String", # Target age group of the item. "brand": "A String", # Product Related Attributes.[14-36] Brand of the item. "certifications": [ # A list of certificates claimed by the CSS for the given product. - { # The certification for the product. - "authority": "A String", # Name of the certification body. - "code": "A String", # A unique code to identify the certification. - "name": "A String", # Name of the certification. + { # The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product. + "authority": "A String", # The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU. + "code": "A String", # The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. + "name": "A String", # The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. }, ], "color": "A String", # Color of the item. @@ -251,10 +251,10 @@

Method Details

"ageGroup": "A String", # Target age group of the item. "brand": "A String", # Product Related Attributes.[14-36] Brand of the item. "certifications": [ # A list of certificates claimed by the CSS for the given product. - { # The certification for the product. - "authority": "A String", # Name of the certification body. - "code": "A String", # A unique code to identify the certification. - "name": "A String", # Name of the certification. + { # The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product. + "authority": "A String", # The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU. + "code": "A String", # The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. + "name": "A String", # The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. }, ], "color": "A String", # Color of the item. diff --git a/docs/dyn/css_v1.accounts.cssProducts.html b/docs/dyn/css_v1.accounts.cssProducts.html index a6a59944490..261fb3bad69 100644 --- a/docs/dyn/css_v1.accounts.cssProducts.html +++ b/docs/dyn/css_v1.accounts.cssProducts.html @@ -115,10 +115,10 @@

Method Details

"ageGroup": "A String", # Target age group of the item. "brand": "A String", # Product Related Attributes.[14-36] Brand of the item. "certifications": [ # A list of certificates claimed by the CSS for the given product. - { # The certification for the product. - "authority": "A String", # Name of the certification body. - "code": "A String", # A unique code to identify the certification. - "name": "A String", # Name of the certification. + { # The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product. + "authority": "A String", # The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU. + "code": "A String", # The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. + "name": "A String", # The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. }, ], "color": "A String", # Color of the item. @@ -282,10 +282,10 @@

Method Details

"ageGroup": "A String", # Target age group of the item. "brand": "A String", # Product Related Attributes.[14-36] Brand of the item. "certifications": [ # A list of certificates claimed by the CSS for the given product. - { # The certification for the product. - "authority": "A String", # Name of the certification body. - "code": "A String", # A unique code to identify the certification. - "name": "A String", # Name of the certification. + { # The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product. + "authority": "A String", # The authority or certification body responsible for issuing the certification. At this time, the most common value is "EC" or “European_Commission” for energy labels in the EU. + "code": "A String", # The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels. + "name": "A String", # The name of the certification. At this time, the most common value is "EPREL", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database. }, ], "color": "A String", # Color of the item. diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index 26259690bbb..ebd80c14a4d 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -117,7 +117,7 @@

Method Details

}, }, "audioInput": { # Represents the natural language speech audio to be processed. # The natural language speech audio to be processed. - "audio": "A String", # Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. + "audio": "A String", # Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the start of the input audio. The flow goes like below: ``` --> Time without speech detection | utterance only | utterance or no-speech event | | +-------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ ``` No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio. diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index e8bec902700..df5b76d5f57 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -117,7 +117,7 @@

Method Details

}, }, "audioInput": { # Represents the natural language speech audio to be processed. # The natural language speech audio to be processed. - "audio": "A String", # Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. + "audio": "A String", # Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions. "config": { # Instructs the speech recognizer on how to process the audio content. # Required. Instructs the speech recognizer how to process the speech audio. "audioEncoding": "A String", # Required. Audio encoding of the audio content to process. "bargeInConfig": { # Configuration of the barge-in behavior. Barge-in instructs the API to return a detected utterance at a proper time while the client is playing back the response audio from a previous request. When the client sees the utterance, it should stop the playback and immediately get ready for receiving the responses for the current request. The barge-in handling requires the client to start streaming audio input as soon as it starts playing back the audio from the previous response. The playback is modeled into two phases: * No barge-in phase: which goes first and during which speech detection should not be carried out. * Barge-in phase: which follows the no barge-in phase and during which the API starts speech detection and may inform the client that an utterance has been detected. Note that no-speech event is not expected in this phase. The client provides this configuration in terms of the durations of those two phases. The durations are measured in terms of the audio length from the start of the input audio. The flow goes like below: ``` --> Time without speech detection | utterance only | utterance or no-speech event | | +-------------+ | +------------+ | +---------------+ ----------+ no barge-in +-|-+ barge-in +-|-+ normal period +----------- +-------------+ | +------------+ | +---------------+ ``` No-speech event is a response with END_OF_UTTERANCE without any transcript following up. # Configuration of barge-in behavior during the streaming of input audio. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html index 1902cb81a80..c6a82e54163 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.servingConfigs.html @@ -153,7 +153,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -205,7 +205,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -289,7 +289,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -505,7 +505,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html index dee378f44c7..a89732a9410 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html index c1e3772091c..dc6f44acd26 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.servingConfigs.html @@ -153,7 +153,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -205,7 +205,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -289,7 +289,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -505,7 +505,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html index ed3327f930e..3759f97e32e 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html index 26cdb02fa76..170838df867 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.servingConfigs.html @@ -153,7 +153,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -205,7 +205,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -289,7 +289,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -505,7 +505,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html index 1a446a88b92..0e4661a208d 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1.projects.locations.html b/docs/dyn/discoveryengine_v1.projects.locations.html index 8396d5bdb2a..4631def3024 100644 --- a/docs/dyn/discoveryengine_v1.projects.locations.html +++ b/docs/dyn/discoveryengine_v1.projects.locations.html @@ -89,6 +89,11 @@

Instance Methods

Returns the groundingConfigs Resource.

+

+ identity_mapping_stores() +

+

Returns the identity_mapping_stores Resource.

+

operations()

diff --git a/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html b/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html new file mode 100644 index 00000000000..2aebaab5a22 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . projects . locations . identity_mapping_stores

+

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.collections.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html index cf6235dad8b..07787261a60 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.servingConfigs.html @@ -179,7 +179,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -231,7 +231,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -315,7 +315,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -405,7 +405,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -512,7 +512,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -625,7 +625,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -721,7 +721,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -972,7 +972,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1049,7 +1049,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1072,6 +1072,7 @@

Method Details

"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. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html index 9c715ecdad6..cb0e428c6c8 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html index 92717248ea3..e19dee476ac 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.siteSearchEngine.html @@ -102,9 +102,15 @@

Instance Methods

fetchDomainVerificationStatus_next()

Retrieves the next page of results.

+

+ getUriPatternDocumentData(siteSearchEngine, x__xgafv=None)

+

Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.

recrawlUris(siteSearchEngine, body=None, x__xgafv=None)

Request on-demand recrawl for a list of URIs.

+

+ setUriPatternDocumentData(siteSearchEngine, body=None, x__xgafv=None)

+

Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.

Method Details

batchVerifyTargetSites(parent, body=None, x__xgafv=None) @@ -291,6 +297,29 @@

Method Details

+
+ getUriPatternDocumentData(siteSearchEngine, x__xgafv=None) +
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
+
+Args:
+  siteSearchEngine: string, Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (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 SiteSearchEngineService.GetUriPatternDocumentData method.
+  "documentDataMap": { # Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
+    "a_key": {
+      "a_key": "", # Properties of the object.
+    },
+  },
+}
+
+
recrawlUris(siteSearchEngine, body=None, x__xgafv=None)
Request on-demand recrawl for a list of URIs.
@@ -335,4 +364,54 @@ 

Method Details

}
+
+ setUriPatternDocumentData(siteSearchEngine, body=None, x__xgafv=None) +
Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
+
+Args:
+  siteSearchEngine: string, Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SiteSearchEngineService.SetUriPatternDocumentData method.
+  "documentDataMap": { # Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" } } } document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
+    "a_key": {
+      "a_key": "", # Properties of the object.
+    },
+  },
+  "emptyDocumentDataMap": True or False, # If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.
+  "schema": { # Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html index fca18948394..3106e8aca61 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.servingConfigs.html @@ -179,7 +179,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -231,7 +231,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -315,7 +315,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -405,7 +405,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -512,7 +512,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -625,7 +625,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -721,7 +721,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -972,7 +972,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1049,7 +1049,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1072,6 +1072,7 @@

Method Details

"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. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html index 19d73e2fc45..7a4c93028cd 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html index c321c594903..b71e82b412e 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.servingConfigs.html @@ -179,7 +179,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -231,7 +231,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -315,7 +315,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -405,7 +405,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -512,7 +512,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -625,7 +625,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -721,7 +721,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -972,7 +972,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -1049,7 +1049,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1072,6 +1072,7 @@

Method Details

"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. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html index 8e9fe4835bc..5bdbc0a1587 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html index 4fd237b35d4..d3f9e0c86f9 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.evaluations.html @@ -82,10 +82,852 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.

+

+ get(name, x__xgafv=None)

+

Gets a Evaluation.

+

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

+

Gets a list of Evaluations.

+

+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of results for a given a Evaluation.

+

+ listResults_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "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.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # 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).
+      "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.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
+        "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model.
+      },
+      "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+        { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+      },
+      "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.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+      "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+        "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+        "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a Evaluation.
+
+Args:
+  name: string, Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "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.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # 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).
+      "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.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
+        "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model.
+      },
+      "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+        { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+      },
+      "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.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+      "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+        "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+        "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of Evaluations.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  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 EvaluationService.ListEvaluations method.
+  "evaluations": [ # The Evaluations.
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+      "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+      "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+        "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.
+      },
+      "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+        { # 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).
+          "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.
+        },
+      ],
+      "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+        "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+          "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        },
+        "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+          "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+            "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+              { # Boost applies to documents which match a condition.
+                "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+                "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+                  "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+                  "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                    { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                      "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                      "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                    },
+                  ],
+                  "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+                  "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+                },
+                "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+              },
+            ],
+          },
+          "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+          "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+          "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+            "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+              "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+              "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+            },
+            "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+              "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+              "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+              "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+              "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+              "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+            },
+            "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+            "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+              "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+              "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+              "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+            },
+            "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+              "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+              "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+              "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+              "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+              "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+                "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+              },
+              "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+                "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+              },
+              "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+              "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+            },
+          },
+          "customFineTuningSpec": { # Defines custom fine tuning spec. # Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec.
+            "enableSearchAdaptor": True or False, # Whether or not to enable and include custom fine tuned search adaptor model.
+          },
+          "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+            { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+              "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+            },
+          ],
+          "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+            "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+              { # Embedding vector.
+                "fieldPath": "A String", # Embedding field path in schema.
+                "vector": [ # Query embedding vector.
+                  3.14,
+                ],
+              },
+            ],
+          },
+          "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            { # A facet specification to perform faceted search.
+              "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+              "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+                "A String",
+              ],
+              "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+                "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+                "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+                  { # A floating point interval.
+                    "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                    "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                    "maximum": 3.14, # Inclusive upper bound.
+                    "minimum": 3.14, # Inclusive lower bound.
+                  },
+                ],
+                "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+                "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+                "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+              },
+              "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+            },
+          ],
+          "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+          "imageQuery": { # Specifies the image query input. # Raw image query.
+            "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+          },
+          "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+          "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+            "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+            "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+              "A String",
+            ],
+          },
+          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+          "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+            "a_key": "",
+          },
+          "query": "A String", # Raw search query.
+          "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+            "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+            "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+          },
+          "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.
+          },
+          "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+          "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+          "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+            "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+            "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+          },
+          "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+            "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+          },
+          "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+            "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+            "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          },
+          "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+            "a_key": "A String",
+          },
+          "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        },
+      },
+      "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "state": "A String", # Output only. The state of the evaluation.
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of results for a given a Evaluation.
+
+Args:
+  evaluation: string, Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  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 EvaluationService.ListEvaluationResults method.
+  "evaluationResults": [ # The EvaluationResults.
+    { # Represents the results of an evaluation for a single SampleQuery.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, for a given SampleQuery.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "sampleQuery": { # Sample Query captures metadata to be used for evaluation. # Output only. The SampleQuery that was evaluated.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults_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.
+
+        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_v1alpha.projects.locations.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.html index 7631051a91a..c07864082b1 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.html @@ -94,6 +94,11 @@

Instance Methods

Returns the groundingConfigs Resource.

+

+ identity_mapping_stores() +

+

Returns the identity_mapping_stores Resource.

+

operations()

diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html new file mode 100644 index 00000000000..ed188bb7977 --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.identity_mapping_stores.html @@ -0,0 +1,91 @@ + + + +

Discovery Engine API . projects . locations . identity_mapping_stores

+

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.sampleQuerySets.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html index b7f1eb3e676..18abd8ea1bb 100644 --- a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.html @@ -79,13 +79,185 @@

Instance Methods

Returns the operations Resource.

+

+ sampleQueries() +

+

Returns the sampleQueries Resource.

+

close()

Close httplib2 connections.

+

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

+

Creates a SampleQuerySet

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuerySet.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuerySet.

+

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

+

Gets a list of SampleQuerySets.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a SampleQuerySet.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None) +
Creates a SampleQuerySet
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  sampleQuerySetId: string, Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of SampleQuerySets.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  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 SampleQuerySetService.ListSampleQuerySets method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQuerySets": [ # The SampleQuerySets.
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+      "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+      "description": "A String", # The description of the SampleQuerySet.
+      "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+      "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a SampleQuerySet.
+
+Args:
+  name: string, Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html new file mode 100644 index 00000000000..3dfea63cd8c --- /dev/null +++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.sampleQuerySets.sampleQueries.html @@ -0,0 +1,398 @@ + + + +

Discovery Engine API . projects . locations . sampleQuerySets . sampleQueries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a SampleQuery

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuery.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuery.

+

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

+

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.

+

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

+

Gets a list of SampleQuerys.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a SampleQuery.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, sampleQueryId=None, x__xgafv=None) +
Creates a SampleQuery
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  sampleQueryId: string, Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ import_(parent, body=None, x__xgafv=None) +
Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SampleQueryService.ImportSampleQueries method.
+  "bigquerySource": { # BigQuery source import data from. # BigQuery input source.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
+    "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
+    "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
+    "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
+    "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
+  },
+  "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import.
+    "gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+  },
+  "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+    "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+      "A String",
+    ],
+  },
+  "inlineSource": { # The inline source for SampleQuerys. # The Inline source for sample query entries.
+    "sampleQueries": [ # Required. A list of SampleQuerys to import. Max of 1000 items.
+      { # Sample Query captures metadata to be used for evaluation.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of SampleQuerys.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  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 SampleQueryService.ListSampleQueries method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQueries": [ # The SampleQuerys.
+    { # Sample Query captures metadata to be used for evaluation.
+      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+      "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+        "query": "A String", # Required. The query.
+        "targets": [ # List of targets for the query.
+          { # Defines the parameters of the query's expected outcome.
+            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+              42,
+            ],
+            "score": 3.14, # Relevance score of the target.
+            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+          },
+        ],
+      },
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a SampleQuery.
+
+Args:
+  name: string, Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ + \ No newline at end of file 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 f97b75bd12f..1dbddaff8f0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.servingConfigs.html @@ -176,7 +176,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -228,7 +228,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -312,7 +312,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -399,7 +399,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -498,7 +498,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -603,7 +603,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -691,7 +691,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -925,7 +925,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -999,7 +999,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1021,6 +1021,7 @@

Method Details

"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. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html index 6512be89516..b9de6a69fc2 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. 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 4853e21a08e..2918dad648b 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.servingConfigs.html @@ -176,7 +176,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -228,7 +228,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -312,7 +312,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -399,7 +399,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -498,7 +498,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -603,7 +603,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -691,7 +691,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -925,7 +925,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -999,7 +999,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1021,6 +1021,7 @@

Method Details

"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. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html index 82932881d2b..50026fc8d25 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html index fab6652d4c3..5cba7a9d3a0 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.servingConfigs.html @@ -176,7 +176,7 @@

Method Details

"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the Answer response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customers might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) "maxReturnResults": 42, # Number of search results to return. The default value is 10. "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents) }, "searchResultList": { # Search result list. # Search result list. "searchResults": [ # Search results. @@ -228,7 +228,7 @@

Method Details

An object of the form: { # Response message for ConversationalSearchService.AnswerQuery method. - "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. + "answer": { # Defines an answer. # Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. "answerSkippedReasons": [ # Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. "A String", ], @@ -312,7 +312,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. @@ -399,7 +399,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -498,7 +498,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -603,7 +603,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -691,7 +691,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -925,7 +925,7 @@

Method Details

"numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments. "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`. }, - "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. + "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response. "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0. "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet. @@ -999,7 +999,7 @@

Method Details

"languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate. "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done. "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED. - "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names. + "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names. "A String", ], }, @@ -1021,6 +1021,7 @@

Method Details

"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. }, + "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set. "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html index 443ff931a9b..240338cfb05 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.answers.html @@ -184,7 +184,7 @@

Method Details

"snippetStatus": "A String", # Status of the snippet defined by the search team. }, ], - "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL). + "structData": { # Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result . "a_key": "", # Properties of the object. }, "title": "A String", # Title. diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html index 7df82cad4d0..a538e2d2304 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.evaluations.html @@ -82,10 +82,840 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.

+

+ get(name, x__xgafv=None)

+

Gets a Evaluation.

+

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

+

Gets a list of Evaluations.

+

+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None)

+

Gets a list of results for a given a Evaluation.

+

+ listResults_next()

+

Retrieves the next page of results.

+

+ list_next()

+

Retrieves the next page of results.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None) +
Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "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.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # 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).
+      "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.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+        { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+      },
+      "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.
+      "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.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+      "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+        "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+        "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a Evaluation.
+
+Args:
+  name: string, Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+  "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+  "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+    "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.
+  },
+  "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+    { # 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).
+      "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.
+    },
+  ],
+  "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+    "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+      "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+    },
+    "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+      "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+        "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+          { # Boost applies to documents which match a condition.
+            "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+            "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+              "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+              "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                  "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                  "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                },
+              ],
+              "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+              "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+            },
+            "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+          },
+        ],
+      },
+      "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+      "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+      "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+        "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+          "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+          "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+        },
+        "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+          "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+          "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+          "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+          "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+          "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+        },
+        "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+        "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+          "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+          "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+          "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+        },
+        "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+          "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+          "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+          "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+          "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+          "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+            "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+          },
+          "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+            "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+          },
+          "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+          "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+        },
+      },
+      "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+        { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+        },
+      ],
+      "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+        "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+          { # Embedding vector.
+            "fieldPath": "A String", # Embedding field path in schema.
+            "vector": [ # Query embedding vector.
+              3.14,
+            ],
+          },
+        ],
+      },
+      "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        { # A facet specification to perform faceted search.
+          "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+          "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            "A String",
+          ],
+          "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+            "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+            "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+              { # A floating point interval.
+                "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                "maximum": 3.14, # Inclusive upper bound.
+                "minimum": 3.14, # Inclusive lower bound.
+              },
+            ],
+            "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+            "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+            "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+            "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+              "A String",
+            ],
+          },
+          "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+        },
+      ],
+      "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+      "imageQuery": { # Specifies the image query input. # Raw image query.
+        "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+      },
+      "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+      "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+        "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+        "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+          "A String",
+        ],
+      },
+      "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+      "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+      "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+        "a_key": "",
+      },
+      "query": "A String", # Raw search query.
+      "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+        "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+        "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+      },
+      "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.
+      "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.
+      },
+      "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+      "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+      "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+        "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+        "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+      },
+      "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+        "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+      },
+      "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+        "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+        "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+      },
+      "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+        "a_key": "A String",
+      },
+      "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+    },
+  },
+  "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+    "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+    "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+      "top1": 3.14, # The top-1 value.
+      "top10": 3.14, # The top-10 value.
+      "top3": 3.14, # The top-3 value.
+      "top5": 3.14, # The top-5 value.
+    },
+  },
+  "state": "A String", # Output only. The state of the evaluation.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of Evaluations.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  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 EvaluationService.ListEvaluations method.
+  "evaluations": [ # The Evaluations.
+    { # An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.
+      "createTime": "A String", # Output only. Timestamp the Evaluation was created at.
+      "endTime": "A String", # Output only. Timestamp the Evaluation was completed at.
+      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.
+        "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.
+      },
+      "errorSamples": [ # Output only. A sample of errors encountered while processing the request.
+        { # 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).
+          "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.
+        },
+      ],
+      "evaluationSpec": { # Describes the specification of the evaluation. # Required. The specification of the evaluation.
+        "querySetSpec": { # Describes the specification of the query set. # Required. The specification of the query set.
+          "sampleQuerySet": "A String", # Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
+        },
+        "searchRequest": { # Request message for SearchService.Search method. # Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id
+          "boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
+            "conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
+              { # Boost applies to documents which match a condition.
+                "boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.
+                "boostControlSpec": { # Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above. # Complex specification for custom ranking based on customer defined attribute value.
+                  "attributeType": "A String", # The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).
+                  "controlPoints": [ # The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.
+                    { # The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).
+                      "attributeValue": "A String", # Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.
+                      "boostAmount": 3.14, # The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.
+                    },
+                  ],
+                  "fieldName": "A String", # The name of the field whose value will be used to determine the boost amount.
+                  "interpolationType": "A String", # The interpolation type to be applied to connect the control points listed below.
+                },
+                "condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": `(document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))`
+              },
+            ],
+          },
+          "branch": "A String", # The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
+          "canonicalFilter": "A String", # The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.
+          "contentSearchSpec": { # A specification for configuring the behavior of content search. # A specification for configuring the behavior of content search.
+            "chunkSpec": { # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS # Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS
+              "numNextChunks": 42, # The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.
+              "numPreviousChunks": 42, # The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.
+            },
+            "extractiveContentSpec": { # A specification for configuring the extractive content in a search response. # If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
+              "maxExtractiveAnswerCount": 42, # The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.
+              "maxExtractiveSegmentCount": 42, # The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
+              "numNextSegments": 42, # Return at most `num_next_segments` segments after each selected segments.
+              "numPreviousSegments": 42, # Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
+              "returnExtractiveSegmentScore": True or False, # Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
+            },
+            "searchResultMode": "A String", # Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.
+            "snippetSpec": { # A specification for configuring snippets in a search response. # If `snippetSpec` is not specified, snippets are not included in the search response.
+              "maxSnippetCount": 42, # [DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.
+              "referenceOnly": True or False, # [DEPRECATED] This field is deprecated and will have no affect on the snippet.
+              "returnSnippet": True or False, # If `true`, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.
+            },
+            "summarySpec": { # A specification for configuring a summary returned in a search response. # If `summarySpec` is not specified, summaries are not included in the search response.
+              "ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
+              "ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
+              "includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
+              "languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
+              "modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
+                "preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
+              },
+              "modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
+                "version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).
+              },
+              "summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
+              "useSemanticChunks": True or False, # If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.
+            },
+          },
+          "dataStoreSpecs": [ # Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.
+            { # A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.
+              "dataStore": "A String", # Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
+            },
+          ],
+          "embeddingSpec": { # The specification that uses customized query embedding vector to do semantic document retrieval. # Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path.
+            "embeddingVectors": [ # The embedding vector used for retrieval. Limit to 1.
+              { # Embedding vector.
+                "fieldPath": "A String", # Embedding field path in schema.
+                "vector": [ # Query embedding vector.
+                  3.14,
+                ],
+              },
+            ],
+          },
+          "facetSpecs": [ # Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+            { # A facet specification to perform faceted search.
+              "enableDynamicPosition": True or False, # Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * "rating", enable_dynamic_position = true * "price", enable_dynamic_position = false * "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.
+              "excludedFilterKeys": [ # List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as FacetKey.key would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
+                "A String",
+              ],
+              "facetKey": { # Specifies how a facet is computed. # Required. The facet key specification.
+                "caseInsensitive": True or False, # True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
+                "contains": [ # Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "intervals": [ # Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
+                  { # A floating point interval.
+                    "exclusiveMaximum": 3.14, # Exclusive upper bound.
+                    "exclusiveMinimum": 3.14, # Exclusive lower bound.
+                    "maximum": 3.14, # Inclusive upper bound.
+                    "minimum": 3.14, # Inclusive lower bound.
+                  },
+                ],
+                "key": "A String", # Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.
+                "orderBy": "A String", # The order in which documents are returned. Allowed values are: * "count desc", which means order by SearchResponse.Facet.values.count descending. * "value desc", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.
+                "prefixes": [ # Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+                "restrictedValues": [ # Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
+                  "A String",
+                ],
+              },
+              "limit": 42, # Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is "healthcare_aggregation_key", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.
+            },
+          ],
+          "filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
+          "imageQuery": { # Specifies the image query input. # Raw image query.
+            "imageBytes": "A String", # Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.
+          },
+          "languageCode": "A String", # The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.
+          "naturalLanguageQueryUnderstandingSpec": { # Specification to enable natural language understanding capabilities for search requests. # If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done.
+            "filterExtractionCondition": "A String", # The condition under which filter extraction should occur. Default to Condition.DISABLED.
+            "geoSearchQueryDetectionFieldNames": [ # Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.
+              "A String",
+            ],
+          },
+          "offset": 42, # A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "orderBy": "A String", # The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
+          "pageSize": 42, # Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
+          "pageToken": "A String", # A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          "params": { # Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`
+            "a_key": "",
+          },
+          "query": "A String", # Raw search query.
+          "queryExpansionSpec": { # Specification to determine under which conditions query expansion should occur. # The query expansion specification that specifies the conditions under which query expansion occurs.
+            "condition": "A String", # The condition under which query expansion should occur. Default to Condition.DISABLED.
+            "pinUnexpandedResults": True or False, # Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.
+          },
+          "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.
+          "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.
+          },
+          "servingConfig": "A String", # Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
+          "session": "A String", # The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.
+          "sessionSpec": { # Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. # Session specification. Can be used only when `session` is set.
+            "queryId": "A String", # If set, the search result gets stored to the "turn" specified by this query ID. Example: Let's say the session looks like this: session { name: ".../sessions/xxx" turns { query { text: "What is foo?" query_id: ".../questions/yyy" } answer: "Foo is ..." } turns { query { text: "How about bar then?" query_id: ".../questions/zzz" } } } The user can call /search API with a request like this: session: ".../sessions/xxx" session_spec { query_id: ".../questions/zzz" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.
+            "searchResultPersistenceCount": 42, # The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.
+          },
+          "spellCorrectionSpec": { # The specification for query spell correction. # The spell correction specification that specifies the mode under which spell correction takes effect.
+            "mode": "A String", # The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.
+          },
+          "userInfo": { # Information of an end user. # Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics.
+            "userAgent": "A String", # User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.
+            "userId": "A String", # Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+          },
+          "userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
+            "a_key": "A String",
+          },
+          "userPseudoId": "A String", # A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+        },
+      },
+      "name": "A String", # Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "state": "A String", # Output only. The state of the evaluation.
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults(evaluation, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of results for a given a Evaluation.
+
+Args:
+  evaluation: string, Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  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 EvaluationService.ListEvaluationResults method.
+  "evaluationResults": [ # The EvaluationResults.
+    { # Represents the results of an evaluation for a single SampleQuery.
+      "qualityMetrics": { # Describes the metrics produced by the evaluation. # Output only. The metrics produced by the evaluation, for a given SampleQuery.
+        "docNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docPrecision": { # Stores the metric values at specific top-k levels. # Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "docRecall": { # Stores the metric values at specific top-k levels. # Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageNdcg": { # Stores the metric values at specific top-k levels. # Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+        "pageRecall": { # Stores the metric values at specific top-k levels. # Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6
+          "top1": 3.14, # The top-1 value.
+          "top10": 3.14, # The top-10 value.
+          "top3": 3.14, # The top-3 value.
+          "top5": 3.14, # The top-5 value.
+        },
+      },
+      "sampleQuery": { # Sample Query captures metadata to be used for evaluation. # Output only. The SampleQuery that was evaluated.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    },
+  ],
+  "nextPageToken": "A String", # A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+ +
+ listResults_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.
+
+        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.sampleQuerySets.html b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html index f9afeb97172..5500436b5b9 100644 --- a/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.html @@ -79,13 +79,185 @@

Instance Methods

Returns the operations Resource.

+

+ sampleQueries() +

+

Returns the sampleQueries Resource.

+

close()

Close httplib2 connections.

+

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

+

Creates a SampleQuerySet

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuerySet.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuerySet.

+

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

+

Gets a list of SampleQuerySets.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a SampleQuerySet.

Method Details

close()
Close httplib2 connections.
+
+ create(parent, body=None, sampleQuerySetId=None, x__xgafv=None) +
Creates a SampleQuerySet
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  sampleQuerySetId: string, Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a SampleQuerySet.
+
+Args:
+  name: string, Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of SampleQuerySets.
+
+Args:
+  parent: string, Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  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 SampleQuerySetService.ListSampleQuerySets method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQuerySets": [ # The SampleQuerySets.
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+      "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+      "description": "A String", # The description of the SampleQuerySet.
+      "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+      "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a SampleQuerySet.
+
+Args:
+  name: string, Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.
+  "createTime": "A String", # Output only. Timestamp the SampleQuerySet was created at.
+  "description": "A String", # The description of the SampleQuerySet.
+  "displayName": "A String", # Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.
+  "name": "A String", # Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+}
+
+ \ No newline at end of file diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html new file mode 100644 index 00000000000..70a61c930b0 --- /dev/null +++ b/docs/dyn/discoveryengine_v1beta.projects.locations.sampleQuerySets.sampleQueries.html @@ -0,0 +1,398 @@ + + + +

Discovery Engine API . projects . locations . sampleQuerySets . sampleQueries

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a SampleQuery

+

+ delete(name, x__xgafv=None)

+

Deletes a SampleQuery.

+

+ get(name, x__xgafv=None)

+

Gets a SampleQuery.

+

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

+

Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.

+

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

+

Gets a list of SampleQuerys.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a SampleQuery.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, sampleQueryId=None, x__xgafv=None) +
Creates a SampleQuery
+
+Args:
+  parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  sampleQueryId: string, Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a SampleQuery.
+
+Args:
+  name: string, Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ +
+ import_(parent, body=None, x__xgafv=None) +
Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for SampleQueryService.ImportSampleQueries method.
+  "bigquerySource": { # BigQuery source import data from. # BigQuery input source.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for user event imports: * `user_event` (default): One UserEvent per row. Supported values for document imports: * `document` (default): One Document format per row. Each document must have a valid Document.id and one of Document.json_data or Document.struct_data. * `custom`: One custom data per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
+    "datasetId": "A String", # Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
+    "gcsStagingDir": "A String", # Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
+    "partitionDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.
+      "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
+      "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
+      "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
+    },
+    "projectId": "A String", # The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
+    "tableId": "A String", # Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
+  },
+  "errorConfig": { # Configuration of destination for Import related errors. # The desired location of errors incurred during the Import.
+    "gcsPrefix": "A String", # Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.
+  },
+  "gcsSource": { # Cloud Storage location for input content. # Cloud Storage location for the input content.
+    "dataSchema": "A String", # The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line.
+    "inputUris": [ # Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`).
+      "A String",
+    ],
+  },
+  "inlineSource": { # The inline source for SampleQuerys. # The Inline source for sample query entries.
+    "sampleQueries": [ # Required. A list of SampleQuerys to import. Max of 1000 items.
+      { # Sample Query captures metadata to be used for evaluation.
+        "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+        "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+        "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+          "query": "A String", # Required. The query.
+          "targets": [ # List of targets for the query.
+            { # Defines the parameters of the query's expected outcome.
+              "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+                42,
+              ],
+              "score": 3.14, # Relevance score of the target.
+              "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+            },
+          ],
+        },
+      },
+    ],
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Gets a list of SampleQuerys.
+
+Args:
+  parent: string, Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned. (required)
+  pageSize: integer, Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
+  pageToken: string, A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
+  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 SampleQueryService.ListSampleQueries method.
+  "nextPageToken": "A String", # A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  "sampleQueries": [ # The SampleQuerys.
+    { # Sample Query captures metadata to be used for evaluation.
+      "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+      "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+      "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+        "query": "A String", # Required. The query.
+        "targets": [ # List of targets for the query.
+          { # Defines the parameters of the query's expected outcome.
+            "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+              42,
+            ],
+            "score": 3.14, # Relevance score of the target.
+            "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+          },
+        ],
+      },
+    },
+  ],
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a SampleQuery.
+
+Args:
+  name: string, Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+  updateMask: string, Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Sample Query captures metadata to be used for evaluation.
+  "createTime": "A String", # Output only. Timestamp the SampleQuery was created at.
+  "name": "A String", # Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
+  "queryEntry": { # Query Entry captures metadata to be used for search evaluation. # The query entry.
+    "query": "A String", # Required. The query.
+    "targets": [ # List of targets for the query.
+      { # Defines the parameters of the query's expected outcome.
+        "pageNumbers": [ # Expected page numbers of the target. Each page number must be non negative.
+          42,
+        ],
+        "score": 3.14, # Relevance score of the target.
+        "uri": "A String", # Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.
+      },
+    ],
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/displayvideo_v3.advertisers.creatives.html b/docs/dyn/displayvideo_v3.advertisers.creatives.html index 65bfc0cf55c..088c918405f 100644 --- a/docs/dyn/displayvideo_v3.advertisers.creatives.html +++ b/docs/dyn/displayvideo_v3.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/displayvideo_v3.sdfdownloadtasks.html b/docs/dyn/displayvideo_v3.sdfdownloadtasks.html index 9ac1d348338..508af4a4cc6 100644 --- a/docs/dyn/displayvideo_v3.sdfdownloadtasks.html +++ b/docs/dyn/displayvideo_v3.sdfdownloadtasks.html @@ -108,7 +108,7 @@

Method Details

"adGroupIds": [ # YouTube Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. "A String", ], - "adGroupQaIds": [ # Optional. YouTube Ad Groups QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + "adGroupQaIds": [ # Optional. YouTube Ad Groups, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. "A String", ], "campaignIds": [ # Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. @@ -120,7 +120,7 @@

Method Details

"lineItemIds": [ # Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. "A String", ], - "lineItemQaIds": [ # Optional. Line Items QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + "lineItemQaIds": [ # Optional. Line Items, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. "A String", ], "mediaProductIds": [ # Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index b80301248db..0526485b8a4 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -84,7 +84,7 @@

Instance Methods

create(body=None, x__xgafv=None)

Creates a blank document using the title given in the request. Other fields in the request, including any provided content, are ignored. Returns the created document.

- get(documentId, suggestionsViewMode=None, x__xgafv=None)

+ get(documentId, includeTabsContent=None, suggestionsViewMode=None, x__xgafv=None)

Gets the latest version of the specified document.

Method Details

@@ -103,22 +103,26 @@

Method Details

"sectionBreakLocation": { # A particular location in the document. # The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "type": "A String", # The type of footer to create. }, "createFootnote": { # Creates a Footnote segment and inserts a new FootnoteReference to it at the given location. The new Footnote segment will contain a space followed by a newline character. # Creates a footnote. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the footnote reference at the end of the document body. Footnote references cannot be inserted inside a header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the footnote reference at a specific index in the document. The footnote reference must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Footnote references cannot be inserted inside an equation, header, footer or footnote. Since footnote references can only be inserted in the body, the segment ID field must be empty. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "createHeader": { # Creates a Header. The new header is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a header of the specified type already exists, a 400 bad request error is returned. # Creates a header. "sectionBreakLocation": { # A particular location in the document. # The location of the SectionBreak which begins the section this header should belong to. If `section_break_location' is unset or if it refers to the first section break in the document body, the header applies to the DocumentStyle "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "type": "A String", # The type of header to create. }, @@ -128,6 +132,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "createParagraphBullets": { # Creates bullets for all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be determined by counting leading tabs in front of each paragraph. To avoid excess space between the bullet and the corresponding paragraph, these leading tabs are removed by this request. This may change the indices of parts of the text. If the paragraph immediately before paragraphs being updated is in a list with a matching preset, the paragraphs being updated are added to that preceding list. # Creates bullets for paragraphs. @@ -136,6 +141,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "deleteContentRange": { # Deletes content from the document. # Deletes content from the document. @@ -143,27 +149,37 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "deleteFooter": { # Deletes a Footer from the document. # Deletes a footer from the document. "footerId": "A String", # The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section. + "tabId": "A String", # The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "deleteHeader": { # Deletes a Header from the document. # Deletes a header from the document. "headerId": "A String", # The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section. + "tabId": "A String", # The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "deleteNamedRange": { # Deletes a NamedRange. # Deletes a named range. "name": "A String", # The name of the range(s) to delete. All named ranges with the given name will be deleted. "namedRangeId": "A String", # The ID of the named range to delete. + "tabsCriteria": { # A criteria that specifies in which tabs a request executes. # Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs. + "tabIds": [ # The list of tab IDs in which the request executes. + "A String", + ], + }, }, "deleteParagraphBullets": { # Deletes bullets from all of the paragraphs that overlap with the given range. The nesting level of each paragraph will be visually preserved by adding indent to the start of the corresponding paragraph. # Deletes bullets from paragraphs. "range": { # Specifies a contiguous range of text. # The range to delete bullets from. "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "deletePositionedObject": { # Deletes a PositionedObject from the document. # Deletes a positioned object from the document. "objectId": "A String", # The ID of the positioned object to delete. + "tabId": "A String", # The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "deleteTableColumn": { # Deletes a column from a table. # Deletes a column from a table. "tableCellLocation": { # Location of a single cell within a table. # The reference table cell location from which the column will be deleted. The column this cell spans will be deleted. If this is a merged cell that spans multiple columns, all columns that the cell spans will be deleted. If no columns remain in the table after this deletion, the whole table is deleted. @@ -172,6 +188,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, @@ -182,16 +199,19 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, "insertInlineImage": { # Inserts an InlineObject containing an image at the given location. # Inserts an inline image at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the text at the end of a header, footer or the document body. Inline images cannot be inserted inside a footnote. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the image at a specific index in the document. The image must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Inline images cannot be inserted inside a footnote or equation. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "objectSize": { # A width and height. # The size that the image should appear as in the document. This property is optional and the final size of the image in the document is determined by the following rules: * If neither width nor height is specified, then a default size of the image is calculated based on its resolution. * If one dimension is specified then the other dimension is calculated to preserve the aspect ratio of the image. * If both width and height are specified, the image is scaled to fit within the provided dimensions while maintaining its aspect ratio. "height": { # A magnitude in a single direction in the specified units. # The height of the object. @@ -208,19 +228,23 @@

Method Details

"insertPageBreak": { # Inserts a page break followed by a newline at the specified location. # Inserts a page break at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the page break at the end of the document body. Page breaks cannot be inserted inside a footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the page break at a specific index in the document. The page break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Page breaks cannot be inserted inside a table, equation, footnote, header or footer. Since page breaks can only be inserted inside the body, the segment ID field must be empty. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "insertSectionBreak": { # Inserts a section break at the given location. A newline character will be inserted before the section break. # Inserts a section break at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts a newline and a section break at the end of the document body. Section breaks cannot be inserted inside a footnote, header or footer. Because section breaks can only be inserted inside the body, the segment ID field must be empty. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts a newline and a section break at a specific index in the document. The section break must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). Section breaks cannot be inserted inside a table, equation, footnote, header, or footer. Since section breaks can only be inserted inside the body, the segment ID field must be empty. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "sectionType": "A String", # The type of section to insert. }, @@ -228,10 +252,12 @@

Method Details

"columns": 42, # The number of columns in the table. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the table at the end of the given header, footer or document body. A newline character will be inserted before the inserted table. Tables cannot be inserted inside a footnote. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the table at a specific model index. A newline character will be inserted before the inserted table, therefore the table start index will be at the specified location index + 1. The table must be inserted inside the bounds of an existing Paragraph. For instance, it cannot be inserted at a table's start index (i.e. between an existing table and its preceding paragraph). Tables cannot be inserted inside a footnote or equation. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "rows": 42, # The number of rows in the table. }, @@ -243,6 +269,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, @@ -254,16 +281,19 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, "insertText": { # Inserts text at the specified location. # Inserts text at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the text at the end of a header, footer, footnote or the document body. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "location": { # A particular location in the document. # Inserts the text at a specific index in the document. Text must be inserted inside the bounds of an existing Paragraph. For instance, text cannot be inserted at a table's start index (i.e. between the table and its preceding paragraph). The text must be inserted in the preceding paragraph. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "text": "A String", # The text to be inserted. Inserting a newline character will implicitly create a new Paragraph at that index. The paragraph style of the new paragraph will be copied from the paragraph at the current insertion index, including lists and bullets. Text styles for inserted text will be determined automatically, generally preserving the styling of neighboring text. In most cases, the text style for the inserted text will match the text immediately before the insertion index. Some control characters (U+0000-U+0008, U+000C-U+001F) and characters from the Unicode Basic Multilingual Plane Private Use Area (U+E000-U+F8FF) will be stripped out of the inserted text. }, @@ -277,6 +307,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, @@ -286,6 +317,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "replaceAllText": { # Replaces all instances of text matching a criteria with replace text. # Replaces all instances of the specified text. @@ -294,15 +326,26 @@

Method Details

"text": "A String", # The text to search for in the document. }, "replaceText": "A String", # The text that will replace the matched text. + "tabsCriteria": { # A criteria that specifies in which tabs a request executes. # Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. + "tabIds": [ # The list of tab IDs in which the request executes. + "A String", + ], + }, }, "replaceImage": { # Replaces an existing image with a new image. Replacing an image removes some image effects from the existing image in order to mirror the behavior of the Docs editor. # Replaces an image in the document. "imageObjectId": "A String", # The ID of the existing image that will be replaced. The ID can be retrieved from the response of a get request. "imageReplaceMethod": "A String", # The replacement method. + "tabId": "A String", # The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. "uri": "A String", # The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field. }, "replaceNamedRangeContent": { # Replaces the contents of the specified NamedRange or NamedRanges with the given replacement content. Note that an individual NamedRange may consist of multiple discontinuous ranges. In this case, only the content in the first range will be replaced. The other ranges and their content will be deleted. In cases where replacing or deleting any ranges would result in an invalid document structure, a 400 bad request error is returned. # Replaces the content in a named range. "namedRangeId": "A String", # The ID of the named range whose content will be replaced. If there is no named range with the given ID a 400 bad request error is returned. "namedRangeName": "A String", # The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op. + "tabsCriteria": { # A criteria that specifies in which tabs a request executes. # Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs. + "tabIds": [ # The list of tab IDs in which the request executes. + "A String", + ], + }, "text": "A String", # Replaces the content of the specified named range(s) with the given text. }, "unmergeTableCells": { # Unmerges cells in a Table. # Unmerges cells in a table. @@ -315,6 +358,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, @@ -379,6 +423,7 @@

Method Details

"useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. }, "fields": "A String", # The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `"background"`. + "tabId": "A String", # The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document. }, "updateParagraphStyle": { # Update the styling of all paragraphs that overlap with the given range. # Updates the paragraph style at the specified range. "fields": "A String", # The fields that should be updated. At least one field must be specified. The root `paragraph_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the paragraph style's alignment property, set `fields` to `"alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. @@ -538,6 +583,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "updateSectionStyle": { # Updates the SectionStyle. # Updates the section style of the specified range. @@ -546,6 +592,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "sectionStyle": { # The styling that applies to a section. # The styles to be set on the section. Certain section style changes may cause other changes in order to mirror the behavior of the Docs editor. See the documentation of SectionStyle for more information. "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. @@ -703,12 +750,14 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, }, "tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. When specified, the updates are applied to all the cells in the table. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "updateTableColumnProperties": { # Updates the TableColumnProperties of columns in a table. # Updates the properties of columns in a table. @@ -726,6 +775,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "updateTableRowStyle": { # Updates the TableRowStyle of rows in a table. # Updates the row style in a table. @@ -744,6 +794,7 @@

Method Details

"tableStartLocation": { # A particular location in the document. # The location where the table starts in the document. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, "updateTextStyle": { # Update the styling of text. # Updates the text style at the specified range. @@ -752,6 +803,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The styles to set on the text. If the value for a particular style matches that of the parent, that style will be set to inherit. Certain text style changes may cause other changes in order to to mirror the behavior of the Docs editor. See the documentation of TextStyle for more information. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -780,8 +832,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -892,8 +953,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -943,8 +1013,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -997,8 +1076,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1047,8 +1135,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1101,8 +1198,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1161,8 +1267,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1215,8 +1330,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1264,8 +1388,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1318,8 +1451,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1368,8 +1510,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1422,8 +1573,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1471,8 +1631,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1525,8 +1694,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1579,8 +1757,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1633,8 +1820,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1688,8 +1884,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1742,8 +1947,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1793,8 +2007,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -1847,8 +2070,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2049,8 +2281,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2715,8 +2956,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2766,8 +3016,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2820,8 +3079,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2870,8 +3138,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2924,8 +3201,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -2984,8 +3270,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3038,8 +3333,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3087,8 +3391,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3141,8 +3454,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3191,8 +3513,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3245,8 +3576,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3294,8 +3634,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3348,8 +3697,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3402,8 +3760,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3456,8 +3823,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3511,8 +3887,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3565,8 +3950,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3616,8 +4010,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3670,8 +4073,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -3872,8 +4284,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4481,8 +4902,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4532,8 +4962,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4586,8 +5025,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4636,8 +5084,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4690,8 +5147,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4750,8 +5216,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4804,8 +5279,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4853,8 +5337,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4907,8 +5400,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -4957,8 +5459,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5011,8 +5522,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5060,8 +5580,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5114,8 +5643,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5168,8 +5706,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5222,8 +5769,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5277,8 +5833,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5331,8 +5896,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5382,8 +5956,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5436,8 +6019,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -5638,8 +6230,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6247,8 +6848,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6298,8 +6908,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6352,8 +6971,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6402,8 +7030,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6456,8 +7093,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6516,8 +7162,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6570,8 +7225,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6619,8 +7283,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6673,8 +7346,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6723,8 +7405,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6777,8 +7468,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6826,8 +7526,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6880,8 +7589,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6934,8 +7652,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -6988,8 +7715,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7043,8 +7779,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7097,8 +7842,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7148,8 +7902,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7202,8 +7965,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -7404,8 +8176,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -8222,8 +9003,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -8286,8 +9076,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -8343,6 +9142,7 @@

Method Details

"endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, ], }, @@ -8532,8 +9332,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -9048,8 +9857,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -9111,1551 +9929,2147 @@

Method Details

}, }, "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. - "title": "A String", # The title of the document. -} - - x__xgafv: string, V1 error format. - Allowed values - 1 - v1 error format - 2 - v2 error format - -Returns: - An object of the form: - - { # A Google Docs document. - "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # Output only. The main body of the document. - "content": [ # The contents of the body. The indexes for the body's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tabs": [ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.child_tabs field. + { # A tab in a document. + "childTabs": [ # The child tabs nested within this tab. + # Object with schema name: Tab + ], + "documentTab": { # A tab with document contents. # A tab with document contents, like text and images. + "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # The main body of the document tab. + "content": [ # The contents of the body. The indexes for the body's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "type": "A String", # The type of this auto text. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + ], + }, + "documentStyle": { # The style of the document. # The style of the document tab. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "width": { # A magnitude in a single direction in the specified units. # The width of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "footers": { # The footers in the document tab, keyed by footer ID. + "a_key": { # A document footer. + "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. - }, - }, - }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10664,14 +12078,120 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10680,14 +12200,130 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10696,14 +12332,119 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10712,60 +12453,691 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, }, - }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10775,13 +13147,17 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10791,13 +13167,17 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10807,13 +13187,17 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -10823,1662 +13207,2495 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - }, - "documentId": "A String", # Output only. The ID of the document. - "documentStyle": { # The style of the document. # Output only. The style of the document. - "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. - "color": { # A color that can either be fully opaque or fully transparent. # The background color. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. - }, - "footers": { # Output only. The footers in the document, keyed by footer ID. - "a_key": { # A document footer. - "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, }, }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "widthType": "A String", # The width type of the column. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + ], }, }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + }, + ], + "footerId": "A String", # The ID of the footer. + }, + }, + "footnotes": { # The footnotes in the document tab, keyed by footnote ID. + "a_key": { # A document footnote. + "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + ], }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", ], }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. - }, - }, - }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -12487,98 +15704,141 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footnoteId": "A String", # The ID of the footnote. + }, + }, + "headers": { # The headers in the document tab, keyed by header ID. + "a_key": { # A document header. + "content": [ # The contents of the header. The indexes for a header's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -12587,566 +15847,2152 @@

Method Details

}, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "footerId": "A String", # The ID of the footer. - }, - }, - "footnotes": { # Output only. The footnotes in the document, keyed by footnote ID. - "a_key": { # A document footnote. - "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "headerId": "A String", # The ID of the header. + }, + }, + "inlineObjects": { # The inline objects in the document tab, keyed by object ID. + "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. + "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. + "a_key": { # A suggested change to InlineObjectProperties. + "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. }, }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. }, }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + }, + }, + }, + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + }, + }, + "lists": { # The lists in the document tab, keyed by list ID. + "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -13173,8 +18019,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -13186,17 +18041,31 @@

Method Details

}, }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + ], + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID. + "a_key": { # A suggested change to ListProperties. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -13223,8 +18092,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -13235,7 +18113,20 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + }, + ], + }, + "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. + "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. + { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value. + "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment. + "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format. + "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol. + "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. "boldSuggested": True or False, # Indicates if there was a suggested change to bold. @@ -13249,433 +18140,712 @@

Method Details

"weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, + ], + }, + }, + }, + }, + }, + "namedRanges": { # The named ranges in the document tab, keyed by name. + "a_key": { # A collection of all the NamedRanges in the document that share a given name. + "name": "A String", # The name that all the named ranges share. + "namedRanges": [ # The NamedRanges that share the same name. + { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. + "name": "A String", # The name of the named range. + "namedRangeId": "A String", # The ID of the named range. + "ranges": [ # The ranges that belong to this named range. + { # Specifies a contiguous range of text. + "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. + "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + ], + }, + ], + }, + }, + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # The named styles of the document tab. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "positionedObjects": { # The positioned objects in the document tab, keyed by object ID. + "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. + "objectId": "A String", # The ID of this positioned object. + "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. + "a_key": { # A suggested change to PositionedObjectProperties. + "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. }, }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. + "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. + "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. + "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. + }, + }, + }, + }, + }, + }, + "suggestedDocumentStyleChanges": { # The suggested changes to the style of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the DocumentStyle. + "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. + "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. + }, + "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. + "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. + "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. + "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. + "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. + "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. + "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. + "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. + "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. + "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. + "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. + }, + }, + }, + "suggestedNamedStylesChanges": { # The suggested changes to the named styles of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the NamedStyles. + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - }, + ], }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -13702,8 +18872,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -13715,211 +18894,37 @@

Method Details

}, }, }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, ], }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. + "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. + { # A suggestion state of a NamedStyle message. + "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. @@ -13934,417 +18939,477 @@

Method Details

"weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - }, + ], }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + }, + }, + }, + "tabProperties": { # Properties of a tab. # The properties of the tab, like ID and title. + "index": 42, # The index of the tab within the parent. + "nestingLevel": 42, # Output only. The depth of the tab within the document. Root-level tabs start at 0. + "parentTabId": "A String", # Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. + "tabId": "A String", # Output only. The ID of the tab. This field can't be changed. + "title": "A String", # The user-visible name of the tab. + }, + }, + ], + "title": "A String", # The title of the document. +} + + x__xgafv: string, V1 error format. + Allowed values + 1 - v1 error format + 2 - v2 error format + +Returns: + An object of the form: + + { # A Google Docs document. + "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # Output only. The main body of the document. + "content": [ # The contents of the body. The indexes for the body's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, + "type": "A String", # The type of this auto text. }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. - }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -14353,1382 +19418,1366 @@

Method Details

}, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "footnoteId": "A String", # The ID of the footnote. - }, - }, - "headers": { # Output only. The headers in the document, keyed by header ID. - "a_key": { # A document header. - "content": [ # The contents of the header. The indexes for a header's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "type": "A String", # The type of this auto text. }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. }, }, }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -15737,58 +20786,321 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + }, + "documentId": "A String", # Output only. The ID of the document. + "documentStyle": { # The style of the document. # Output only. The style of the document. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "footers": { # Output only. The footers in the document, keyed by footer ID. + "a_key": { # A document footer. + "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -15797,37 +21109,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -15836,291 +21124,174 @@

Method Details

}, }, }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "type": "A String", # The type of this auto text. }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16129,14 +21300,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16145,14 +21315,104 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16161,14 +21421,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16177,741 +21436,838 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "headerId": "A String", # The ID of the header. - }, - }, - "inlineObjects": { # Output only. The inline objects in the document, keyed by object ID. - "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. - "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. - "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. - }, - }, - "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. - "a_key": { # A suggested change to InlineObjectProperties. - "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. - "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. - }, - }, - "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. - "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. - "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. - "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. - }, - "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. - "colorSuggested": True or False, # Indicates if there was a suggested change to color. - "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. - "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. - "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. - "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. - "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. - "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. - "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. - "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. - }, - "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. - "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. - }, - "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. - "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. - "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. - "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. - }, - }, - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "titleSuggested": True or False, # Indicates if there was a suggested change to title. - }, - }, - }, - }, - "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. - }, - }, - "lists": { # Output only. The lists in the document, keyed by list ID. - "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet. - "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list. - "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. - { # Contains properties describing the look and feel of a list bullet at a given level of nesting. - "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. - "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. - "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. - "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - ], - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list. - "A String", - ], - "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. - "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID. - "a_key": { # A suggested change to ListProperties. - "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. - "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. - { # Contains properties describing the look and feel of a list bullet at a given level of nesting. - "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. - "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. - "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. - "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - ], - }, - "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. - "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. - { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value. - "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment. - "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format. - "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol. - "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - }, - ], - }, - }, - }, - }, - }, - "namedRanges": { # Output only. The named ranges in the document, keyed by name. - "a_key": { # A collection of all the NamedRanges in the document that share a given name. - "name": "A String", # The name that all the named ranges share. - "namedRanges": [ # The NamedRanges that share the same name. - { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. - "name": "A String", # The name of the named range. - "namedRangeId": "A String", # The ID of the named range. - "ranges": [ # The ranges that belong to this named range. - { # Specifies a contiguous range of text. - "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. - "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. - "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. - }, - ], - }, - ], - }, - }, - "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # Output only. The named styles of the document. - "styles": [ # The named styles. There's an entry for each of the possible named style types. - { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. - "namedStyleType": "A String", # The type of this named style. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - ], - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - ], - }, - "positionedObjects": { # Output only. The positioned objects in the document, keyed by object ID. - "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. - "objectId": "A String", # The ID of this positioned object. - "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. - "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. - }, - "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. - "layout": "A String", # The layout of this positioned object. - "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. - "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. - "a_key": { # A suggested change to PositionedObjectProperties. - "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. - "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -16920,653 +22276,511 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + ], }, - "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. - "layout": "A String", # The layout of this positioned object. - "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, }, - }, - "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. - "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. - "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. - "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. - }, - "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. - "colorSuggested": True or False, # Indicates if there was a suggested change to color. - "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. - "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. - "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. - "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. - "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. - "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. - "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. - "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. - "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. - }, - "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. - "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. - "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. - "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, }, - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "titleSuggested": True or False, # Indicates if there was a suggested change to title. - }, - "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. - "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. - "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. - "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. }, - }, - }, - }, - }, - }, - "revisionId": "A String", # Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "suggestedDocumentStyleChanges": { # Output only. The suggested changes to the style of the document, keyed by suggestion ID. - "a_key": { # A suggested change to the DocumentStyle. - "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. - "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. - "color": { # A color that can either be fully opaque or fully transparent. # The background color. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], }, }, }, - }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. - }, - "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. - "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. - }, - "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. - "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. - "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. - "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. - "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. - "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. - "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. - "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. - "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. - "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. - "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. - }, - }, - }, - "suggestedNamedStylesChanges": { # Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. - "a_key": { # A suggested change to the NamedStyles. - "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. - "styles": [ # The named styles. There's an entry for each of the possible named style types. - { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. - "namedStyleType": "A String", # The type of this named style. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - ], - }, - "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. - "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. - { # A suggestion state of a NamedStyle message. - "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - ], - }, - }, - }, - "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. - "title": "A String", # The title of the document. -} -
- -
- get(documentId, suggestionsViewMode=None, x__xgafv=None) -
Gets the latest version of the specified document.
-
-Args:
-  documentId: string, The ID of the document to retrieve. (required)
-  suggestionsViewMode: string, The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.
-    Allowed values
-      DEFAULT_FOR_CURRENT_ACCESS - The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.
-      SUGGESTIONS_INLINE - The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.
-      PREVIEW_SUGGESTIONS_ACCEPTED - The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.
-      PREVIEW_WITHOUT_SUGGESTIONS - The returned document is a preview with all suggested changes rejected if there are any suggestions in the document.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # A Google Docs document.
-  "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # Output only. The main body of the document.
-    "content": [ # The contents of the body. The indexes for the body's content begin at zero.
-      { # A StructuralElement describes content that provides structure to the document.
-        "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
-        "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
-          "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
-            "listId": "A String", # The ID of the list this paragraph belongs to.
-            "nestingLevel": 42, # The nesting level of this paragraph in the list.
-            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
-              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                  "rgbColor": { # An RGB color. # The RGB color value.
-                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                  },
-                },
-              },
-              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-              "bold": True or False, # Whether or not the text is rendered as bold.
-              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-                "magnitude": 3.14, # The magnitude.
-                "unit": "A String", # The units for magnitude.
-              },
-              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                  "rgbColor": { # An RGB color. # The RGB color value.
-                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                  },
-                },
-              },
-              "italic": True or False, # Whether or not the text is italicized.
-              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                "bookmarkId": "A String", # The ID of a bookmark in this document.
-                "headingId": "A String", # The ID of a heading in this document.
-                "url": "A String", # An external URL.
-              },
-              "smallCaps": True or False, # Whether or not the text is in small capital letters.
-              "strikethrough": True or False, # Whether or not the text is struck through.
-              "underline": True or False, # Whether or not the text is underlined.
-              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-              },
+              "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "sectionType": "A String", # Output only. The type of section.
+              "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
             },
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
           },
-          "elements": [ # The content of the paragraph, broken down into its component parts.
-            { # A ParagraphElement describes content within a Paragraph.
-              "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+          "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+          "table": { # A StructuralElement representing a table. # A table type of structural element.
+            "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+            "rows": 42, # Number of rows in the table.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+            "tableRows": [ # The contents and style of each row.
+              { # The contents and style of a row in a Table.
+                "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
                 "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
                   "A String",
                 ],
-                "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
                   "A String",
                 ],
-                "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
-                  "a_key": { # A suggested change to a TextStyle.
-                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
-                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                          "rgbColor": { # An RGB color. # The RGB color value.
-                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                          },
-                        },
-                      },
-                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-                      "bold": True or False, # Whether or not the text is rendered as bold.
-                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TableRowStyle.
+                    "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
                         "magnitude": 3.14, # The magnitude.
                         "unit": "A String", # The units for magnitude.
                       },
-                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                          "rgbColor": { # An RGB color. # The RGB color value.
-                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                          },
-                        },
-                      },
-                      "italic": True or False, # Whether or not the text is italicized.
-                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                        "bookmarkId": "A String", # The ID of a bookmark in this document.
-                        "headingId": "A String", # The ID of a heading in this document.
-                        "url": "A String", # An external URL.
-                      },
-                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
-                      "strikethrough": True or False, # Whether or not the text is struck through.
-                      "underline": True or False, # Whether or not the text is underlined.
-                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-                      },
-                    },
-                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
-                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
-                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
-                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
-                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
-                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
-                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
-                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
-                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
-                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
-                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
-                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
-                    },
-                  },
-                },
-                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
-                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                      "rgbColor": { # An RGB color. # The RGB color value.
-                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
                     },
-                  },
-                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-                  "bold": True or False, # Whether or not the text is rendered as bold.
-                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-                    "magnitude": 3.14, # The magnitude.
-                    "unit": "A String", # The units for magnitude.
-                  },
-                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                      "rgbColor": { # An RGB color. # The RGB color value.
-                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                      },
+                    "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                      "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
                     },
                   },
-                  "italic": True or False, # Whether or not the text is italicized.
-                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                    "bookmarkId": "A String", # The ID of a bookmark in this document.
-                    "headingId": "A String", # The ID of a heading in this document.
-                    "url": "A String", # An external URL.
-                  },
-                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
-                  "strikethrough": True or False, # Whether or not the text is struck through.
-                  "underline": True or False, # Whether or not the text is underlined.
-                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-                  },
                 },
-                "type": "A String", # The type of this auto text.
-              },
-              "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
-                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
-                  "A String",
-                ],
-                "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
-                  "A String",
-                ],
-                "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
-                  "a_key": { # A suggested change to a TextStyle.
-                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
-                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                  { # The contents and style of a cell in a Table.
+                    "content": [ # The content of the cell.
+                      # Object with schema name: StructuralElement
+                    ],
+                    "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableCellStyle.
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                        "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                          "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                          "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                          "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                          "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                          "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                          "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                          "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                          "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                          "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                          "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                        },
+                      },
+                    },
+                    "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
                         "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
                           "rgbColor": { # An RGB color. # The RGB color value.
                             "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
@@ -17575,1466 +22789,1562 @@ 

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footerId": "A String", # The ID of the footer. + }, + }, + "footnotes": { # Output only. The footnotes in the document, keyed by footnote ID. + "a_key": { # A document footnote. + "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "type": "A String", # The type of this auto text. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19043,303 +24353,97 @@

Method Details

}, }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "rowSpan": 42, # The row span of the cell. This property is read-only. }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - }, - "documentId": "A String", # Output only. The ID of the document. - "documentStyle": { # The style of the document. # Output only. The style of the document. - "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. - "color": { # A color that can either be fully opaque or fully transparent. # The background color. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. - }, - "footers": { # Output only. The footers in the document, keyed by footer ID. - "a_key": { # A document footer. - "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19348,177 +24452,291 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. }, }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19527,86 +24745,30 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19615,13 +24777,14 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -19630,84 +24793,140 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footnoteId": "A String", # The ID of the footnote. + }, + }, + "headers": { # Output only. The headers in the document, keyed by header ID. + "a_key": { # A document header. + "content": [ # The contents of the header. The indexes for a header's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -19736,8 +24955,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19763,7 +24991,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -19790,8 +25018,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19802,15 +25039,16 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, + "type": "A String", # The type of this auto text. }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -19839,8 +25077,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19866,7 +25113,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -19893,8 +25140,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19906,19 +25162,25 @@

Method Details

}, }, }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -19947,8 +25209,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -19974,7 +25245,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -20001,8 +25272,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20014,20 +25294,14 @@

Method Details

}, }, }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -20056,8 +25330,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20083,7 +25366,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -20110,8 +25393,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20123,16 +25415,15 @@

Method Details

}, }, }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -20161,8 +25452,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20188,7 +25488,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -20215,8 +25515,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20228,169 +25537,79 @@

Method Details

}, }, }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -20417,8 +25636,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -20430,72 +25658,85 @@

Method Details

}, }, }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -20504,18 +25745,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -20524,18 +25760,110 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -20544,37 +25872,13 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -20583,529 +25887,390 @@

Method Details

}, }, }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "footerId": "A String", # The ID of the footer. - }, - }, - "footnotes": { # Output only. The footnotes in the document, keyed by footnote ID. - "a_key": { # A document footnote. - "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21114,13 +26279,18 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21129,87 +26299,18 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "type": "A String", # The type of this auto text. - }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21218,13 +26319,18 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21233,97 +26339,18 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21332,13 +26359,37 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21347,151 +26398,291 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. }, }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21500,86 +26691,30 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21588,13 +26723,14 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -21603,423 +26739,158 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "rowSpan": 42, # The row span of the cell. This property is read-only. }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "widthType": "A String", # The width type of the column. }, - }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "headerId": "A String", # The ID of the header. + }, + }, + "inlineObjects": { # Output only. The inline objects in the document, keyed by object ID. + "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. + "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. + "a_key": { # A suggested change to InlineObjectProperties. + "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -22030,857 +26901,1106 @@

Method Details

}, }, "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "propertyState": "A String", # The property state of the border property. "width": { # A magnitude in a single direction in the specified units. # The width of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. }, }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + }, + }, + }, + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + }, + }, + "lists": { # Output only. The lists in the document, keyed by list ID. + "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + }, + }, + ], + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID. + "a_key": { # A suggested change to ListProperties. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, + ], + }, + "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. + "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. + { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value. + "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment. + "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format. + "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol. + "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + }, + }, + }, + }, + }, + "namedRanges": { # Output only. The named ranges in the document, keyed by name. + "a_key": { # A collection of all the NamedRanges in the document that share a given name. + "name": "A String", # The name that all the named ranges share. + "namedRanges": [ # The NamedRanges that share the same name. + { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. + "name": "A String", # The name of the named range. + "namedRangeId": "A String", # The ID of the named range. + "ranges": [ # The ranges that belong to this named range. + { # Specifies a contiguous range of text. + "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. + "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + ], + }, + ], + }, + }, + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # Output only. The named styles of the document. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. - }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "positionedObjects": { # Output only. The positioned objects in the document, keyed by object ID. + "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. + "objectId": "A String", # The ID of this positioned object. + "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. + "a_key": { # A suggested change to PositionedObjectProperties. + "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. - }, - }, - }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. - }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. }, - ], - }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - }, - ], - "footnoteId": "A String", # The ID of the footnote. - }, - }, - "headers": { # Output only. The headers in the document, keyed by header ID. - "a_key": { # A document header. - "content": [ # The contents of the header. The indexes for a header's content begin at zero. - { # A StructuralElement describes content that provides structure to the document. - "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. - "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. - "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. }, - "elements": [ # The content of the paragraph, broken down into its component parts. - { # A ParagraphElement describes content within a Paragraph. - "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + }, + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + }, + }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. + "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. + "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. + "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. + }, + }, + }, + }, + }, + }, + "revisionId": "A String", # Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes. + "suggestedDocumentStyleChanges": { # Output only. The suggested changes to the style of the document, keyed by suggestion ID. + "a_key": { # A suggested change to the DocumentStyle. + "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. + "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. + }, + "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. + "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. + "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. + "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. + "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. + "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. + "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. + "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. + "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. + "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. + "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. + }, + }, + }, + "suggestedNamedStylesChanges": { # Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. + "a_key": { # A suggested change to the NamedStyles. + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. + "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. + { # A suggestion state of a NamedStyle message. + "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + }, + }, + }, + "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. + "tabs": [ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.child_tabs field. + { # A tab in a document. + "childTabs": [ # The child tabs nested within this tab. + # Object with schema name: Tab + ], + "documentTab": { # A tab with document contents. # A tab with document contents, like text and images. + "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # The main body of the document tab. + "content": [ # The contents of the body. The indexes for the body's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. "bold": True or False, # Whether or not the text is rendered as bold. "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. @@ -22897,8 +28017,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -22909,28 +28038,92 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. "bold": True or False, # Whether or not the text is rendered as bold. "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. @@ -22947,8 +28140,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -22959,82 +28161,81 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, + "type": "A String", # The type of this auto text. }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23061,8 +28262,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23073,71 +28283,91 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23164,8 +28394,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23176,72 +28415,80 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23268,8 +28515,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23280,71 +28536,81 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23371,8 +28637,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23383,76 +28658,80 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # Output only. The email address linked to this Person. This field is always present. - "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23479,8 +28758,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23491,77 +28779,85 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # Output only. The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23588,8 +28884,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23600,73 +28905,209 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -23693,8 +29134,17 @@

Method Details

}, "italic": True or False, # Whether or not the text is italicized. "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. "url": "A String", # An external URL. }, "smallCaps": True or False, # Whether or not the text is in small capital letters. @@ -23705,23 +29155,14 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -23730,13 +29171,18 @@

Method Details

}, }, }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -23745,248 +29191,17 @@

Method Details

}, }, }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, }, - }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. - "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. - "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - }, - "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. - "a_key": { # A suggested change to a ParagraphStyle. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -24006,7 +29221,7 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -24026,7 +29241,7 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -24046,67 +29261,27 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -24135,161 +29310,501 @@

Method Details

}, ], }, - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - }, - }, - "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. - "a_key": { # A collection of object IDs. - "objectIds": [ # The object IDs. - "A String", - ], - }, - }, - }, - "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. - "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. - "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. - { # Properties that apply to a section's column. - "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - "sectionType": "A String", # Output only. The type of section. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. - }, - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. - "table": { # A StructuralElement representing a table. # A table type of structural element. - "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. - "rows": 42, # Number of rows in the table. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "tableRows": [ # The contents and style of each row. - { # The contents and style of a row in a Table. - "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. "A String", ], - "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. - "a_key": { # A suggested change to a TableRowStyle. - "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. }, - "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. - "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, }, }, - "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. - { # The contents and style of a cell in a Table. - "content": [ # The content of the cell. - # Object with schema name: StructuralElement - ], - "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. - "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. - "a_key": { # A suggested change to a TableCellStyle. - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -24372,165 +29887,47 @@

Method Details

}, "rowSpan": 42, # The row span of the cell. This property is read-only. }, - "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. - "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. - "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. - "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. - "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. - "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. - "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. - }, - }, - }, - "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, }, - "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "columnSpan": 42, # The column span of the cell. This property is read-only. - "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. - "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "rowSpan": 42, # The row span of the cell. This property is read-only. + "widthType": "A String", # The width type of the column. }, - }, - ], - "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. - "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. - "tableHeader": True or False, # Whether the row is a table header. + ], }, }, - ], - "tableStyle": { # Styles that apply to a table. # The style of the table. - "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. - { # The properties of a column in a table. - "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "widthType": "A String", # The width type of the column. - }, - ], + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, }, - }, - "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. - "content": [ # The content of the table of contents. - # Object with schema name: StructuralElement - ], - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, + ], }, - ], - "headerId": "A String", # The ID of the header. - }, - }, - "inlineObjects": { # Output only. The inline objects in the document, keyed by object ID. - "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. - "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. - "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "documentStyle": { # The style of the document. # The style of the document tab. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -24539,51 +29936,40 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "size": { # A width and height. # The visible size of the image after cropping. + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. @@ -24593,604 +29979,24458 @@

Method Details

"unit": "A String", # The units for magnitude. }, }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. }, - }, - "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. - "a_key": { # A suggested change to InlineObjectProperties. - "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. - "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. - "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. - "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. - }, - "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "footers": { # The footers in the document tab, keyed by footer ID. + "a_key": { # A document footer. + "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, }, }, - }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. - }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. - }, - }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footerId": "A String", # The ID of the footer. + }, + }, + "footnotes": { # The footnotes in the document tab, keyed by footnote ID. + "a_key": { # A document footnote. + "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "footnoteId": "A String", # The ID of the footnote. + }, + }, + "headers": { # The headers in the document tab, keyed by header ID. + "a_key": { # A document header. + "content": [ # The contents of the header. The indexes for a header's content begin at zero. + { # A StructuralElement describes content that provides structure to the document. + "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units. + "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element. + "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "elements": [ # The content of the paragraph, broken down into its component parts. + { # A ParagraphElement describes content within a Paragraph. + "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # Output only. The email address linked to this Person. This field is always present. + "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # Output only. The URI to the RichLink. This is always present. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. + "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id. + "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + }, + "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID. + "a_key": { # A suggested change to a ParagraphStyle. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + }, + }, + "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID. + "a_key": { # A collection of object IDs. + "objectIds": [ # The object IDs. + "A String", + ], + }, + }, + }, + "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element. + "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break. + "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error. + { # Properties that apply to a section's column. + "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + "sectionType": "A String", # Output only. The type of section. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units. + "table": { # A StructuralElement representing a table. # A table type of structural element. + "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells. + "rows": 42, # Number of rows in the table. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "tableRows": [ # The contents and style of each row. + { # The contents and style of a row in a Table. + "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID. + "a_key": { # A suggested change to a TableRowStyle. + "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. + "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height. + }, + }, + }, + "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table. + { # The contents and style of a cell in a Table. + "content": [ # The content of the cell. + # Object with schema name: StructuralElement + ], + "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units. + "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID. + "a_key": { # A suggested change to a TableCellStyle. + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span. + "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment. + "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom. + "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left. + "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right. + "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top. + "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span. + }, + }, + }, + "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "columnSpan": 42, # The column span of the cell. This property is read-only. + "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor. + "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "rowSpan": 42, # The row span of the cell. This property is read-only. + }, + }, + ], + "tableRowStyle": { # Styles that apply to a table row. # The style of the table row. + "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries. + "tableHeader": True or False, # Whether the row is a table header. + }, + }, + ], + "tableStyle": { # Styles that apply to a table. # The style of the table. + "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style. + { # The properties of a column in a table. + "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "widthType": "A String", # The width type of the column. + }, + ], + }, + }, + "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element. + "content": [ # The content of the table of contents. + # Object with schema name: StructuralElement + ], + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + }, + ], + "headerId": "A String", # The ID of the header. + }, + }, + "inlineObjects": { # The inline objects in the document tab, keyed by object ID. + "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image. + "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID. + "a_key": { # A suggested change to InlineObjectProperties. + "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + }, + "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + }, + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + }, + }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + }, + }, + }, + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + }, + }, + "lists": { # The lists in the document tab, keyed by list ID. + "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID. + "a_key": { # A suggested change to ListProperties. + "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values. + "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first. + { # Contains properties describing the look and feel of a list bullet at a given level of nesting. + "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet. + "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list. + "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle. + "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list. + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. + "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first. + { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value. + "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment. + "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format. + "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol. + "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + }, + }, + }, + }, + }, + "namedRanges": { # The named ranges in the document tab, keyed by name. + "a_key": { # A collection of all the NamedRanges in the document that share a given name. + "name": "A String", # The name that all the named ranges share. + "namedRanges": [ # The NamedRanges that share the same name. + { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges. + "name": "A String", # The name of the named range. + "namedRangeId": "A String", # The ID of the named range. + "ranges": [ # The ranges that belong to this named range. + { # Specifies a contiguous range of text. + "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body. + "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. + "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + ], + }, + ], + }, + }, + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # The named styles of the document tab. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "positionedObjects": { # The positioned objects in the document tab, keyed by object ID. + "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. + "objectId": "A String", # The ID of this positioned object. + "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. + "a_key": { # A suggested change to PositionedObjectProperties. + "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + }, + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + }, + }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. + "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. + "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. + "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. + }, + }, + }, + }, + }, + }, + "suggestedDocumentStyleChanges": { # The suggested changes to the style of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the DocumentStyle. + "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. + "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. + }, + "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. + "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. + "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. + "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. + "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. + "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. + "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. + "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. + "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. + "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. + "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. + }, + }, + }, + "suggestedNamedStylesChanges": { # The suggested changes to the named styles of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the NamedStyles. + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + }, + "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. + "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. + { # A suggestion state of a NamedStyle message. + "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + ], + }, + }, + }, + }, + "tabProperties": { # Properties of a tab. # The properties of the tab, like ID and title. + "index": 42, # The index of the tab within the parent. + "nestingLevel": 42, # Output only. The depth of the tab within the document. Root-level tabs start at 0. + "parentTabId": "A String", # Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. + "tabId": "A String", # Output only. The ID of the tab. This field can't be changed. + "title": "A String", # The user-visible name of the tab. + }, + }, + ], + "title": "A String", # The title of the document. +}
+
+ +
+ get(documentId, includeTabsContent=None, suggestionsViewMode=None, x__xgafv=None) +
Gets the latest version of the specified document.
+
+Args:
+  documentId: string, The ID of the document to retrieve. (required)
+  includeTabsContent: boolean, Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.
+  suggestionsViewMode: string, The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.
+    Allowed values
+      DEFAULT_FOR_CURRENT_ACCESS - The SuggestionsViewMode applied to the returned document depends on the user's current access level. If the user only has view access, PREVIEW_WITHOUT_SUGGESTIONS is applied. Otherwise, SUGGESTIONS_INLINE is applied. This is the default suggestions view mode.
+      SUGGESTIONS_INLINE - The returned document has suggestions inline. Suggested changes will be differentiated from base content within the document. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.
+      PREVIEW_SUGGESTIONS_ACCEPTED - The returned document is a preview with all suggested changes accepted. Requests to retrieve a document using this mode will return a 403 error if the user does not have permission to view suggested changes.
+      PREVIEW_WITHOUT_SUGGESTIONS - The returned document is a preview with all suggested changes rejected if there are any suggestions in the document.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A Google Docs document.
+  "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # Output only. The main body of the document.
+    "content": [ # The contents of the body. The indexes for the body's content begin at zero.
+      { # A StructuralElement describes content that provides structure to the document.
+        "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+        "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+          "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+            "listId": "A String", # The ID of the list this paragraph belongs to.
+            "nestingLevel": 42, # The nesting level of this paragraph in the list.
+            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+              "bold": True or False, # Whether or not the text is rendered as bold.
+              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "italic": True or False, # Whether or not the text is italicized.
+              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a bookmark in this document.
+                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                },
+                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of the tab containing this heading.
+                },
+                "headingId": "A String", # The ID of a heading in this document.
+                "tabId": "A String", # The ID of a tab in this document.
+                "url": "A String", # An external URL.
+              },
+              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+              "strikethrough": True or False, # Whether or not the text is struck through.
+              "underline": True or False, # Whether or not the text is underlined.
+              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+              },
+            },
+          },
+          "elements": [ # The content of the paragraph, broken down into its component parts.
+            { # A ParagraphElement describes content within a Paragraph.
+              "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+                "type": "A String", # The type of this auto text.
+              },
+              "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+              "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+              },
+              "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                "footnoteNumber": "A String", # The rendered number of this footnote.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                "personId": "A String", # Output only. The unique ID of this link.
+                "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                  "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                  "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                },
+                "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                "richLinkId": "A String", # Output only. The ID of this link.
+                "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                  "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                  "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                  "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                },
+                "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+              "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TextStyle.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                    "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                      "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                      "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                      "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                      "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                      "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                      "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                      "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                      "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                      "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                      "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                      "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                    },
+                  },
+                },
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+            },
+          ],
+          "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+            "alignment": "A String", # The text alignment for this paragraph.
+            "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+            "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "dashStyle": "A String", # The dash style of the border.
+              "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+            "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+            "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+            "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+            "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+            "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+            "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+            "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+            "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+            },
+            "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "spacingMode": "A String", # The spacing mode for the paragraph.
+            "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+              { # A tab stop within a paragraph.
+                "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+            ],
+          },
+          "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+            "A String",
+          ],
+          "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+            "a_key": { # A suggested change to a Bullet.
+              "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                "listId": "A String", # The ID of the list this paragraph belongs to.
+                "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+              "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                  "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                  "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                  "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                  "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                  "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                  "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                  "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                  "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                  "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                  "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                  "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                },
+              },
+            },
+          },
+          "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+            "a_key": { # A suggested change to a ParagraphStyle.
+              "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                "alignment": "A String", # The text alignment for this paragraph.
+                "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                },
+                "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "spacingMode": "A String", # The spacing mode for the paragraph.
+                "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                  { # A tab stop within a paragraph.
+                    "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                    "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                ],
+              },
+              "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                  "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                },
+                "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+              },
+            },
+          },
+          "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+            "a_key": { # A collection of object IDs.
+              "objectIds": [ # The object IDs.
+                "A String",
+              ],
+            },
+          },
+        },
+        "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+          "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+            "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+              { # Properties that apply to a section's column.
+                "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+            ],
+            "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+            "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+            "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+            "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+            "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+            "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+            "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            "sectionType": "A String", # Output only. The type of section.
+            "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+          },
+          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+            "A String",
+          ],
+          "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+            "A String",
+          ],
+        },
+        "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+        "table": { # A StructuralElement representing a table. # A table type of structural element.
+          "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+          "rows": 42, # Number of rows in the table.
+          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+            "A String",
+          ],
+          "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+            "A String",
+          ],
+          "tableRows": [ # The contents and style of each row.
+            { # The contents and style of a row in a Table.
+              "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+              "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+              "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                "A String",
+              ],
+              "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                "A String",
+              ],
+              "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                "a_key": { # A suggested change to a TableRowStyle.
+                  "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                    "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                    "tableHeader": True or False, # Whether the row is a table header.
+                  },
+                  "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                    "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                  },
+                },
+              },
+              "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                { # The contents and style of a cell in a Table.
+                  "content": [ # The content of the cell.
+                    # Object with schema name: StructuralElement
+                  ],
+                  "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                  "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TableCellStyle.
+                      "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "columnSpan": 42, # The column span of the cell. This property is read-only.
+                        "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                        "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "rowSpan": 42, # The row span of the cell. This property is read-only.
+                      },
+                      "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                        "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                        "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                        "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                        "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                        "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                        "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                        "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                        "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                        "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                        "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                      },
+                    },
+                  },
+                  "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "columnSpan": 42, # The column span of the cell. This property is read-only.
+                    "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                    "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "rowSpan": 42, # The row span of the cell. This property is read-only.
+                  },
+                },
+              ],
+              "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                "tableHeader": True or False, # Whether the row is a table header.
+              },
+            },
+          ],
+          "tableStyle": { # Styles that apply to a table. # The style of the table.
+            "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+              { # The properties of a column in a table.
+                "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "widthType": "A String", # The width type of the column.
+              },
+            ],
+          },
+        },
+        "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+          "content": [ # The content of the table of contents.
+            # Object with schema name: StructuralElement
+          ],
+          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+            "A String",
+          ],
+          "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+            "A String",
+          ],
+        },
+      },
+    ],
+  },
+  "documentId": "A String", # Output only. The ID of the document.
+  "documentStyle": { # The style of the document. # Output only. The style of the document.
+    "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color.
+      "color": { # A color that can either be fully opaque or fully transparent. # The background color.
+        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+          "rgbColor": { # An RGB color. # The RGB color value.
+            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+          },
+        },
+      },
+    },
+    "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only.
+    "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only.
+    "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only.
+    "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only.
+    "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only.
+    "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.
+    "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape.
+    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles.
+      "magnitude": 3.14, # The magnitude.
+      "unit": "A String", # The units for magnitude.
+    },
+    "pageNumberStart": 42, # The page number from which to start counting the number of pages.
+    "pageSize": { # A width and height. # The size of a page in the document.
+      "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+        "magnitude": 3.14, # The magnitude.
+        "unit": "A String", # The units for magnitude.
+      },
+      "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+        "magnitude": 3.14, # The magnitude.
+        "unit": "A String", # The units for magnitude.
+      },
+    },
+    "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only.
+    "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages.
+    "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page.
+  },
+  "footers": { # Output only. The footers in the document, keyed by footer ID.
+    "a_key": { # A document footer.
+      "content": [ # The contents of the footer. The indexes for a footer's content begin at zero.
+        { # A StructuralElement describes content that provides structure to the document.
+          "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+          "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+            "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+              "listId": "A String", # The ID of the list this paragraph belongs to.
+              "nestingLevel": 42, # The nesting level of this paragraph in the list.
+              "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                "bold": True or False, # Whether or not the text is rendered as bold.
+                "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "italic": True or False, # Whether or not the text is italicized.
+                "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                  "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a bookmark in this document.
+                    "tabId": "A String", # The ID of the tab containing this bookmark.
+                  },
+                  "bookmarkId": "A String", # The ID of a bookmark in this document.
+                  "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of the tab containing this heading.
+                  },
+                  "headingId": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of a tab in this document.
+                  "url": "A String", # An external URL.
+                },
+                "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                "strikethrough": True or False, # Whether or not the text is struck through.
+                "underline": True or False, # Whether or not the text is underlined.
+                "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                  "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                  "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                },
+              },
+            },
+            "elements": [ # The content of the paragraph, broken down into its component parts.
+              { # A ParagraphElement describes content within a Paragraph.
+                "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                  "type": "A String", # The type of this auto text.
+                },
+                "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                },
+                "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                  "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                  "footnoteNumber": "A String", # The rendered number of this footnote.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                  "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                  "personId": "A String", # Output only. The unique ID of this link.
+                  "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                    "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                    "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                  "richLinkId": "A String", # Output only. The ID of this link.
+                  "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                    "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                    "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                    "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                  "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+              },
+            ],
+            "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+              "alignment": "A String", # The text alignment for this paragraph.
+              "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+              "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+              "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+              "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+              "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+              "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+              "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+              "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+              "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+              },
+              "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spacingMode": "A String", # The spacing mode for the paragraph.
+              "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                { # A tab stop within a paragraph.
+                  "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                  "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+            },
+            "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+              "A String",
+            ],
+            "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+              "a_key": { # A suggested change to a Bullet.
+                "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                  "listId": "A String", # The ID of the list this paragraph belongs to.
+                  "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                  "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                  "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                  "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                    "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                    "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                    "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                    "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                    "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                    "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                    "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                    "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                    "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                    "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                  },
+                },
+              },
+            },
+            "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+              "a_key": { # A suggested change to a ParagraphStyle.
+                "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                  "alignment": "A String", # The text alignment for this paragraph.
+                  "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                  "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                  "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                  "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                  "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                  "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                  "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                  "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                  "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                  },
+                  "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spacingMode": "A String", # The spacing mode for the paragraph.
+                  "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                    { # A tab stop within a paragraph.
+                      "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                      "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                },
+                "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                  "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                  "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                  "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                  "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                  "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                  "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                  "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                  "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                  "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                  "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                  "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                  "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                  "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                  "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                  "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                  "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                  "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                  "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                  },
+                  "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                  "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                  "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                },
+              },
+            },
+            "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+              "a_key": { # A collection of object IDs.
+                "objectIds": [ # The object IDs.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+            "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+              "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                { # Properties that apply to a section's column.
+                  "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+              "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+              "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+              "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+              "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+              "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+              "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+              "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "sectionType": "A String", # Output only. The type of section.
+              "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            },
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+          "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+          "table": { # A StructuralElement representing a table. # A table type of structural element.
+            "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+            "rows": 42, # Number of rows in the table.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+            "tableRows": [ # The contents and style of each row.
+              { # The contents and style of a row in a Table.
+                "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TableRowStyle.
+                    "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
+                    },
+                    "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                      "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                    },
+                  },
+                },
+                "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                  { # The contents and style of a cell in a Table.
+                    "content": [ # The content of the cell.
+                      # Object with schema name: StructuralElement
+                    ],
+                    "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableCellStyle.
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                        "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                          "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                          "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                          "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                          "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                          "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                          "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                          "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                          "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                          "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                          "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                        },
+                      },
+                    },
+                    "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "columnSpan": 42, # The column span of the cell. This property is read-only.
+                      "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                      "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "rowSpan": 42, # The row span of the cell. This property is read-only.
+                    },
+                  },
+                ],
+                "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                  "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                  "tableHeader": True or False, # Whether the row is a table header.
+                },
+              },
+            ],
+            "tableStyle": { # Styles that apply to a table. # The style of the table.
+              "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                { # The properties of a column in a table.
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "widthType": "A String", # The width type of the column.
+                },
+              ],
+            },
+          },
+          "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+            "content": [ # The content of the table of contents.
+              # Object with schema name: StructuralElement
+            ],
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+        },
+      ],
+      "footerId": "A String", # The ID of the footer.
+    },
+  },
+  "footnotes": { # Output only. The footnotes in the document, keyed by footnote ID.
+    "a_key": { # A document footnote.
+      "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero.
+        { # A StructuralElement describes content that provides structure to the document.
+          "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+          "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+            "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+              "listId": "A String", # The ID of the list this paragraph belongs to.
+              "nestingLevel": 42, # The nesting level of this paragraph in the list.
+              "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                "bold": True or False, # Whether or not the text is rendered as bold.
+                "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "italic": True or False, # Whether or not the text is italicized.
+                "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                  "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a bookmark in this document.
+                    "tabId": "A String", # The ID of the tab containing this bookmark.
+                  },
+                  "bookmarkId": "A String", # The ID of a bookmark in this document.
+                  "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of the tab containing this heading.
+                  },
+                  "headingId": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of a tab in this document.
+                  "url": "A String", # An external URL.
+                },
+                "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                "strikethrough": True or False, # Whether or not the text is struck through.
+                "underline": True or False, # Whether or not the text is underlined.
+                "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                  "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                  "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                },
+              },
+            },
+            "elements": [ # The content of the paragraph, broken down into its component parts.
+              { # A ParagraphElement describes content within a Paragraph.
+                "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                  "type": "A String", # The type of this auto text.
+                },
+                "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                },
+                "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                  "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                  "footnoteNumber": "A String", # The rendered number of this footnote.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                  "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                  "personId": "A String", # Output only. The unique ID of this link.
+                  "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                    "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                    "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                  "richLinkId": "A String", # Output only. The ID of this link.
+                  "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                    "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                    "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                    "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                  "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+              },
+            ],
+            "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+              "alignment": "A String", # The text alignment for this paragraph.
+              "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+              "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+              "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+              "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+              "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+              "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+              "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+              "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+              "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+              },
+              "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spacingMode": "A String", # The spacing mode for the paragraph.
+              "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                { # A tab stop within a paragraph.
+                  "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                  "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+            },
+            "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+              "A String",
+            ],
+            "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+              "a_key": { # A suggested change to a Bullet.
+                "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                  "listId": "A String", # The ID of the list this paragraph belongs to.
+                  "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                  "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                  "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                  "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                    "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                    "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                    "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                    "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                    "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                    "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                    "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                    "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                    "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                    "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                  },
+                },
+              },
+            },
+            "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+              "a_key": { # A suggested change to a ParagraphStyle.
+                "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                  "alignment": "A String", # The text alignment for this paragraph.
+                  "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                  "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                  "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                  "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                  "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                  "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                  "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                  "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                  "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                  },
+                  "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spacingMode": "A String", # The spacing mode for the paragraph.
+                  "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                    { # A tab stop within a paragraph.
+                      "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                      "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                },
+                "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                  "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                  "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                  "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                  "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                  "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                  "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                  "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                  "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                  "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                  "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                  "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                  "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                  "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                  "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                  "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                  "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                  "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                  "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                  },
+                  "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                  "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                  "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                },
+              },
+            },
+            "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+              "a_key": { # A collection of object IDs.
+                "objectIds": [ # The object IDs.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+            "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+              "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                { # Properties that apply to a section's column.
+                  "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+              "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+              "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+              "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+              "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+              "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+              "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+              "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "sectionType": "A String", # Output only. The type of section.
+              "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            },
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+          "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+          "table": { # A StructuralElement representing a table. # A table type of structural element.
+            "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+            "rows": 42, # Number of rows in the table.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+            "tableRows": [ # The contents and style of each row.
+              { # The contents and style of a row in a Table.
+                "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TableRowStyle.
+                    "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
+                    },
+                    "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                      "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                    },
+                  },
+                },
+                "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                  { # The contents and style of a cell in a Table.
+                    "content": [ # The content of the cell.
+                      # Object with schema name: StructuralElement
+                    ],
+                    "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableCellStyle.
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                        "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                          "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                          "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                          "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                          "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                          "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                          "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                          "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                          "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                          "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                          "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                        },
+                      },
+                    },
+                    "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "columnSpan": 42, # The column span of the cell. This property is read-only.
+                      "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                      "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "rowSpan": 42, # The row span of the cell. This property is read-only.
+                    },
+                  },
+                ],
+                "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                  "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                  "tableHeader": True or False, # Whether the row is a table header.
+                },
+              },
+            ],
+            "tableStyle": { # Styles that apply to a table. # The style of the table.
+              "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                { # The properties of a column in a table.
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "widthType": "A String", # The width type of the column.
+                },
+              ],
+            },
+          },
+          "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+            "content": [ # The content of the table of contents.
+              # Object with schema name: StructuralElement
+            ],
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+        },
+      ],
+      "footnoteId": "A String", # The ID of the footnote.
+    },
+  },
+  "headers": { # Output only. The headers in the document, keyed by header ID.
+    "a_key": { # A document header.
+      "content": [ # The contents of the header. The indexes for a header's content begin at zero.
+        { # A StructuralElement describes content that provides structure to the document.
+          "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+          "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+            "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+              "listId": "A String", # The ID of the list this paragraph belongs to.
+              "nestingLevel": 42, # The nesting level of this paragraph in the list.
+              "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                "bold": True or False, # Whether or not the text is rendered as bold.
+                "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "italic": True or False, # Whether or not the text is italicized.
+                "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                  "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a bookmark in this document.
+                    "tabId": "A String", # The ID of the tab containing this bookmark.
+                  },
+                  "bookmarkId": "A String", # The ID of a bookmark in this document.
+                  "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                    "id": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of the tab containing this heading.
+                  },
+                  "headingId": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of a tab in this document.
+                  "url": "A String", # An external URL.
+                },
+                "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                "strikethrough": True or False, # Whether or not the text is struck through.
+                "underline": True or False, # Whether or not the text is underlined.
+                "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                  "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                  "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                },
+              },
+            },
+            "elements": [ # The content of the paragraph, broken down into its component parts.
+              { # A ParagraphElement describes content within a Paragraph.
+                "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                  "type": "A String", # The type of this auto text.
+                },
+                "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                },
+                "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                  "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                  "footnoteNumber": "A String", # The rendered number of this footnote.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                  "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                  "personId": "A String", # Output only. The unique ID of this link.
+                  "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                    "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                    "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                  "richLinkId": "A String", # Output only. The ID of this link.
+                  "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                    "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                    "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                    "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                  },
+                  "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                  "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a TextStyle.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+              },
+            ],
+            "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+              "alignment": "A String", # The text alignment for this paragraph.
+              "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+              "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+              "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+              "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+              "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+              "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+              "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+              "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+              "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+              },
+              "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spacingMode": "A String", # The spacing mode for the paragraph.
+              "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                { # A tab stop within a paragraph.
+                  "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                  "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+            },
+            "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+              "A String",
+            ],
+            "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+              "a_key": { # A suggested change to a Bullet.
+                "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                  "listId": "A String", # The ID of the list this paragraph belongs to.
+                  "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                  "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                  "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                  "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                    "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                    "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                    "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                    "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                    "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                    "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                    "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                    "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                    "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                    "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                  },
+                },
+              },
+            },
+            "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+              "a_key": { # A suggested change to a ParagraphStyle.
+                "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                  "alignment": "A String", # The text alignment for this paragraph.
+                  "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                  "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                  "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                  "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                  "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                  "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                  "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                  "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                  "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                  },
+                  "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spacingMode": "A String", # The spacing mode for the paragraph.
+                  "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                    { # A tab stop within a paragraph.
+                      "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                      "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                },
+                "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                  "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                  "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                  "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                  "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                  "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                  "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                  "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                  "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                  "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                  "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                  "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                  "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                  "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                  "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                  "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                  "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                  "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                  "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                    "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                  },
+                  "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                  "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                  "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                },
+              },
+            },
+            "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+              "a_key": { # A collection of object IDs.
+                "objectIds": [ # The object IDs.
+                  "A String",
+                ],
+              },
+            },
+          },
+          "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+            "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+              "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                { # Properties that apply to a section's column.
+                  "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+              "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+              "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+              "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+              "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+              "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+              "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+              "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+              "sectionType": "A String", # Output only. The type of section.
+              "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+            },
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+          "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+          "table": { # A StructuralElement representing a table. # A table type of structural element.
+            "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+            "rows": 42, # Number of rows in the table.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+            "tableRows": [ # The contents and style of each row.
+              { # The contents and style of a row in a Table.
+                "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a TableRowStyle.
+                    "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
+                    },
+                    "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                      "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                    },
+                  },
+                },
+                "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                  { # The contents and style of a cell in a Table.
+                    "content": [ # The content of the cell.
+                      # Object with schema name: StructuralElement
+                    ],
+                    "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableCellStyle.
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                        "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                          "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                          "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                          "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                          "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                          "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                          "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                          "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                          "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                          "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                          "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                        },
+                      },
+                    },
+                    "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "columnSpan": 42, # The column span of the cell. This property is read-only.
+                      "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                      "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "rowSpan": 42, # The row span of the cell. This property is read-only.
+                    },
+                  },
+                ],
+                "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                  "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                  "tableHeader": True or False, # Whether the row is a table header.
+                },
+              },
+            ],
+            "tableStyle": { # Styles that apply to a table. # The style of the table.
+              "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                { # The properties of a column in a table.
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "widthType": "A String", # The width type of the column.
+                },
+              ],
+            },
+          },
+          "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+            "content": [ # The content of the table of contents.
+              # Object with schema name: StructuralElement
+            ],
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+              "A String",
+            ],
+          },
+        },
+      ],
+      "headerId": "A String", # The ID of the header.
+    },
+  },
+  "inlineObjects": { # Output only. The inline objects in the document, keyed by object ID.
+    "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.
+      "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object.
+        "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object.
+          "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+          "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+          },
+          "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "propertyState": "A String", # The property state of the border property.
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "imageProperties": { # The properties of an image. # The properties of an image.
+            "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+            "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+            "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+            "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+            "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+              "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+              "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+              "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+              "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+              "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+            },
+            "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+            "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+          },
+          "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+            "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+              "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+              "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+            },
+          },
+          "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "size": { # A width and height. # The visible size of the image after cropping.
+            "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+        },
+      },
+      "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties.
+      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+        "A String",
+      ],
+      "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID.
+        "a_key": { # A suggested change to InlineObjectProperties.
+          "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values.
+            "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object.
+              "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+              "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+              },
+              "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "propertyState": "A String", # The property state of the border property.
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "imageProperties": { # The properties of an image. # The properties of an image.
+                "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+                "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+                "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+                  "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+                  "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+                  "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+                  "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+                  "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+                },
+                "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+                "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+              },
+              "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+                "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+                  "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+                  "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+                },
+              },
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "size": { # A width and height. # The visible size of the image after cropping.
+                "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+            },
+          },
+          "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion.
+            "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion.
+              "descriptionSuggested": True or False, # Indicates if there was a suggested change to description.
+              "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion.
+              },
+              "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion.
+                "colorSuggested": True or False, # Indicates if there was a suggested change to color.
+                "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style.
+                "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state.
+                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+              },
+              "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion.
+                "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness.
+                "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri.
+                "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast.
+                "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion.
+                  "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                  "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom.
+                  "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left.
+                  "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right.
+                  "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top.
+                },
+                "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri.
+                "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency.
+              },
+              "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion.
+                "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion.
+                  "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id.
+                  "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id.
+                },
+              },
+              "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
+              "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
+              "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
+              "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
+              "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
+                "heightSuggested": True or False, # Indicates if there was a suggested change to height.
+                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+              },
+              "titleSuggested": True or False, # Indicates if there was a suggested change to title.
+            },
+          },
+        },
+      },
+      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
+    },
+  },
+  "lists": { # Output only. The lists in the document, keyed by list ID.
+    "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet.
+      "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list.
+        "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
+          { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
+            "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
+            "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
+            "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
+            "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
+            "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
+            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
+              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+              "bold": True or False, # Whether or not the text is rendered as bold.
+              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "italic": True or False, # Whether or not the text is italicized.
+              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a bookmark in this document.
+                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                },
+                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of the tab containing this heading.
+                },
+                "headingId": "A String", # The ID of a heading in this document.
+                "tabId": "A String", # The ID of a tab in this document.
+                "url": "A String", # An external URL.
+              },
+              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+              "strikethrough": True or False, # Whether or not the text is struck through.
+              "underline": True or False, # Whether or not the text is underlined.
+              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+              },
+            },
+          },
+        ],
+      },
+      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list.
+        "A String",
+      ],
+      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
+      "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID.
+        "a_key": { # A suggested change to ListProperties.
+          "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values.
+            "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
+              { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
+                "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
+                "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
+                "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
+                "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
+                "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
+                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                  "bold": True or False, # Whether or not the text is rendered as bold.
+                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "italic": True or False, # Whether or not the text is italicized.
+                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                    "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a bookmark in this document.
+                      "tabId": "A String", # The ID of the tab containing this bookmark.
+                    },
+                    "bookmarkId": "A String", # The ID of a bookmark in this document.
+                    "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                      "id": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of the tab containing this heading.
+                    },
+                    "headingId": "A String", # The ID of a heading in this document.
+                    "tabId": "A String", # The ID of a tab in this document.
+                    "url": "A String", # An external URL.
+                  },
+                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                  "strikethrough": True or False, # Whether or not the text is struck through.
+                  "underline": True or False, # Whether or not the text is underlined.
+                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                  },
+                },
+              },
+            ],
+          },
+          "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion.
+            "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.
+              { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.
+                "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment.
+                "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format.
+                "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol.
+                "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type.
+                "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number.
+                "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                  "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                  "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                  "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                  "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                  "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                  "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                  "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                  "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                  "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                  "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                  "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                },
+              },
+            ],
+          },
+        },
+      },
+    },
+  },
+  "namedRanges": { # Output only. The named ranges in the document, keyed by name.
+    "a_key": { # A collection of all the NamedRanges in the document that share a given name.
+      "name": "A String", # The name that all the named ranges share.
+      "namedRanges": [ # The NamedRanges that share the same name.
+        { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.
+          "name": "A String", # The name of the named range.
+          "namedRangeId": "A String", # The ID of the named range.
+          "ranges": [ # The ranges that belong to this named range.
+            { # Specifies a contiguous range of text.
+              "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
+              "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.
+              "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
+              "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
+            },
+          ],
+        },
+      ],
+    },
+  },
+  "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # Output only. The named styles of the document.
+    "styles": [ # The named styles. There's an entry for each of the possible named style types.
+      { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.
+        "namedStyleType": "A String", # The type of this named style.
+        "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style.
+          "alignment": "A String", # The text alignment for this paragraph.
+          "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+          "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+          "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+          "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+          "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+          "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+          "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+          "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+          "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+          },
+          "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "spacingMode": "A String", # The spacing mode for the paragraph.
+          "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+            { # A tab stop within a paragraph.
+              "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+              "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+          ],
+        },
+        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style.
+          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+              "rgbColor": { # An RGB color. # The RGB color value.
+                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+              },
+            },
+          },
+          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+          "bold": True or False, # Whether or not the text is rendered as bold.
+          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+              "rgbColor": { # An RGB color. # The RGB color value.
+                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+              },
+            },
+          },
+          "italic": True or False, # Whether or not the text is italicized.
+          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+              "id": "A String", # The ID of a bookmark in this document.
+              "tabId": "A String", # The ID of the tab containing this bookmark.
+            },
+            "bookmarkId": "A String", # The ID of a bookmark in this document.
+            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+              "id": "A String", # The ID of a heading in this document.
+              "tabId": "A String", # The ID of the tab containing this heading.
+            },
+            "headingId": "A String", # The ID of a heading in this document.
+            "tabId": "A String", # The ID of a tab in this document.
+            "url": "A String", # An external URL.
+          },
+          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+          "strikethrough": True or False, # Whether or not the text is struck through.
+          "underline": True or False, # Whether or not the text is underlined.
+          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+          },
+        },
+      },
+    ],
+  },
+  "positionedObjects": { # Output only. The positioned objects in the document, keyed by object ID.
+    "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.
+      "objectId": "A String", # The ID of this positioned object.
+      "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object.
+        "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object.
+          "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+          "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+          },
+          "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                },
+              },
+            },
+            "dashStyle": "A String", # The dash style of the border.
+            "propertyState": "A String", # The property state of the border property.
+            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "imageProperties": { # The properties of an image. # The properties of an image.
+            "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+            "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+            "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+            "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+            "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+              "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+              "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+              "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+              "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+              "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+            },
+            "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+            "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+          },
+          "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+            "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+              "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+              "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+            },
+          },
+          "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "size": { # A width and height. # The visible size of the image after cropping.
+            "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+        },
+        "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.
+          "layout": "A String", # The layout of this positioned object.
+          "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+        },
+      },
+      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+        "A String",
+      ],
+      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
+      "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID.
+        "a_key": { # A suggested change to PositionedObjectProperties.
+          "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values.
+            "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object.
+              "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+              "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+              },
+              "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "propertyState": "A String", # The property state of the border property.
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "imageProperties": { # The properties of an image. # The properties of an image.
+                "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+                "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+                "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+                  "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+                  "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+                  "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+                  "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+                  "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+                },
+                "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+                "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+              },
+              "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+                "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+                  "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+                  "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+                },
+              },
+              "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "size": { # A width and height. # The visible size of the image after cropping.
+                "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+            },
+            "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.
+              "layout": "A String", # The layout of this positioned object.
+              "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+            },
+          },
+          "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion.
+            "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion.
+              "descriptionSuggested": True or False, # Indicates if there was a suggested change to description.
+              "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion.
+              },
+              "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion.
+                "colorSuggested": True or False, # Indicates if there was a suggested change to color.
+                "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style.
+                "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state.
+                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+              },
+              "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion.
+                "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness.
+                "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri.
+                "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast.
+                "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion.
+                  "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                  "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom.
+                  "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left.
+                  "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right.
+                  "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top.
+                },
+                "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri.
+                "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency.
+              },
+              "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion.
+                "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion.
+                  "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id.
+                  "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id.
+                },
+              },
+              "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
+              "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
+              "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
+              "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
+              "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
+                "heightSuggested": True or False, # Indicates if there was a suggested change to height.
+                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+              },
+              "titleSuggested": True or False, # Indicates if there was a suggested change to title.
+            },
+            "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion.
+              "layoutSuggested": True or False, # Indicates if there was a suggested change to layout.
+              "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset.
+              "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset.
+            },
+          },
+        },
+      },
+    },
+  },
+  "revisionId": "A String", # Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes.
+  "suggestedDocumentStyleChanges": { # Output only. The suggested changes to the style of the document, keyed by suggestion ID.
+    "a_key": { # A suggested change to the DocumentStyle.
+      "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values.
+        "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color.
+          "color": { # A color that can either be fully opaque or fully transparent. # The background color.
+            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+              "rgbColor": { # An RGB color. # The RGB color value.
+                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+              },
+            },
+          },
+        },
+        "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only.
+        "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only.
+        "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only.
+        "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only.
+        "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only.
+        "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.
+        "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape.
+        "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles.
+          "magnitude": 3.14, # The magnitude.
+          "unit": "A String", # The units for magnitude.
+        },
+        "pageNumberStart": 42, # The page number from which to start counting the number of pages.
+        "pageSize": { # A width and height. # The size of a page in the document.
+          "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+        },
+        "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only.
+        "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages.
+        "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page.
+      },
+      "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion.
+        "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion.
+          "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion.
+        },
+        "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id.
+        "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id.
+        "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id.
+        "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id.
+        "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id.
+        "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id.
+        "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation.
+        "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
+        "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer.
+        "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header.
+        "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
+        "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
+        "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
+        "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start.
+        "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
+          "heightSuggested": True or False, # Indicates if there was a suggested change to height.
+          "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+        },
+        "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins.
+        "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer.
+        "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer.
+      },
+    },
+  },
+  "suggestedNamedStylesChanges": { # Output only. The suggested changes to the named styles of the document, keyed by suggestion ID.
+    "a_key": { # A suggested change to the NamedStyles.
+      "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values.
+        "styles": [ # The named styles. There's an entry for each of the possible named style types.
+          { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.
+            "namedStyleType": "A String", # The type of this named style.
+            "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style.
+              "alignment": "A String", # The text alignment for this paragraph.
+              "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+              "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+                "dashStyle": "A String", # The dash style of the border.
+                "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+              },
+              "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+              "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+              "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+              "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+              "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+              "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+              "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+              "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                    "rgbColor": { # An RGB color. # The RGB color value.
+                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                    },
+                  },
+                },
+              },
+              "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                "magnitude": 3.14, # The magnitude.
+                "unit": "A String", # The units for magnitude.
+              },
+              "spacingMode": "A String", # The spacing mode for the paragraph.
+              "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                { # A tab stop within a paragraph.
+                  "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                  "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+              ],
+            },
+            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style.
+              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+              "bold": True or False, # Whether or not the text is rendered as bold.
+              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
                 "magnitude": 3.14, # The magnitude.
                 "unit": "A String", # The units for magnitude.
               },
-              "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
-                "magnitude": 3.14, # The magnitude.
-                "unit": "A String", # The units for magnitude.
+              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                  "rgbColor": { # An RGB color. # The RGB color value.
+                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  },
+                },
+              },
+              "italic": True or False, # Whether or not the text is italicized.
+              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a bookmark in this document.
+                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                },
+                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                  "id": "A String", # The ID of a heading in this document.
+                  "tabId": "A String", # The ID of the tab containing this heading.
+                },
+                "headingId": "A String", # The ID of a heading in this document.
+                "tabId": "A String", # The ID of a tab in this document.
+                "url": "A String", # An external URL.
+              },
+              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+              "strikethrough": True or False, # Whether or not the text is struck through.
+              "underline": True or False, # Whether or not the text is underlined.
+              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+              },
+            },
+          },
+        ],
+      },
+      "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion.
+        "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion.
+          { # A suggestion state of a NamedStyle message.
+            "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle.
+            "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion.
+              "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+              "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+              "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+              "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+              "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+              "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+              "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+              "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+              "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+              "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+              "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+              "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+              "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+              "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+              "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+              "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+              "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+              "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+              },
+              "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+              "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+              "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+            },
+            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+            },
+          },
+        ],
+      },
+    },
+  },
+  "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE.
+  "tabs": [ # Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.child_tabs field.
+    { # A tab in a document.
+      "childTabs": [ # The child tabs nested within this tab.
+        # Object with schema name: Tab
+      ],
+      "documentTab": { # A tab with document contents. # A tab with document contents, like text and images.
+        "body": { # The document body. The body typically contains the full document contents except for headers, footers, and footnotes. # The main body of the document tab.
+          "content": [ # The contents of the body. The indexes for the body's content begin at zero.
+            { # A StructuralElement describes content that provides structure to the document.
+              "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+              "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+                "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+                  "listId": "A String", # The ID of the list this paragraph belongs to.
+                  "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+                "elements": [ # The content of the paragraph, broken down into its component parts.
+                  { # A ParagraphElement describes content within a Paragraph.
+                    "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                      "type": "A String", # The type of this auto text.
+                    },
+                    "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                    "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                    },
+                    "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                      "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                      "footnoteNumber": "A String", # The rendered number of this footnote.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                      "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                      "personId": "A String", # Output only. The unique ID of this link.
+                      "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                        "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                        "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                      },
+                      "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                      "richLinkId": "A String", # Output only. The ID of this link.
+                      "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                        "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                        "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                        "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                      },
+                      "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                    "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                      "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TextStyle.
+                          "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                            "bold": True or False, # Whether or not the text is rendered as bold.
+                            "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "italic": True or False, # Whether or not the text is italicized.
+                            "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                              "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a bookmark in this document.
+                                "tabId": "A String", # The ID of the tab containing this bookmark.
+                              },
+                              "bookmarkId": "A String", # The ID of a bookmark in this document.
+                              "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                "id": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of the tab containing this heading.
+                              },
+                              "headingId": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of a tab in this document.
+                              "url": "A String", # An external URL.
+                            },
+                            "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                            "strikethrough": True or False, # Whether or not the text is struck through.
+                            "underline": True or False, # Whether or not the text is underlined.
+                            "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                              "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                              "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                            },
+                          },
+                          "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                            "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                            "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                            "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                            "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                            "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                            "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                            "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                            "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                            "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                            "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                            "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                          },
+                        },
+                      },
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                  },
+                ],
+                "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+                  "alignment": "A String", # The text alignment for this paragraph.
+                  "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                  "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                    "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "dashStyle": "A String", # The dash style of the border.
+                    "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                  "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                  "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                  "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                  "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                  "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                  "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                  "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                  "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                  },
+                  "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "spacingMode": "A String", # The spacing mode for the paragraph.
+                  "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                    { # A tab stop within a paragraph.
+                      "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                      "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                },
+                "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+                  "A String",
+                ],
+                "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+                  "a_key": { # A suggested change to a Bullet.
+                    "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                      "listId": "A String", # The ID of the list this paragraph belongs to.
+                      "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                    "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                      "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                      "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  },
+                },
+                "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+                  "a_key": { # A suggested change to a ParagraphStyle.
+                    "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                      "alignment": "A String", # The text alignment for this paragraph.
+                      "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                      "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                        "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "dashStyle": "A String", # The dash style of the border.
+                        "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                      "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                      "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                      "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                      "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                      "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                      "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                      "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                      "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                      },
+                      "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "spacingMode": "A String", # The spacing mode for the paragraph.
+                      "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                        { # A tab stop within a paragraph.
+                          "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                          "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                      ],
+                    },
+                    "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                      "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                      "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                      "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                      "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                      "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                      "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                      "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                      "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                      "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                      "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                      "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                      "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                      "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                      "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                      "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                      "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                      "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                      "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                      },
+                      "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                      "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                      "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                    },
+                  },
+                },
+                "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+                  "a_key": { # A collection of object IDs.
+                    "objectIds": [ # The object IDs.
+                      "A String",
+                    ],
+                  },
+                },
+              },
+              "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+                "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+                  "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                    { # Properties that apply to a section's column.
+                      "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                  ],
+                  "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+                  "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+                  "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+                  "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+                  "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+                  "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+                  "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  "sectionType": "A String", # Output only. The type of section.
+                  "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                },
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+              },
+              "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+              "table": { # A StructuralElement representing a table. # A table type of structural element.
+                "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+                "rows": 42, # Number of rows in the table.
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
+                "tableRows": [ # The contents and style of each row.
+                  { # The contents and style of a row in a Table.
+                    "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                    "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                    "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                      "A String",
+                    ],
+                    "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                      "A String",
+                    ],
+                    "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                      "a_key": { # A suggested change to a TableRowStyle.
+                        "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                          "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                          "tableHeader": True or False, # Whether the row is a table header.
+                        },
+                        "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                          "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                        },
+                      },
+                    },
+                    "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                      { # The contents and style of a cell in a Table.
+                        "content": [ # The content of the cell.
+                          # Object with schema name: StructuralElement
+                        ],
+                        "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                        "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TableCellStyle.
+                            "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "dashStyle": "A String", # The dash style of the border.
+                                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                              },
+                              "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "dashStyle": "A String", # The dash style of the border.
+                                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                              },
+                              "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "dashStyle": "A String", # The dash style of the border.
+                                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                              },
+                              "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "dashStyle": "A String", # The dash style of the border.
+                                "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                              },
+                              "columnSpan": 42, # The column span of the cell. This property is read-only.
+                              "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                              "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "rowSpan": 42, # The row span of the cell. This property is read-only.
+                            },
+                            "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                              "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                              "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                              "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                              "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                              "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                              "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                              "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                              "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                              "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                              "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                            },
+                          },
+                        },
+                        "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "dashStyle": "A String", # The dash style of the border.
+                            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                          "columnSpan": 42, # The column span of the cell. This property is read-only.
+                          "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                          "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "rowSpan": 42, # The row span of the cell. This property is read-only.
+                        },
+                      },
+                    ],
+                    "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                      "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                      "tableHeader": True or False, # Whether the row is a table header.
+                    },
+                  },
+                ],
+                "tableStyle": { # Styles that apply to a table. # The style of the table.
+                  "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                    { # The properties of a column in a table.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "widthType": "A String", # The width type of the column.
+                    },
+                  ],
+                },
+              },
+              "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+                "content": [ # The content of the table of contents.
+                  # Object with schema name: StructuralElement
+                ],
+                "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                  "A String",
+                ],
+                "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                  "A String",
+                ],
               },
-              "size": { # A width and height. # The visible size of the image after cropping.
-                "height": { # A magnitude in a single direction in the specified units. # The height of the object.
-                  "magnitude": 3.14, # The magnitude.
-                  "unit": "A String", # The units for magnitude.
+            },
+          ],
+        },
+        "documentStyle": { # The style of the document. # The style of the document tab.
+          "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color.
+            "color": { # A color that can either be fully opaque or fully transparent. # The background color.
+              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                "rgbColor": { # An RGB color. # The RGB color value.
+                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
                 },
-                "width": { # A magnitude in a single direction in the specified units. # The width of the object.
-                  "magnitude": 3.14, # The magnitude.
-                  "unit": "A String", # The units for magnitude.
+              },
+            },
+          },
+          "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only.
+          "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only.
+          "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only.
+          "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only.
+          "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only.
+          "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.
+          "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape.
+          "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles.
+            "magnitude": 3.14, # The magnitude.
+            "unit": "A String", # The units for magnitude.
+          },
+          "pageNumberStart": 42, # The page number from which to start counting the number of pages.
+          "pageSize": { # A width and height. # The size of a page in the document.
+            "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+            "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+              "magnitude": 3.14, # The magnitude.
+              "unit": "A String", # The units for magnitude.
+            },
+          },
+          "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only.
+          "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages.
+          "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page.
+        },
+        "footers": { # The footers in the document tab, keyed by footer ID.
+          "a_key": { # A document footer.
+            "content": [ # The contents of the footer. The indexes for a footer's content begin at zero.
+              { # A StructuralElement describes content that provides structure to the document.
+                "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+                "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+                  "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+                    "listId": "A String", # The ID of the list this paragraph belongs to.
+                    "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                  },
+                  "elements": [ # The content of the paragraph, broken down into its component parts.
+                    { # A ParagraphElement describes content within a Paragraph.
+                      "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                        "type": "A String", # The type of this auto text.
+                      },
+                      "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                      "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                      },
+                      "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                        "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                        "footnoteNumber": "A String", # The rendered number of this footnote.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                        "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                        "personId": "A String", # Output only. The unique ID of this link.
+                        "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                          "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                          "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                        "richLinkId": "A String", # Output only. The ID of this link.
+                        "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                          "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                          "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                          "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                      "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                        "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                    },
+                  ],
+                  "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+                    "alignment": "A String", # The text alignment for this paragraph.
+                    "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                    "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                    "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                    "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                    "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                    "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                    "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                    "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                    "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                    },
+                    "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spacingMode": "A String", # The spacing mode for the paragraph.
+                    "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                      { # A tab stop within a paragraph.
+                        "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                        "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
+                  },
+                  "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+                    "A String",
+                  ],
+                  "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+                    "a_key": { # A suggested change to a Bullet.
+                      "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                        "listId": "A String", # The ID of the list this paragraph belongs to.
+                        "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                        "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                        "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                        "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                          "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                          "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                          "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                          "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                          "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                          "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                          "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                          "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                          "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                        },
+                      },
+                    },
+                  },
+                  "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a ParagraphStyle.
+                      "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                        "alignment": "A String", # The text alignment for this paragraph.
+                        "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                        "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                        "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                        "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                        "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                        "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                        "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                        "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                        "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                        },
+                        "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spacingMode": "A String", # The spacing mode for the paragraph.
+                        "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                          { # A tab stop within a paragraph.
+                            "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                            "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                        ],
+                      },
+                      "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                        "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                        "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                        "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                        "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                        "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                        "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                        "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                        "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                        "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                        "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                        "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                        "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                        "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                        "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                        "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                        "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                        "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                        "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                        },
+                        "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                        "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                        "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                      },
+                    },
+                  },
+                  "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A collection of object IDs.
+                      "objectIds": [ # The object IDs.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+                  "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+                    "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                      { # Properties that apply to a section's column.
+                        "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
+                    "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+                    "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+                    "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+                    "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+                    "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+                    "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+                    "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "sectionType": "A String", # Output only. The type of section.
+                    "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                  },
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
-              },
-              "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
-            },
-          },
-          "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion.
-            "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion.
-              "descriptionSuggested": True or False, # Indicates if there was a suggested change to description.
-              "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion.
-              },
-              "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion.
-                "colorSuggested": True or False, # Indicates if there was a suggested change to color.
-                "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style.
-                "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state.
-                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
-              },
-              "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion.
-                "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
-                "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness.
-                "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri.
-                "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast.
-                "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion.
-                  "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
-                  "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom.
-                  "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left.
-                  "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right.
-                  "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top.
+                "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+                "table": { # A StructuralElement representing a table. # A table type of structural element.
+                  "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+                  "rows": 42, # Number of rows in the table.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "tableRows": [ # The contents and style of each row.
+                    { # The contents and style of a row in a Table.
+                      "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                      "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TableRowStyle.
+                          "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                            "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                            "tableHeader": True or False, # Whether the row is a table header.
+                          },
+                          "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                            "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                          },
+                        },
+                      },
+                      "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                        { # The contents and style of a cell in a Table.
+                          "content": [ # The content of the cell.
+                            # Object with schema name: StructuralElement
+                          ],
+                          "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                          "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                            "A String",
+                          ],
+                          "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                            "A String",
+                          ],
+                          "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                            "a_key": { # A suggested change to a TableCellStyle.
+                              "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "columnSpan": 42, # The column span of the cell. This property is read-only.
+                                "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                                "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "rowSpan": 42, # The row span of the cell. This property is read-only.
+                              },
+                              "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                                "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                                "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                                "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                                "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                                "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                                "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                                "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                                "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                                "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                                "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                                "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                                "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                              },
+                            },
+                          },
+                          "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "columnSpan": 42, # The column span of the cell. This property is read-only.
+                            "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                            "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "rowSpan": 42, # The row span of the cell. This property is read-only.
+                          },
+                        },
+                      ],
+                      "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                        "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                        "tableHeader": True or False, # Whether the row is a table header.
+                      },
+                    },
+                  ],
+                  "tableStyle": { # Styles that apply to a table. # The style of the table.
+                    "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                      { # The properties of a column in a table.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "widthType": "A String", # The width type of the column.
+                      },
+                    ],
+                  },
                 },
-                "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri.
-                "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency.
-              },
-              "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion.
-                "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion.
-                  "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id.
-                  "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id.
+                "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+                  "content": [ # The content of the table of contents.
+                    # Object with schema name: StructuralElement
+                  ],
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
               },
-              "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
-              "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
-              "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
-              "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
-              "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
-                "heightSuggested": True or False, # Indicates if there was a suggested change to height.
-                "widthSuggested": True or False, # Indicates if there was a suggested change to width.
-              },
-              "titleSuggested": True or False, # Indicates if there was a suggested change to title.
-            },
+            ],
+            "footerId": "A String", # The ID of the footer.
           },
         },
-      },
-      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
-    },
-  },
-  "lists": { # Output only. The lists in the document, keyed by list ID.
-    "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet.
-      "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list.
-        "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
-          { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
-            "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
-            "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
-            "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
-            "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
-            "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
-            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
-              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                  "rgbColor": { # An RGB color. # The RGB color value.
-                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+        "footnotes": { # The footnotes in the document tab, keyed by footnote ID.
+          "a_key": { # A document footnote.
+            "content": [ # The contents of the footnote. The indexes for a footnote's content begin at zero.
+              { # A StructuralElement describes content that provides structure to the document.
+                "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+                "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+                  "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+                    "listId": "A String", # The ID of the list this paragraph belongs to.
+                    "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                  },
+                  "elements": [ # The content of the paragraph, broken down into its component parts.
+                    { # A ParagraphElement describes content within a Paragraph.
+                      "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                        "type": "A String", # The type of this auto text.
+                      },
+                      "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                      "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                      },
+                      "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                        "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                        "footnoteNumber": "A String", # The rendered number of this footnote.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                        "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                        "personId": "A String", # Output only. The unique ID of this link.
+                        "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                          "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                          "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                        "richLinkId": "A String", # Output only. The ID of this link.
+                        "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                          "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                          "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                          "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                      "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                        "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                    },
+                  ],
+                  "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+                    "alignment": "A String", # The text alignment for this paragraph.
+                    "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                    "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                    "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                    "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                    "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                    "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                    "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                    "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                    "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                    },
+                    "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spacingMode": "A String", # The spacing mode for the paragraph.
+                    "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                      { # A tab stop within a paragraph.
+                        "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                        "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
+                  },
+                  "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+                    "A String",
+                  ],
+                  "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+                    "a_key": { # A suggested change to a Bullet.
+                      "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                        "listId": "A String", # The ID of the list this paragraph belongs to.
+                        "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                        "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                        "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                        "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                          "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                          "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                          "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                          "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                          "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                          "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                          "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                          "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                          "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                        },
+                      },
+                    },
+                  },
+                  "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a ParagraphStyle.
+                      "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                        "alignment": "A String", # The text alignment for this paragraph.
+                        "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                        "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                        "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                        "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                        "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                        "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                        "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                        "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                        "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                        },
+                        "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spacingMode": "A String", # The spacing mode for the paragraph.
+                        "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                          { # A tab stop within a paragraph.
+                            "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                            "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                        ],
+                      },
+                      "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                        "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                        "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                        "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                        "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                        "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                        "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                        "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                        "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                        "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                        "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                        "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                        "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                        "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                        "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                        "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                        "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                        "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                        "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                        },
+                        "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                        "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                        "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                      },
+                    },
+                  },
+                  "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A collection of object IDs.
+                      "objectIds": [ # The object IDs.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+                  "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+                    "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                      { # Properties that apply to a section's column.
+                        "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
+                    "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+                    "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+                    "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+                    "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+                    "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+                    "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+                    "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "sectionType": "A String", # Output only. The type of section.
+                    "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
                   },
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
-              },
-              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-              "bold": True or False, # Whether or not the text is rendered as bold.
-              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-                "magnitude": 3.14, # The magnitude.
-                "unit": "A String", # The units for magnitude.
-              },
-              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                  "rgbColor": { # An RGB color. # The RGB color value.
-                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+                "table": { # A StructuralElement representing a table. # A table type of structural element.
+                  "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+                  "rows": 42, # Number of rows in the table.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "tableRows": [ # The contents and style of each row.
+                    { # The contents and style of a row in a Table.
+                      "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                      "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TableRowStyle.
+                          "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                            "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                            "tableHeader": True or False, # Whether the row is a table header.
+                          },
+                          "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                            "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                          },
+                        },
+                      },
+                      "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                        { # The contents and style of a cell in a Table.
+                          "content": [ # The content of the cell.
+                            # Object with schema name: StructuralElement
+                          ],
+                          "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                          "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                            "A String",
+                          ],
+                          "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                            "A String",
+                          ],
+                          "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                            "a_key": { # A suggested change to a TableCellStyle.
+                              "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "columnSpan": 42, # The column span of the cell. This property is read-only.
+                                "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                                "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "rowSpan": 42, # The row span of the cell. This property is read-only.
+                              },
+                              "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                                "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                                "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                                "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                                "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                                "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                                "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                                "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                                "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                                "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                                "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                                "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                                "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                              },
+                            },
+                          },
+                          "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "columnSpan": 42, # The column span of the cell. This property is read-only.
+                            "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                            "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "rowSpan": 42, # The row span of the cell. This property is read-only.
+                          },
+                        },
+                      ],
+                      "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                        "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                        "tableHeader": True or False, # Whether the row is a table header.
+                      },
+                    },
+                  ],
+                  "tableStyle": { # Styles that apply to a table. # The style of the table.
+                    "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                      { # The properties of a column in a table.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "widthType": "A String", # The width type of the column.
+                      },
+                    ],
                   },
                 },
+                "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+                  "content": [ # The content of the table of contents.
+                    # Object with schema name: StructuralElement
+                  ],
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                },
               },
-              "italic": True or False, # Whether or not the text is italicized.
-              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                "bookmarkId": "A String", # The ID of a bookmark in this document.
-                "headingId": "A String", # The ID of a heading in this document.
-                "url": "A String", # An external URL.
-              },
-              "smallCaps": True or False, # Whether or not the text is in small capital letters.
-              "strikethrough": True or False, # Whether or not the text is struck through.
-              "underline": True or False, # Whether or not the text is underlined.
-              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-              },
-            },
+            ],
+            "footnoteId": "A String", # The ID of the footnote.
           },
-        ],
-      },
-      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list.
-        "A String",
-      ],
-      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
-      "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID.
-        "a_key": { # A suggested change to ListProperties.
-          "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values.
-            "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
-              { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
-                "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
-                "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
-                "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
-                "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
-                "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
-                  "magnitude": 3.14, # The magnitude.
-                  "unit": "A String", # The units for magnitude.
-                },
-                "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
-                  "magnitude": 3.14, # The magnitude.
-                  "unit": "A String", # The units for magnitude.
-                },
-                "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
-                "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
-                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                      "rgbColor": { # An RGB color. # The RGB color value.
-                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+        },
+        "headers": { # The headers in the document tab, keyed by header ID.
+          "a_key": { # A document header.
+            "content": [ # The contents of the header. The indexes for a header's content begin at zero.
+              { # A StructuralElement describes content that provides structure to the document.
+                "endIndex": 42, # The zero-based end index of this structural element, exclusive, in UTF-16 code units.
+                "paragraph": { # A StructuralElement representing a paragraph. A paragraph is a range of content that's terminated with a newline character. # A paragraph type of structural element.
+                  "bullet": { # Describes the bullet of a paragraph. # The bullet for this paragraph. If not present, the paragraph does not belong to a list.
+                    "listId": "A String", # The ID of the list this paragraph belongs to.
+                    "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                    "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                      "bold": True or False, # Whether or not the text is rendered as bold.
+                      "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "italic": True or False, # Whether or not the text is italicized.
+                      "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                        "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a bookmark in this document.
+                          "tabId": "A String", # The ID of the tab containing this bookmark.
+                        },
+                        "bookmarkId": "A String", # The ID of a bookmark in this document.
+                        "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                          "id": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of the tab containing this heading.
+                        },
+                        "headingId": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of a tab in this document.
+                        "url": "A String", # An external URL.
+                      },
+                      "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                      "strikethrough": True or False, # Whether or not the text is struck through.
+                      "underline": True or False, # Whether or not the text is underlined.
+                      "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                        "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                        "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                      },
+                    },
+                  },
+                  "elements": [ # The content of the paragraph, broken down into its component parts.
+                    { # A ParagraphElement describes content within a Paragraph.
+                      "autoText": { # A ParagraphElement representing a spot in the text that's dynamically replaced with content that can change over time, like a page number. # An auto text paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An AutoText may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this AutoText, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this AutoText.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                        "type": "A String", # The type of this auto text.
+                      },
+                      "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.
+                      "equation": { # A ParagraphElement representing an equation. # An equation paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                      },
+                      "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element.
+                        "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference.
+                        "footnoteNumber": "A String", # The rendered number of this footnote.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element.
+                        "inlineObjectId": "A String", # The ID of the InlineObject this element contains.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address.
+                        "personId": "A String", # Output only. The unique ID of this link.
+                        "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present.
+                          "email": "A String", # Output only. The email address linked to this Person. This field is always present.
+                          "name": "A String", # Output only. The name of the person if it's displayed in the link text instead of the person's email address.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.)
+                        "richLinkId": "A String", # Output only. The ID of this link.
+                        "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present.
+                          "mimeType": "A String", # Output only. The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive).
+                          "title": "A String", # Output only. The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present.
+                          "uri": "A String", # Output only. The URI to the RichLink. This is always present.
+                        },
+                        "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units.
+                      "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element.
+                        "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907.
+                        "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                          "A String",
+                        ],
+                        "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                          "A String",
+                        ],
+                        "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID.
+                          "a_key": { # A suggested change to a TextStyle.
+                            "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values.
+                              "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                              "bold": True or False, # Whether or not the text is rendered as bold.
+                              "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                              "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "italic": True or False, # Whether or not the text is italicized.
+                              "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                                "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a bookmark in this document.
+                                  "tabId": "A String", # The ID of the tab containing this bookmark.
+                                },
+                                "bookmarkId": "A String", # The ID of a bookmark in this document.
+                                "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                                  "id": "A String", # The ID of a heading in this document.
+                                  "tabId": "A String", # The ID of the tab containing this heading.
+                                },
+                                "headingId": "A String", # The ID of a heading in this document.
+                                "tabId": "A String", # The ID of a tab in this document.
+                                "url": "A String", # An external URL.
+                              },
+                              "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                              "strikethrough": True or False, # Whether or not the text is struck through.
+                              "underline": True or False, # Whether or not the text is underlined.
+                              "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                                "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                                "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                              },
+                            },
+                            "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion.
+                              "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                              "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                              "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                              "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                              "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                              "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                              "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                              "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                              "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                              "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                              "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                            },
+                          },
+                        },
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                    },
+                  ],
+                  "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph.
+                    "alignment": "A String", # The text alignment for this paragraph.
+                    "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                    "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
                       },
                     },
+                    "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                    "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                    "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                    "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                    "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                    "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                    "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                    "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                      "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                    },
+                    "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "spacingMode": "A String", # The spacing mode for the paragraph.
+                    "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                      { # A tab stop within a paragraph.
+                        "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                        "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                      },
+                    ],
                   },
-                  "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-                  "bold": True or False, # Whether or not the text is rendered as bold.
-                  "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-                    "magnitude": 3.14, # The magnitude.
-                    "unit": "A String", # The units for magnitude.
-                  },
-                  "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                      "rgbColor": { # An RGB color. # The RGB color value.
-                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph.
+                    "A String",
+                  ],
+                  "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet.
+                    "a_key": { # A suggested change to a Bullet.
+                      "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values.
+                        "listId": "A String", # The ID of the list this paragraph belongs to.
+                        "nestingLevel": 42, # The nesting level of this paragraph in the list.
+                        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                          "bold": True or False, # Whether or not the text is rendered as bold.
+                          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "italic": True or False, # Whether or not the text is italicized.
+                          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                            "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a bookmark in this document.
+                              "tabId": "A String", # The ID of the tab containing this bookmark.
+                            },
+                            "bookmarkId": "A String", # The ID of a bookmark in this document.
+                            "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                              "id": "A String", # The ID of a heading in this document.
+                              "tabId": "A String", # The ID of the tab containing this heading.
+                            },
+                            "headingId": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of a tab in this document.
+                            "url": "A String", # An external URL.
+                          },
+                          "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                          "strikethrough": True or False, # Whether or not the text is struck through.
+                          "underline": True or False, # Whether or not the text is underlined.
+                          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                          },
+                        },
+                      },
+                      "bulletSuggestionState": { # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base Bullet have been changed in this suggestion.
+                        "listIdSuggested": True or False, # Indicates if there was a suggested change to the list_id.
+                        "nestingLevelSuggested": True or False, # Indicates if there was a suggested change to the nesting_level.
+                        "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                          "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                          "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                          "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                          "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                          "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                          "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                          "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                          "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                          "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                          "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                        },
+                      },
+                    },
+                  },
+                  "suggestedParagraphStyleChanges": { # The suggested paragraph style changes to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A suggested change to a ParagraphStyle.
+                      "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A ParagraphStyle that only includes the changes made in this suggestion. This can be used along with the paragraph_style_suggestion_state to see which fields have changed and their new values.
+                        "alignment": "A String", # The text alignment for this paragraph.
+                        "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                        "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                          "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                          "dashStyle": "A String", # The dash style of the border.
+                          "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                          "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                            "magnitude": 3.14, # The magnitude.
+                            "unit": "A String", # The units for magnitude.
+                          },
+                        },
+                        "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                        "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                        "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                        "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                        "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                        "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                        "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                        "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                              "rgbColor": { # An RGB color. # The RGB color value.
+                                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                              },
+                            },
+                          },
+                        },
+                        "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "spacingMode": "A String", # The spacing mode for the paragraph.
+                        "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                          { # A tab stop within a paragraph.
+                            "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                            "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                          },
+                        ],
+                      },
+                      "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion.
+                        "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment.
+                        "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan.
+                        "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between.
+                        "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                        "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                        "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                        "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                        "directionSuggested": True or False, # Indicates if there was a suggested change to direction.
+                        "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id.
+                        "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end.
+                        "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                        "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                        "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together.
+                        "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next.
+                        "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing.
+                        "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type.
+                        "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before.
+                        "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion.
+                          "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading.
+                        },
+                        "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above.
+                        "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below.
+                        "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode.
+                      },
+                    },
+                  },
+                  "suggestedPositionedObjectIds": { # The IDs of the positioned objects suggested to be attached to this paragraph, keyed by suggestion ID.
+                    "a_key": { # A collection of object IDs.
+                      "objectIds": [ # The object IDs.
+                        "A String",
+                      ],
+                    },
+                  },
+                },
+                "sectionBreak": { # A StructuralElement representing a section break. A section is a range of content that has the same SectionStyle. A section break represents the start of a new section, and the section style applies to the section after the section break. The document body always begins with a section break. # A section break type of structural element.
+                  "sectionStyle": { # The styling that applies to a section. # The style of the section after this section break.
+                    "columnProperties": [ # The section's columns properties. If empty, the section contains one column with the default properties in the Docs editor. A section can be updated to have no more than 3 columns. When updating this property, setting a concrete value is required. Unsetting this property will result in a 400 bad request error.
+                      { # Properties that apply to a section's column.
+                        "paddingEnd": { # A magnitude in a single direction in the specified units. # The padding at the end of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "width": { # A magnitude in a single direction in the specified units. # Output only. The width of the column.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
                       },
+                    ],
+                    "columnSeparatorStyle": "A String", # The style of column separators. This style can be set even when there's one column in the section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "contentDirection": "A String", # The content direction of this section. If unset, the value defaults to LEFT_TO_RIGHT. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "defaultFooterId": "A String", # The ID of the default footer. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_footer_id. This property is read-only.
+                    "defaultHeaderId": "A String", # The ID of the default header. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's default_header_id. This property is read-only.
+                    "evenPageFooterId": "A String", # The ID of the footer used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the footers on even pages in the section. If it is false, the footers on even pages use the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_footer_id. This property is read-only.
+                    "evenPageHeaderId": "A String", # The ID of the header used only for even pages. If the value of DocumentStyle's use_even_page_header_footer is true, this value is used for the headers on even pages in the section. If it is false, the headers on even pages use the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's even_page_header_id. This property is read-only.
+                    "firstPageFooterId": "A String", # The ID of the footer used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the footer on the first page of the section. If it's false, the footer on the first page of the section uses the default_footer_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_footer_id. This property is read-only.
+                    "firstPageHeaderId": "A String", # The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.
+                    "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
                     },
+                    "marginFooter": { # A magnitude in a single direction in the specified units. # The footer margin of the section. If unset, the value defaults to margin_footer from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a footer margin is being respected for this section When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginHeader": { # A magnitude in a single direction in the specified units. # The header margin of the section. If unset, the value defaults to margin_header from DocumentStyle. If updated, use_custom_header_footer_margins is set to true on DocumentStyle. The value of use_custom_header_footer_margins on DocumentStyle indicates if a header margin is being respected for this section. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin of the section. If unset, the value defaults to margin_left from DocumentStyle. Updating the left margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin of the section. If unset, the value defaults to margin_right from DocumentStyle. Updating the right margin causes columns in this section to resize. Since the margin affects column width, it's applied before column properties. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin of the section. If unset, the value defaults to margin_top from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "pageNumberStart": 42, # The page number from which to start counting the number of pages for this section. If unset, page numbering continues from the previous section. If the value is unset in the first SectionBreak, refer to DocumentStyle's page_number_start. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
+                    "sectionType": "A String", # Output only. The type of section.
+                    "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page of the section. If unset, it inherits from DocumentStyle's use_first_page_header_footer for the first section. If the value is unset for subsequent sectors, it should be interpreted as false. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.
                   },
-                  "italic": True or False, # Whether or not the text is italicized.
-                  "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-                    "bookmarkId": "A String", # The ID of a bookmark in this document.
-                    "headingId": "A String", # The ID of a heading in this document.
-                    "url": "A String", # An external URL.
-                  },
-                  "smallCaps": True or False, # Whether or not the text is in small capital letters.
-                  "strikethrough": True or False, # Whether or not the text is struck through.
-                  "underline": True or False, # Whether or not the text is underlined.
-                  "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-                    "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-                    "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-                  },
-                },
-              },
-            ],
-          },
-          "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion.
-            "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.
-              { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.
-                "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment.
-                "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format.
-                "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol.
-                "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type.
-                "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
-                "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
-                "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number.
-                "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
-                  "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
-                  "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
-                  "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
-                  "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
-                  "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
-                  "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
-                  "linkSuggested": True or False, # Indicates if there was a suggested change to link.
-                  "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
-                  "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
-                  "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
-                  "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
-                },
-              },
-            ],
-          },
-        },
-      },
-    },
-  },
-  "namedRanges": { # Output only. The named ranges in the document, keyed by name.
-    "a_key": { # A collection of all the NamedRanges in the document that share a given name.
-      "name": "A String", # The name that all the named ranges share.
-      "namedRanges": [ # The NamedRanges that share the same name.
-        { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.
-          "name": "A String", # The name of the named range.
-          "namedRangeId": "A String", # The ID of the named range.
-          "ranges": [ # The ranges that belong to this named range.
-            { # Specifies a contiguous range of text.
-              "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
-              "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.
-              "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
-            },
-          ],
-        },
-      ],
-    },
-  },
-  "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # Output only. The named styles of the document.
-    "styles": [ # The named styles. There's an entry for each of the possible named style types.
-      { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.
-        "namedStyleType": "A String", # The type of this named style.
-        "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style.
-          "alignment": "A String", # The text alignment for this paragraph.
-          "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
-          "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-                },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A SectionBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                "startIndex": 42, # The zero-based start index of this structural element, in UTF-16 code units.
+                "table": { # A StructuralElement representing a table. # A table type of structural element.
+                  "columns": 42, # Number of columns in the table. It's possible for a table to be non-rectangular, so some rows may have a different number of cells.
+                  "rows": 42, # Number of rows in the table.
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A Table may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
+                  "tableRows": [ # The contents and style of each row.
+                    { # The contents and style of a row in a Table.
+                      "endIndex": 42, # The zero-based end index of this row, exclusive, in UTF-16 code units.
+                      "startIndex": 42, # The zero-based start index of this row, in UTF-16 code units.
+                      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                        "A String",
+                      ],
+                      "suggestedInsertionIds": [ # The suggested insertion IDs. A TableRow may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                        "A String",
+                      ],
+                      "suggestedTableRowStyleChanges": { # The suggested style changes to this row, keyed by suggestion ID.
+                        "a_key": { # A suggested change to a TableRowStyle.
+                          "tableRowStyle": { # Styles that apply to a table row. # A TableRowStyle that only includes the changes made in this suggestion. This can be used along with the table_row_style_suggestion_state to see which fields have changed and their new values.
+                            "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                            "tableHeader": True or False, # Whether the row is a table header.
+                          },
+                          "tableRowStyleSuggestionState": { # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableRowStyle have been changed in this suggestion.
+                            "minRowHeightSuggested": True or False, # Indicates if there was a suggested change to min_row_height.
+                          },
+                        },
+                      },
+                      "tableCells": [ # The contents and style of each cell in this row. It's possible for a table to be non-rectangular, so some rows may have a different number of cells than other rows in the same table.
+                        { # The contents and style of a cell in a Table.
+                          "content": [ # The content of the cell.
+                            # Object with schema name: StructuralElement
+                          ],
+                          "endIndex": 42, # The zero-based end index of this cell, exclusive, in UTF-16 code units.
+                          "startIndex": 42, # The zero-based start index of this cell, in UTF-16 code units.
+                          "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                            "A String",
+                          ],
+                          "suggestedInsertionIds": [ # The suggested insertion IDs. A TableCell may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion.
+                            "A String",
+                          ],
+                          "suggestedTableCellStyleChanges": { # The suggested changes to the table cell style, keyed by suggestion ID.
+                            "a_key": { # A suggested change to a TableCellStyle.
+                              "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # A TableCellStyle that only includes the changes made in this suggestion. This can be used along with the table_cell_style_suggestion_state to see which fields have changed and their new values.
+                                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                                  "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                    "rgbColor": { # An RGB color. # The RGB color value.
+                                      "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                      "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                      "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                    },
+                                  },
+                                },
+                                "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                      "rgbColor": { # An RGB color. # The RGB color value.
+                                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                      },
+                                    },
+                                  },
+                                  "dashStyle": "A String", # The dash style of the border.
+                                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                    "magnitude": 3.14, # The magnitude.
+                                    "unit": "A String", # The units for magnitude.
+                                  },
+                                },
+                                "columnSpan": 42, # The column span of the cell. This property is read-only.
+                                "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                                "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                                  "magnitude": 3.14, # The magnitude.
+                                  "unit": "A String", # The units for magnitude.
+                                },
+                                "rowSpan": 42, # The row span of the cell. This property is read-only.
+                              },
+                              "tableCellStyleSuggestionState": { # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TableCellStyle have been changed in this suggestion.
+                                "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                                "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom.
+                                "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left.
+                                "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right.
+                                "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top.
+                                "columnSpanSuggested": True or False, # Indicates if there was a suggested change to column_span.
+                                "contentAlignmentSuggested": True or False, # Indicates if there was a suggested change to content_alignment.
+                                "paddingBottomSuggested": True or False, # Indicates if there was a suggested change to padding_bottom.
+                                "paddingLeftSuggested": True or False, # Indicates if there was a suggested change to padding_left.
+                                "paddingRightSuggested": True or False, # Indicates if there was a suggested change to padding_right.
+                                "paddingTopSuggested": True or False, # Indicates if there was a suggested change to padding_top.
+                                "rowSpanSuggested": True or False, # Indicates if there was a suggested change to row_span.
+                              },
+                            },
+                          },
+                          "tableCellStyle": { # The style of a TableCell. Inherited table cell styles are represented as unset fields in this message. A table cell style can inherit from the table's style. # The style of the cell.
+                            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the cell.
+                              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                "rgbColor": { # An RGB color. # The RGB color value.
+                                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                },
+                              },
+                            },
+                            "borderBottom": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The bottom border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderLeft": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The left border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderRight": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The right border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "borderTop": { # A border around a table cell. Table cell borders cannot be transparent. To hide a table cell border, make its width 0. # The top border of the cell.
+                              "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. This color cannot be transparent.
+                                "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                                  "rgbColor": { # An RGB color. # The RGB color value.
+                                    "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                                    "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                                    "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                                  },
+                                },
+                              },
+                              "dashStyle": "A String", # The dash style of the border.
+                              "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                                "magnitude": 3.14, # The magnitude.
+                                "unit": "A String", # The units for magnitude.
+                              },
+                            },
+                            "columnSpan": 42, # The column span of the cell. This property is read-only.
+                            "contentAlignment": "A String", # The alignment of the content in the table cell. The default alignment matches the alignment for newly created table cells in the Docs editor.
+                            "paddingBottom": { # A magnitude in a single direction in the specified units. # The bottom padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingLeft": { # A magnitude in a single direction in the specified units. # The left padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingRight": { # A magnitude in a single direction in the specified units. # The right padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "paddingTop": { # A magnitude in a single direction in the specified units. # The top padding of the cell.
+                              "magnitude": 3.14, # The magnitude.
+                              "unit": "A String", # The units for magnitude.
+                            },
+                            "rowSpan": 42, # The row span of the cell. This property is read-only.
+                          },
+                        },
+                      ],
+                      "tableRowStyle": { # Styles that apply to a table row. # The style of the table row.
+                        "minRowHeight": { # A magnitude in a single direction in the specified units. # The minimum height of the row. The row will be rendered in the Docs editor at a height equal to or greater than this value in order to show all the content in the row's cells.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "preventOverflow": True or False, # Whether the row cannot overflow across page or column boundaries.
+                        "tableHeader": True or False, # Whether the row is a table header.
+                      },
+                    },
+                  ],
+                  "tableStyle": { # Styles that apply to a table. # The style of the table.
+                    "tableColumnProperties": [ # The properties of each column. Note that in Docs, tables contain rows and rows contain cells, similar to HTML. So the properties for a row can be found on the row's table_row_style.
+                      { # The properties of a column in a table.
+                        "width": { # A magnitude in a single direction in the specified units. # The width of the column. Set when the column's `width_type` is FIXED_WIDTH.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "widthType": "A String", # The width type of the column.
+                      },
+                    ],
+                  },
                 },
-              },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
-          "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
-          "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
-          "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
-          "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
-          "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
-          "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
-          "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
-            "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                "tableOfContents": { # A StructuralElement representing a table of contents. # A table of contents type of structural element.
+                  "content": [ # The content of the table of contents.
+                    # Object with schema name: StructuralElement
+                  ],
+                  "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+                    "A String",
+                  ],
+                  "suggestedInsertionIds": [ # The suggested insertion IDs. A TableOfContents may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion.
+                    "A String",
+                  ],
                 },
               },
-            },
-          },
-          "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
+            ],
+            "headerId": "A String", # The ID of the header.
           },
-          "spacingMode": "A String", # The spacing mode for the paragraph.
-          "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
-            { # A tab stop within a paragraph.
-              "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
-              "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
-                "magnitude": 3.14, # The magnitude.
-                "unit": "A String", # The units for magnitude.
-              },
-            },
-          ],
         },
-        "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style.
-          "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-              "rgbColor": { # An RGB color. # The RGB color value.
-                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
-              },
-            },
-          },
-          "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
-          "bold": True or False, # Whether or not the text is rendered as bold.
-          "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
-            "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-              "rgbColor": { # An RGB color. # The RGB color value.
-                "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+        "inlineObjects": { # The inline objects in the document tab, keyed by object ID.
+          "a_key": { # An object that appears inline with text. An InlineObject contains an EmbeddedObject such as an image.
+            "inlineObjectProperties": { # Properties of an InlineObject. # The properties of this inline object.
+              "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object.
+                "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+                "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+                },
+                "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "propertyState": "A String", # The property state of the border property.
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "imageProperties": { # The properties of an image. # The properties of an image.
+                  "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+                  "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                  "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+                  "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                  "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+                    "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+                    "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+                    "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+                    "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+                    "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+                  },
+                  "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+                  "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+                },
+                "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+                  "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+                    "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+                    "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+                  },
+                },
+                "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "size": { # A width and height. # The visible size of the image after cropping.
+                  "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
               },
             },
-          },
-          "italic": True or False, # Whether or not the text is italicized.
-          "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
-            "bookmarkId": "A String", # The ID of a bookmark in this document.
-            "headingId": "A String", # The ID of a heading in this document.
-            "url": "A String", # An external URL.
-          },
-          "smallCaps": True or False, # Whether or not the text is in small capital letters.
-          "strikethrough": True or False, # Whether or not the text is struck through.
-          "underline": True or False, # Whether or not the text is underlined.
-          "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
-            "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
-            "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
-          },
-        },
-      },
-    ],
-  },
-  "positionedObjects": { # Output only. The positioned objects in the document, keyed by object ID.
-    "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image.
-      "objectId": "A String", # The ID of this positioned object.
-      "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object.
-        "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object.
-          "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
-          "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
-          },
-          "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
-            "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
-              "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
-                "rgbColor": { # An RGB color. # The RGB color value.
-                  "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
-                  "green": 3.14, # The green component of the color, from 0.0 to 1.0.
-                  "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+            "objectId": "A String", # The ID of this inline object. Can be used to update an object’s properties.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
+              "A String",
+            ],
+            "suggestedInlineObjectPropertiesChanges": { # The suggested changes to the inline object properties, keyed by suggestion ID.
+              "a_key": { # A suggested change to InlineObjectProperties.
+                "inlineObjectProperties": { # Properties of an InlineObject. # An InlineObjectProperties that only includes the changes made in this suggestion. This can be used along with the inline_object_properties_suggestion_state to see which fields have changed and their new values.
+                  "embeddedObject": { # An embedded object in the document. # The embedded object of this inline object.
+                    "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
+                    "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+                    },
+                    "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
+                      "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                        "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                          "rgbColor": { # An RGB color. # The RGB color value.
+                            "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                            "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                            "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                          },
+                        },
+                      },
+                      "dashStyle": "A String", # The dash style of the border.
+                      "propertyState": "A String", # The property state of the border property.
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "imageProperties": { # The properties of an image. # The properties of an image.
+                      "angle": 3.14, # The clockwise rotation angle of the image, in radians.
+                      "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                      "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
+                      "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
+                      "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
+                        "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
+                        "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
+                        "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
+                        "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
+                        "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
+                      },
+                      "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
+                      "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
+                    },
+                    "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
+                      "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
+                        "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
+                        "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
+                      },
+                    },
+                    "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "size": { # A width and height. # The visible size of the image after cropping.
+                      "height": { # A magnitude in a single direction in the specified units. # The height of the object.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "width": { # A magnitude in a single direction in the specified units. # The width of the object.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                    },
+                    "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
+                  },
+                },
+                "inlineObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base InlineObjectProperties have been changed in this suggestion.
+                  "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion.
+                    "descriptionSuggested": True or False, # Indicates if there was a suggested change to description.
+                    "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion.
+                    },
+                    "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion.
+                      "colorSuggested": True or False, # Indicates if there was a suggested change to color.
+                      "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style.
+                      "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state.
+                      "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+                    },
+                    "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion.
+                      "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                      "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness.
+                      "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri.
+                      "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast.
+                      "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion.
+                        "angleSuggested": True or False, # Indicates if there was a suggested change to angle.
+                        "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom.
+                        "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left.
+                        "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right.
+                        "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top.
+                      },
+                      "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri.
+                      "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency.
+                    },
+                    "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion.
+                      "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion.
+                        "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id.
+                        "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id.
+                      },
+                    },
+                    "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom.
+                    "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left.
+                    "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right.
+                    "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top.
+                    "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion.
+                      "heightSuggested": True or False, # Indicates if there was a suggested change to height.
+                      "widthSuggested": True or False, # Indicates if there was a suggested change to width.
+                    },
+                    "titleSuggested": True or False, # Indicates if there was a suggested change to title.
+                  },
                 },
               },
-            },
-            "dashStyle": "A String", # The dash style of the border.
-            "propertyState": "A String", # The property state of the border property.
-            "width": { # A magnitude in a single direction in the specified units. # The width of the border.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
-            },
-          },
-          "imageProperties": { # The properties of an image. # The properties of an image.
-            "angle": 3.14, # The clockwise rotation angle of the image, in radians.
-            "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
-            "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change.
-            "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect.
-            "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image.
-              "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets.
-              "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height.
-              "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width.
-              "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width.
-              "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height.
-            },
-            "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty.
-            "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent.
-          },
-          "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked.
-            "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart.
-              "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded.
-              "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart.
-            },
-          },
-          "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
+            },
+            "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
           },
-          "size": { # A width and height. # The visible size of the image after cropping.
-            "height": { # A magnitude in a single direction in the specified units. # The height of the object.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
+        },
+        "lists": { # The lists in the document tab, keyed by list ID.
+          "a_key": { # A List represents the list attributes for a group of paragraphs that all belong to the same list. A paragraph that's part of a list has a reference to the list's ID in its bullet.
+            "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # The properties of the list.
+              "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
+                { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
+                  "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
+                  "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
+                  "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
+                  "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
+                  "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
+                  "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
+                    "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                    "bold": True or False, # Whether or not the text is rendered as bold.
+                    "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                    "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                      "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                        "rgbColor": { # An RGB color. # The RGB color value.
+                          "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                          "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                          "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                        },
+                      },
+                    },
+                    "italic": True or False, # Whether or not the text is italicized.
+                    "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                      "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a bookmark in this document.
+                        "tabId": "A String", # The ID of the tab containing this bookmark.
+                      },
+                      "bookmarkId": "A String", # The ID of a bookmark in this document.
+                      "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                        "id": "A String", # The ID of a heading in this document.
+                        "tabId": "A String", # The ID of the tab containing this heading.
+                      },
+                      "headingId": "A String", # The ID of a heading in this document.
+                      "tabId": "A String", # The ID of a tab in this document.
+                      "url": "A String", # An external URL.
+                    },
+                    "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                    "strikethrough": True or False, # Whether or not the text is struck through.
+                    "underline": True or False, # Whether or not the text is underlined.
+                    "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                      "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                      "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                    },
+                  },
+                },
+              ],
             },
-            "width": { # A magnitude in a single direction in the specified units. # The width of the object.
-              "magnitude": 3.14, # The magnitude.
-              "unit": "A String", # The units for magnitude.
+            "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this list.
+              "A String",
+            ],
+            "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
+            "suggestedListPropertiesChanges": { # The suggested changes to the list properties, keyed by suggestion ID.
+              "a_key": { # A suggested change to ListProperties.
+                "listProperties": { # The properties of a list that describe the look and feel of bullets belonging to paragraphs associated with a list. # A ListProperties that only includes the changes made in this suggestion. This can be used along with the list_properties_suggestion_state to see which fields have changed and their new values.
+                  "nestingLevels": [ # Describes the properties of the bullets at the associated level. A list has at most 9 levels of nesting with nesting level 0 corresponding to the top-most level and nesting level 8 corresponding to the most nested level. The nesting levels are returned in ascending order with the least nested returned first.
+                    { # Contains properties describing the look and feel of a list bullet at a given level of nesting.
+                      "bulletAlignment": "A String", # The alignment of the bullet within the space allotted for rendering the bullet.
+                      "glyphFormat": "A String", # The format string used by bullets at this level of nesting. The glyph format contains one or more placeholders, and these placeholders are replaced with the appropriate values depending on the glyph_type or glyph_symbol. The placeholders follow the pattern `%[nesting_level]`. Furthermore, placeholders can have prefixes and suffixes. Thus, the glyph format follows the pattern `%[nesting_level]`. Note that the prefix and suffix are optional and can be arbitrary strings. For example, the glyph format `%0.` indicates that the rendered glyph will replace the placeholder with the corresponding glyph for nesting level 0 followed by a period as the suffix. So a list with a glyph type of UPPER_ALPHA and glyph format `%0.` at nesting level 0 will result in a list with rendered glyphs `A.` `B.` `C.` The glyph format can contain placeholders for the current nesting level as well as placeholders for parent nesting levels. For example, a list can have a glyph format of `%0.` at nesting level 0 and a glyph format of `%0.%1.` at nesting level 1. Assuming both nesting levels have DECIMAL glyph types, this would result in a list with rendered glyphs `1.` `2.` ` 2.1.` ` 2.2.` `3.` For nesting levels that are ordered, the string that replaces a placeholder in the glyph format for a particular paragraph depends on the paragraph's order within the list.
+                      "glyphSymbol": "A String", # A custom glyph symbol used by bullets when paragraphs at this level of nesting are unordered. The glyph symbol replaces placeholders within the glyph_format. For example, if the glyph_symbol is the solid circle corresponding to Unicode U+25cf code point and the glyph_format is `%0`, the rendered glyph would be the solid circle.
+                      "glyphType": "A String", # The type of glyph used by bullets when paragraphs at this level of nesting are ordered. The glyph type determines the type of glyph used to replace placeholders within the glyph_format when paragraphs at this level of nesting are ordered. For example, if the nesting level is 0, the glyph_format is `%0.` and the glyph type is DECIMAL, then the rendered glyph would replace the placeholder `%0` in the glyph format with a number corresponding to list item's order within the list.
+                      "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of paragraphs at this level of nesting.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for paragraphs at this level of nesting. Applied to the side that corresponds to the start of the text, based on the paragraph's content direction.
+                        "magnitude": 3.14, # The magnitude.
+                        "unit": "A String", # The units for magnitude.
+                      },
+                      "startNumber": 42, # The number of the first list item at this nesting level. A value of 0 is treated as a value of 1 for lettered lists and Roman numeral lists. For values of both 0 and 1, lettered and Roman numeral lists will begin at `a` and `i` respectively. This value is ignored for nesting levels with unordered glyphs.
+                      "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of bullets at this level of nesting.
+                        "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`.
+                        "bold": True or False, # Whether or not the text is rendered as bold.
+                        "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font.
+                          "magnitude": 3.14, # The magnitude.
+                          "unit": "A String", # The units for magnitude.
+                        },
+                        "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
+                          "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                            "rgbColor": { # An RGB color. # The RGB color value.
+                              "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                              "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                              "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                            },
+                          },
+                        },
+                        "italic": True or False, # Whether or not the text is italicized.
+                        "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request.
+                          "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a bookmark in this document.
+                            "tabId": "A String", # The ID of the tab containing this bookmark.
+                          },
+                          "bookmarkId": "A String", # The ID of a bookmark in this document.
+                          "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned.
+                            "id": "A String", # The ID of a heading in this document.
+                            "tabId": "A String", # The ID of the tab containing this heading.
+                          },
+                          "headingId": "A String", # The ID of a heading in this document.
+                          "tabId": "A String", # The ID of a tab in this document.
+                          "url": "A String", # An external URL.
+                        },
+                        "smallCaps": True or False, # Whether or not the text is in small capital letters.
+                        "strikethrough": True or False, # Whether or not the text is struck through.
+                        "underline": True or False, # Whether or not the text is underlined.
+                        "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned.
+                          "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`.
+                          "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight.
+                        },
+                      },
+                    },
+                  ],
+                },
+                "listPropertiesSuggestionState": { # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base ListProperties have been changed in this suggestion.
+                  "nestingLevelsSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NestingLevel in nesting_levels have been changed in this suggestion. The nesting level suggestion states are returned in ascending order of the nesting level with the least nested returned first.
+                    { # A mask that indicates which of the fields on the base NestingLevel have been changed in this suggestion. For any field set to true, there's a new suggested value.
+                      "bulletAlignmentSuggested": True or False, # Indicates if there was a suggested change to bullet_alignment.
+                      "glyphFormatSuggested": True or False, # Indicates if there was a suggested change to glyph_format.
+                      "glyphSymbolSuggested": True or False, # Indicates if there was a suggested change to glyph_symbol.
+                      "glyphTypeSuggested": True or False, # Indicates if there was a suggested change to glyph_type.
+                      "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line.
+                      "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start.
+                      "startNumberSuggested": True or False, # Indicates if there was a suggested change to start_number.
+                      "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion.
+                        "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color.
+                        "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset.
+                        "boldSuggested": True or False, # Indicates if there was a suggested change to bold.
+                        "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size.
+                        "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color.
+                        "italicSuggested": True or False, # Indicates if there was a suggested change to italic.
+                        "linkSuggested": True or False, # Indicates if there was a suggested change to link.
+                        "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps.
+                        "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough.
+                        "underlineSuggested": True or False, # Indicates if there was a suggested change to underline.
+                        "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family.
+                      },
+                    },
+                  ],
+                },
+              },
             },
           },
-          "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text.
         },
-        "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object.
-          "layout": "A String", # The layout of this positioned object.
-          "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
-          },
-          "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling.
-            "magnitude": 3.14, # The magnitude.
-            "unit": "A String", # The units for magnitude.
+        "namedRanges": { # The named ranges in the document tab, keyed by name.
+          "a_key": { # A collection of all the NamedRanges in the document that share a given name.
+            "name": "A String", # The name that all the named ranges share.
+            "namedRanges": [ # The NamedRanges that share the same name.
+              { # A collection of Ranges with the same named range ID. Named ranges allow developers to associate parts of a document with an arbitrary user-defined label so their contents can be programmatically read or edited later. A document can contain multiple named ranges with the same name, but every named range has a unique ID. A named range is created with a single Range, and content inserted inside a named range generally expands that range. However, certain document changes can cause the range to be split into multiple ranges. Named ranges are not private. All applications and collaborators that have access to the document can see its named ranges.
+                "name": "A String", # The name of the named range.
+                "namedRangeId": "A String", # The ID of the named range.
+                "ranges": [ # The ranges that belong to this named range.
+                  { # Specifies a contiguous range of text.
+                    "endIndex": 42, # The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
+                    "segmentId": "A String", # The ID of the header, footer, or footnote that this range is contained in. An empty segment ID signifies the document's body.
+                    "startIndex": 42, # The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.
+                    "tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.
+                  },
+                ],
+              },
+            ],
           },
         },
-      },
-      "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content.
-        "A String",
-      ],
-      "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion.
-      "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID.
-        "a_key": { # A suggested change to PositionedObjectProperties.
-          "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values.
-            "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object.
-              "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text.
-              "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing.
+        "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # The named styles of the document tab.
+          "styles": [ # The named styles. There's an entry for each of the possible named style types.
+            { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type.
+              "namedStyleType": "A String", # The type of this named style.
+              "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style.
+                "alignment": "A String", # The text alignment for this paragraph.
+                "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent.
+                "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety.
+                  "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                  "dashStyle": "A String", # The dash style of the border.
+                  "padding": { # A magnitude in a single direction in the specified units. # The padding of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                  "width": { # A magnitude in a single direction in the specified units. # The width of the border.
+                    "magnitude": 3.14, # The magnitude.
+                    "unit": "A String", # The units for magnitude.
+                  },
+                },
+                "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited.
+                "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only.
+                "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent.
+                "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent.
+                "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent.
+                "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated.
+                "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error.
+                "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent.
+                  "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading.
+                    "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
+                      "rgbColor": { # An RGB color. # The RGB color value.
+                        "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
+                        "green": 3.14, # The green component of the color, from 0.0 to 1.0.
+                        "red": 3.14, # The red component of the color, from 0.0 to 1.0.
+                      },
+                    },
+                  },
+                },
+                "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent.
+                  "magnitude": 3.14, # The magnitude.
+                  "unit": "A String", # The units for magnitude.
+                },
+                "spacingMode": "A String", # The spacing mode for the paragraph.
+                "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only.
+                  { # A tab stop within a paragraph.
+                    "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START.
+                    "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin.
+                      "magnitude": 3.14, # The magnitude.
+                      "unit": "A String", # The units for magnitude.
+                    },
+                  },
+                ],
               },
-              "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object.
-                "color": { # A color that can either be fully opaque or fully transparent. # The color of the border.
+              "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style.
+                "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field.
                   "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color.
                     "rgbColor": { # An RGB color. # The RGB color value.
                       "blue": 3.14, # The blue component of the color, from 0.0 to 1.0.
@@ -25199,226 +54439,279 @@ 

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "propertyState": "A String", # The property state of the border property. - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "imageProperties": { # The properties of an image. # The properties of an image. - "angle": 3.14, # The clockwise rotation angle of the image, in radians. - "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. - "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. - "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. - "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. - "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. - "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. - "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. - "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. - "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. - }, - "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. - "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. - "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. - "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "size": { # A width and height. # The visible size of the image after cropping. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. + }, + ], + }, + "positionedObjects": { # The positioned objects in the document tab, keyed by object ID. + "a_key": { # An object that's tethered to a Paragraph and positioned relative to the beginning of the paragraph. A PositionedObject contains an EmbeddedObject such as an image. + "objectId": "A String", # The ID of this positioned object. + "positionedObjectProperties": { # Properties of a PositionedObject. # The properties of this positioned object. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - }, - "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. - }, - "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. - "layout": "A String", # The layout of this positioned object. - "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - }, - "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. - "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. - "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. - "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. - }, - "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. - "colorSuggested": True or False, # Indicates if there was a suggested change to color. - "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. - "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. - "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. - "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. - "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. - "angleSuggested": True or False, # Indicates if there was a suggested change to angle. - "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. - "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. - "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. - "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. - "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. - }, - "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. - "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. - "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. - "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. }, - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, }, - "titleSuggested": True or False, # Indicates if there was a suggested change to title. - }, - "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. - "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. - "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. - "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. }, - }, - }, - }, - }, - }, - "revisionId": "A String", # Output only. The revision ID of the document. Can be used in update requests to specify which revision of a document to apply updates to and how the request should behave if the document has been edited since that revision. Only populated if the user has edit access to the document. The revision ID is not a sequential number but an opaque string. The format of the revision ID might change over time. A returned revision ID is only guaranteed to be valid for 24 hours after it has been returned and cannot be shared across users. If the revision ID is unchanged between calls, then the document has not changed. Conversely, a changed ID (for the same document and user) usually means the document has been updated. However, a changed ID can also be due to internal factors such as ID format changes. - "suggestedDocumentStyleChanges": { # Output only. The suggested changes to the style of the document, keyed by suggestion ID. - "a_key": { # A suggested change to the DocumentStyle. - "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. - "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. - "color": { # A color that can either be fully opaque or fully transparent. # The background color. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionId": "A String", # The suggested insertion ID. If empty, then this is not a suggested insertion. + "suggestedPositionedObjectPropertiesChanges": { # The suggested changes to the positioned object properties, keyed by suggestion ID. + "a_key": { # A suggested change to PositionedObjectProperties. + "positionedObjectProperties": { # Properties of a PositionedObject. # A PositionedObjectProperties that only includes the changes made in this suggestion. This can be used along with the positioned_object_properties_suggestion_state to see which fields have changed and their new values. + "embeddedObject": { # An embedded object in the document. # The embedded object of this positioned object. + "description": "A String", # The description of the embedded object. The `title` and `description` are both combined to display alt text. + "embeddedDrawingProperties": { # The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported. # The properties of an embedded drawing. + }, + "embeddedObjectBorder": { # A border around an EmbeddedObject. # The border of the embedded object. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "propertyState": "A String", # The property state of the border property. + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "imageProperties": { # The properties of an image. # The properties of an image. + "angle": 3.14, # The clockwise rotation angle of the image, in radians. + "brightness": 3.14, # The brightness effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "contentUri": "A String", # A URI to the image with a default lifetime of 30 minutes. This URI is tagged with the account of the requester. Anyone with the URI effectively accesses the image as the original requester. Access to the image may be lost if the document's sharing settings change. + "contrast": 3.14, # The contrast effect of the image. The value should be in the interval [-1.0, 1.0], where 0 means no effect. + "cropProperties": { # The crop properties of an image. The crop rectangle is represented using fractional offsets from the original content's 4 edges. - If the offset is in the interval (0, 1), the corresponding edge of crop rectangle is positioned inside of the image's original bounding rectangle. - If the offset is negative or greater than 1, the corresponding edge of crop rectangle is positioned outside of the image's original bounding rectangle. - If all offsets and rotation angle are 0, the image is not cropped. # The crop properties of the image. + "angle": 3.14, # The clockwise rotation angle of the crop rectangle around its center, in radians. Rotation is applied after the offsets. + "offsetBottom": 3.14, # The offset specifies how far inwards the bottom edge of the crop rectangle is from the bottom edge of the original content as a fraction of the original content's height. + "offsetLeft": 3.14, # The offset specifies how far inwards the left edge of the crop rectangle is from the left edge of the original content as a fraction of the original content's width. + "offsetRight": 3.14, # The offset specifies how far inwards the right edge of the crop rectangle is from the right edge of the original content as a fraction of the original content's width. + "offsetTop": 3.14, # The offset specifies how far inwards the top edge of the crop rectangle is from the top edge of the original content as a fraction of the original content's height. + }, + "sourceUri": "A String", # The source URI is the URI used to insert the image. The source URI can be empty. + "transparency": 3.14, # The transparency effect of the image. The value should be in the interval [0.0, 1.0], where 0 means no effect and 1 means transparent. + }, + "linkedContentReference": { # A reference to the external linked source content. # A reference to the external linked source content. For example, it contains a reference to the source Google Sheets chart when the embedded object is a linked chart. If unset, then the embedded object is not linked. + "sheetsChartReference": { # A reference to a linked chart embedded from Google Sheets. # A reference to the linked chart. + "chartId": 42, # The ID of the specific chart in the Google Sheets spreadsheet that's embedded. + "spreadsheetId": "A String", # The ID of the Google Sheets spreadsheet that contains the source chart. + }, + }, + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top margin of the embedded object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "size": { # A width and height. # The visible size of the image after cropping. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the object. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "title": "A String", # The title of the embedded object. The `title` and `description` are both combined to display alt text. + }, + "positioning": { # The positioning of a PositionedObject. The positioned object is positioned relative to the beginning of the Paragraph it's tethered to. # The positioning of this positioned object relative to the newline of the Paragraph that references this positioned object. + "layout": "A String", # The layout of this positioned object. + "leftOffset": { # A magnitude in a single direction in the specified units. # The offset of the left edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "topOffset": { # A magnitude in a single direction in the specified units. # The offset of the top edge of the positioned object relative to the beginning of the Paragraph it's tethered to. The exact positioning of the object can depend on other content in the document and the document's styling. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + }, + "positionedObjectPropertiesSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base PositionedObjectProperties have been changed in this suggestion. + "embeddedObjectSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObject have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object have been changed in this suggestion. + "descriptionSuggested": True or False, # Indicates if there was a suggested change to description. + "embeddedDrawingPropertiesSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedDrawingProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_drawing_properties have been changed in this suggestion. + }, + "embeddedObjectBorderSuggestionState": { # A mask that indicates which of the fields on the base EmbeddedObjectBorder have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in embedded_object_border have been changed in this suggestion. + "colorSuggested": True or False, # Indicates if there was a suggested change to color. + "dashStyleSuggested": True or False, # Indicates if there was a suggested change to dash_style. + "propertyStateSuggested": True or False, # Indicates if there was a suggested change to property_state. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "imagePropertiesSuggestionState": { # A mask that indicates which of the fields on the base ImageProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in image_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "brightnessSuggested": True or False, # Indicates if there was a suggested change to brightness. + "contentUriSuggested": True or False, # Indicates if there was a suggested change to content_uri. + "contrastSuggested": True or False, # Indicates if there was a suggested change to contrast. + "cropPropertiesSuggestionState": { # A mask that indicates which of the fields on the base CropProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in crop_properties have been changed in this suggestion. + "angleSuggested": True or False, # Indicates if there was a suggested change to angle. + "offsetBottomSuggested": True or False, # Indicates if there was a suggested change to offset_bottom. + "offsetLeftSuggested": True or False, # Indicates if there was a suggested change to offset_left. + "offsetRightSuggested": True or False, # Indicates if there was a suggested change to offset_right. + "offsetTopSuggested": True or False, # Indicates if there was a suggested change to offset_top. + }, + "sourceUriSuggested": True or False, # Indicates if there was a suggested change to source_uri. + "transparencySuggested": True or False, # Indicates if there was a suggested change to transparency. + }, + "linkedContentReferenceSuggestionState": { # A mask that indicates which of the fields on the base LinkedContentReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in linked_content_reference have been changed in this suggestion. + "sheetsChartReferenceSuggestionState": { # A mask that indicates which of the fields on the base SheetsChartReference have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in sheets_chart_reference have been changed in this suggestion. + "chartIdSuggested": True or False, # Indicates if there was a suggested change to chart_id. + "spreadsheetIdSuggested": True or False, # Indicates if there was a suggested change to spreadsheet_id. + }, + }, + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "sizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + "positioningSuggestionState": { # A mask that indicates which of the fields on the base PositionedObjectPositioning have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in positioning have been changed in this suggestion. + "layoutSuggested": True or False, # Indicates if there was a suggested change to layout. + "leftOffsetSuggested": True or False, # Indicates if there was a suggested change to left_offset. + "topOffsetSuggested": True or False, # Indicates if there was a suggested change to top_offset. + }, + }, }, }, }, }, - "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. - "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. - "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. - "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. - "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. - "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. - "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. - "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "pageNumberStart": 42, # The page number from which to start counting the number of pages. - "pageSize": { # A width and height. # The size of a page in the document. - "height": { # A magnitude in a single direction in the specified units. # The height of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the object. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. - "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. - "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. - }, - "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. - "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. - }, - "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. - "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. - "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. - "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. - "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. - "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. - "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. - "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. - "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. - "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. - "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. - "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. - "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. - "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. - "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. - "heightSuggested": True or False, # Indicates if there was a suggested change to height. - "widthSuggested": True or False, # Indicates if there was a suggested change to width. - }, - "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. - "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. - "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. - }, - }, - }, - "suggestedNamedStylesChanges": { # Output only. The suggested changes to the named styles of the document, keyed by suggestion ID. - "a_key": { # A suggested change to the NamedStyles. - "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. - "styles": [ # The named styles. There's an entry for each of the possible named style types. - { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. - "namedStyleType": "A String", # The type of this named style. - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "suggestedDocumentStyleChanges": { # The suggested changes to the style of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the DocumentStyle. + "documentStyle": { # The style of the document. # A DocumentStyle that only includes the changes made in this suggestion. This can be used along with the document_style_suggestion_state to see which fields have changed and their new values. + "background": { # Represents the background of a document. # The background of the document. Documents cannot have a transparent background color. + "color": { # A color that can either be fully opaque or fully transparent. # The background color. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. @@ -25427,235 +54720,347 @@

Method Details

}, }, }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + }, + "defaultFooterId": "A String", # The ID of the default footer. If not set, there's no default footer. This property is read-only. + "defaultHeaderId": "A String", # The ID of the default header. If not set, there's no default header. This property is read-only. + "evenPageFooterId": "A String", # The ID of the footer used only for even pages. The value of use_even_page_header_footer determines whether to use the default_footer_id or this value for the footer on even pages. If not set, there's no even page footer. This property is read-only. + "evenPageHeaderId": "A String", # The ID of the header used only for even pages. The value of use_even_page_header_footer determines whether to use the default_header_id or this value for the header on even pages. If not set, there's no even page header. This property is read-only. + "firstPageFooterId": "A String", # The ID of the footer used only for the first page. If not set then a unique footer for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_footer_id or this value for the footer on the first page. If not set, there's no first page footer. This property is read-only. + "firstPageHeaderId": "A String", # The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. + "flipPageOrientation": True or False, # Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + "marginBottom": { # A magnitude in a single direction in the specified units. # The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginFooter": { # A magnitude in a single direction in the specified units. # The amount of space between the bottom of the page and the contents of the footer. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginHeader": { # A magnitude in a single direction in the specified units. # The amount of space between the top of the page and the contents of the header. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginLeft": { # A magnitude in a single direction in the specified units. # The left page margin. Updating the left page margin on the document style clears the left page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginRight": { # A magnitude in a single direction in the specified units. # The right page margin. Updating the right page margin on the document style clears the right page margin on all section styles. It may also cause columns to resize in all sections. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "marginTop": { # A magnitude in a single direction in the specified units. # The top page margin. Updating the top page margin on the document style clears the top page margin on all section styles. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "pageNumberStart": 42, # The page number from which to start counting the number of pages. + "pageSize": { # A width and height. # The size of a page in the document. + "height": { # A magnitude in a single direction in the specified units. # The height of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "width": { # A magnitude in a single direction in the specified units. # The width of the object. "magnitude": 3.14, # The magnitude. "unit": "A String", # The units for magnitude. }, }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "useCustomHeaderFooterMargins": True or False, # Indicates whether DocumentStyle margin_header, SectionStyle margin_header and DocumentStyle margin_footer, SectionStyle margin_footer are respected. When false, the default values in the Docs editor for header and footer margin are used. This property is read-only. + "useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. + "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. + }, + "documentStyleSuggestionState": { # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DocumentStyle have been changed in this suggestion. + "backgroundSuggestionState": { # A mask that indicates which of the fields on the base Background have been changed in this suggestion. For any field set to true, the Backgound has a new suggested value. # A mask that indicates which of the fields in background have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates whether the current background color has been modified in this suggestion. + }, + "defaultFooterIdSuggested": True or False, # Indicates if there was a suggested change to default_footer_id. + "defaultHeaderIdSuggested": True or False, # Indicates if there was a suggested change to default_header_id. + "evenPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to even_page_footer_id. + "evenPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to even_page_header_id. + "firstPageFooterIdSuggested": True or False, # Indicates if there was a suggested change to first_page_footer_id. + "firstPageHeaderIdSuggested": True or False, # Indicates if there was a suggested change to first_page_header_id. + "flipPageOrientationSuggested": True or False, # Optional. Indicates if there was a suggested change to flip_page_orientation. + "marginBottomSuggested": True or False, # Indicates if there was a suggested change to margin_bottom. + "marginFooterSuggested": True or False, # Indicates if there was a suggested change to margin_footer. + "marginHeaderSuggested": True or False, # Indicates if there was a suggested change to margin_header. + "marginLeftSuggested": True or False, # Indicates if there was a suggested change to margin_left. + "marginRightSuggested": True or False, # Indicates if there was a suggested change to margin_right. + "marginTopSuggested": True or False, # Indicates if there was a suggested change to margin_top. + "pageNumberStartSuggested": True or False, # Indicates if there was a suggested change to page_number_start. + "pageSizeSuggestionState": { # A mask that indicates which of the fields on the base Size have been changed in this suggestion. For any field set to true, the Size has a new suggested value. # A mask that indicates which of the fields in size have been changed in this suggestion. + "heightSuggested": True or False, # Indicates if there was a suggested change to height. + "widthSuggested": True or False, # Indicates if there was a suggested change to width. + }, + "useCustomHeaderFooterMarginsSuggested": True or False, # Indicates if there was a suggested change to use_custom_header_footer_margins. + "useEvenPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_even_page_header_footer. + "useFirstPageHeaderFooterSuggested": True or False, # Indicates if there was a suggested change to use_first_page_header_footer. + }, + }, + }, + "suggestedNamedStylesChanges": { # The suggested changes to the named styles of the document tab, keyed by suggestion ID. + "a_key": { # A suggested change to the NamedStyles. + "namedStyles": { # The named styles. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from these named styles. # A NamedStyles that only includes the changes made in this suggestion. This can be used along with the named_styles_suggestion_state to see which fields have changed and their new values. + "styles": [ # The named styles. There's an entry for each of the possible named style types. + { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. + "namedStyleType": "A String", # The type of this named style. + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph style of this named style. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, - }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. }, }, ], }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this named style. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. + "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. + { # A suggestion state of a NamedStyle message. + "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. + "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. + "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. + "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. + "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. + "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. + "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. + "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. + "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. + "directionSuggested": True or False, # Indicates if there was a suggested change to direction. + "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. + "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. + "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. + "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. + "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. + "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. + "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. + "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. + "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. + "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. + }, + "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. + "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. + "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. }, }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmarkId": "A String", # The ID of a bookmark in this document. - "headingId": "A String", # The ID of a heading in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + ], }, }, - ], + }, }, - "namedStylesSuggestionState": { # The suggestion state of a NamedStyles message. # A mask that indicates which of the fields on the base NamedStyles have been changed in this suggestion. - "stylesSuggestionStates": [ # A mask that indicates which of the fields on the corresponding NamedStyle in styles have been changed in this suggestion. The order of these named style suggestion states matches the order of the corresponding named style within the named styles suggestion. - { # A suggestion state of a NamedStyle message. - "namedStyleType": "A String", # The named style type that this suggestion state corresponds to. This field is provided as a convenience for matching the NamedStyleSuggestionState with its corresponding NamedStyle. - "paragraphStyleSuggestionState": { # A mask that indicates which of the fields on the base ParagraphStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in paragraph style have been changed in this suggestion. - "alignmentSuggested": True or False, # Indicates if there was a suggested change to alignment. - "avoidWidowAndOrphanSuggested": True or False, # Indicates if there was a suggested change to avoid_widow_and_orphan. - "borderBetweenSuggested": True or False, # Indicates if there was a suggested change to border_between. - "borderBottomSuggested": True or False, # Indicates if there was a suggested change to border_bottom. - "borderLeftSuggested": True or False, # Indicates if there was a suggested change to border_left. - "borderRightSuggested": True or False, # Indicates if there was a suggested change to border_right. - "borderTopSuggested": True or False, # Indicates if there was a suggested change to border_top. - "directionSuggested": True or False, # Indicates if there was a suggested change to direction. - "headingIdSuggested": True or False, # Indicates if there was a suggested change to heading_id. - "indentEndSuggested": True or False, # Indicates if there was a suggested change to indent_end. - "indentFirstLineSuggested": True or False, # Indicates if there was a suggested change to indent_first_line. - "indentStartSuggested": True or False, # Indicates if there was a suggested change to indent_start. - "keepLinesTogetherSuggested": True or False, # Indicates if there was a suggested change to keep_lines_together. - "keepWithNextSuggested": True or False, # Indicates if there was a suggested change to keep_with_next. - "lineSpacingSuggested": True or False, # Indicates if there was a suggested change to line_spacing. - "namedStyleTypeSuggested": True or False, # Indicates if there was a suggested change to named_style_type. - "pageBreakBeforeSuggested": True or False, # Indicates if there was a suggested change to page_break_before. - "shadingSuggestionState": { # A mask that indicates which of the fields on the base Shading have been changed in this suggested change. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in shading have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to the Shading. - }, - "spaceAboveSuggested": True or False, # Indicates if there was a suggested change to space_above. - "spaceBelowSuggested": True or False, # Indicates if there was a suggested change to space_below. - "spacingModeSuggested": True or False, # Indicates if there was a suggested change to spacing_mode. - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields in text style have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - ], + "tabProperties": { # Properties of a tab. # The properties of the tab, like ID and title. + "index": 42, # The index of the tab within the parent. + "nestingLevel": 42, # Output only. The depth of the tab within the document. Root-level tabs start at 0. + "parentTabId": "A String", # Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents. + "tabId": "A String", # Output only. The ID of the tab. This field can't be changed. + "title": "A String", # The user-visible name of the tab. }, }, - }, - "suggestionsViewMode": "A String", # Output only. The suggestions view mode applied to the document. Note: When editing a document, changes must be based on a document with SUGGESTIONS_INLINE. + ], "title": "A String", # The title of the document. }
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html index beeaefc6202..043d1daa237 100644 --- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html @@ -436,6 +436,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. @@ -535,6 +545,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. @@ -2691,6 +2711,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html index 398b3c8d3df..25286e20191 100644 --- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html +++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html @@ -474,6 +474,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. @@ -631,6 +641,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. @@ -3762,6 +3782,16 @@

Method Details

"skipNamingValidation": True or False, # If set, we will skip the naming format validation in the schema. So the string values in `DocumentSchema.EntityType.name` and `DocumentSchema.EntityType.Property.name` will not be checked. }, }, + "genAiModelInfo": { # Information about Generative AI model-based processor versions. # Output only. Information about Generative AI model-based processor versions. + "customGenAiModelInfo": { # Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs. # Information for a custom Generative AI model created by the user. + "baseProcessorVersionId": "A String", # The base processor version ID for the custom model. + "customModelType": "A String", # The type of custom model created by the user. + }, + "foundationGenAiModelInfo": { # Information for a pretrained Google-managed foundation model. # Information for a pretrained Google-managed foundation model. + "finetuningAllowed": True or False, # Whether finetuning is allowed for this base processor version. + "minTrainLabeledDocuments": 42, # The minimum number of labeled documents in the training dataset required for finetuning. + }, + }, "googleManaged": True or False, # Output only. Denotes that this `ProcessorVersion` is managed by Google. "kmsKeyName": "A String", # The KMS key name used for encryption. "kmsKeyVersionName": "A String", # The KMS key version with which data is encrypted. diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 659755b06e2..848116843a9 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -239,7 +239,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -477,7 +477,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -613,7 +613,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. @@ -838,7 +837,7 @@

Method Details

"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search. }, "retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation. - "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation. + "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}` }, @@ -974,7 +973,6 @@

Method Details

"severityScore": 3.14, # Output only. Harm severity score. }, ], - "score": 3.14, # Output only. Confidence score of the candidate. }, ], "promptFeedback": { # Content filter results for a prompt sent in the request. # Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations. diff --git a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html index 11ad3023ad7..5e239dc54c5 100644 --- a/docs/dyn/firestore_v1.projects.databases.backupSchedules.html +++ b/docs/dyn/firestore_v1.projects.databases.backupSchedules.html @@ -110,24 +110,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } @@ -142,24 +130,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } @@ -199,24 +175,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } @@ -240,24 +204,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, }, ], @@ -276,24 +228,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } @@ -309,24 +249,12 @@

Method Details

{ # A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though. "createTime": "A String", # Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time. "dailyRecurrence": { # Represents a recurring schedule that runs every day. The time zone is UTC. # For a schedule that runs daily. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, "name": "A String", # Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project}/databases/{database}/backupSchedules/{backup_schedule}` - "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks. + "retention": "A String", # At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks. "updateTime": "A String", # Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time. "weeklyRecurrence": { # Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. # For a schedule that runs weekly on a specific day. "day": "A String", # The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed. - "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise. - "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. - "minutes": 42, # Minutes of hour of day. Must be from 0 to 59. - "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999. - "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds. - }, }, } diff --git a/docs/dyn/firestore_v1.projects.databases.documents.html b/docs/dyn/firestore_v1.projects.databases.documents.html index bd23e9a936c..773353a79ed 100644 --- a/docs/dyn/firestore_v1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1.projects.databases.documents.html @@ -1227,7 +1227,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -1503,7 +1503,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -1873,7 +1873,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -2116,7 +2116,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. diff --git a/docs/dyn/firestore_v1beta1.projects.databases.documents.html b/docs/dyn/firestore_v1beta1.projects.databases.documents.html index a86bb4b6ef9..6c2d1f0876a 100644 --- a/docs/dyn/firestore_v1beta1.projects.databases.documents.html +++ b/docs/dyn/firestore_v1beta1.projects.databases.documents.html @@ -1227,7 +1227,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -1503,7 +1503,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -1873,7 +1873,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. @@ -2116,7 +2116,7 @@

Method Details

}, ], }, - "findNearest": { # Nearest Neighbors search config. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. + "findNearest": { # Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries. # Optional. A potential nearest neighbors search. Applies after all other filters and ordering. Finds the closest vector embeddings to the given query vector. "distanceMeasure": "A String", # Required. The distance measure to use, required. "limit": 42, # Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000. "queryVector": { # A message that can hold any of the supported value types. # Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html index 6e194f21b3b..ded0b959705 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.dicomStores.html @@ -303,7 +303,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationStore": "A String", # Required. The name of the DICOM store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store. "filterConfig": { # Specifies the filter configuration for DICOM resources. # Filter configuration. diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html index aa7cae266bb..a602b6a6713 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html @@ -141,10 +141,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -156,15 +156,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -266,7 +266,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -276,10 +276,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -298,10 +298,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -313,15 +313,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -423,7 +423,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -433,10 +433,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -545,7 +545,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationStore": "A String", # Required. The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. "gcsConfigUri": "A String", # Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. @@ -620,7 +620,7 @@

Method Details

"_type": "A String", # String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) are exported. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The BigQuery output destination. The Cloud Healthcare Service Agent requires two IAM roles on the BigQuery location: `roles/bigquery.dataEditor` and `roles/bigquery.jobUser`. The output is one BigQuery table per resource type. Unlike when setting `BigQueryDestination` for `StreamConfig`, `ExportResources` does not create BigQuery views. "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -681,10 +681,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -696,15 +696,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -806,7 +806,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -816,10 +816,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -968,10 +968,10 @@

Method Details

"fhirStores": [ # The returned FHIR stores. Won't be more FHIR stores than the value of page_size in the request. { # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -983,15 +983,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -1093,7 +1093,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -1103,10 +1103,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -1143,10 +1143,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -1158,15 +1158,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -1268,7 +1268,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -1278,10 +1278,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -1300,10 +1300,10 @@

Method Details

{ # Represents a FHIR store. "complexDataTypeReferenceParsing": "A String", # Enable parsing of references within complex FHIR data types such as Extensions. If this value is set to ENABLED, then features like referential integrity and Bundle reference rewriting apply to all references. If this flag has not been specified the behavior of the FHIR store will not change, references in complex data types will not be parsed. New stores will have this value set to ENABLED after a notification period. Warning: turning on this flag causes processing existing resources to fail if they contain references to non-existent resources. - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -1315,15 +1315,15 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a FHIR store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic. The default value is false. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "streamConfigs": [ # A list of streaming configs that configure the destinations of streaming export for every resource mutation in this FHIR store. Each store is allowed to have up to 10 streaming configs. After a new config is added, the next resource mutation is streamed to the new location in addition to the existing ones. When a location is removed from the list, the server stops streaming to that location. Before adding a new config, you must add the required [`bigquery.dataEditor`](https://cloud.google.com/bigquery/docs/access-control#bigquery.dataEditor) role to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/iam/docs/service-accounts). Some lag (typically on the order of dozens of seconds) is expected before the results show up in the streaming destination. { # Contains configuration for streaming FHIR export. "bigqueryDestination": { # The configuration for exporting to BigQuery. # The destination BigQuery structure that contains both the dataset location and corresponding schema config. The output is organized in one table per resource type. The server reuses the existing tables (if any) that are named after the resource types. For example, "Patient", "Observation". When there is no existing table for a given resource type, the server attempts to create one. When a table schema doesn't align with the schema config, either because of existing incompatible schema or out of band incompatible modification, the server does not stream in new data. BigQuery imposes a 1 MB limit on streaming insert row size, therefore any resource mutation that generates more than 1 MB of BigQuery data is not streamed. One resolution in this case is to delete the incompatible table and let the server recreate one, though the newly created table only contains data after the table recreation. Results are written to BigQuery tables according to the parameters in BigQueryDestination.WriteDisposition. Different versions of the same resource are distinguishable by the meta.versionId and meta.lastUpdated columns. The operation (CREATE/UPDATE/DELETE) that results in the new version is recorded in the meta.tag. The tables contain all historical resource versions since streaming was enabled. For query convenience, the server also creates one view per table of the same name containing only the current resource version. The streamed data in the BigQuery dataset is not guaranteed to be completely unique. The combination of the id and meta.versionId columns should ideally identify a single unique row. But in rare cases, duplicates may exist. At query time, users may use the SQL select statement to keep only one of the duplicate rows given an id and meta.versionId pair. Alternatively, the server created view mentioned above also filters out duplicates. If a resource mutation cannot be streamed to BigQuery, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). "datasetUri": "A String", # BigQuery URI to an existing dataset, up to 2000 characters long, in the format `bq://projectId.bqDatasetId`. - "force": True or False, # If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. + "force": True or False, # The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE. "schemaConfig": { # Configuration for the FHIR BigQuery schema. Determines how the server generates the schema. # The configuration for the exported BigQuery schema. "lastUpdatedPartitionConfig": { # Configuration for FHIR BigQuery time-partitioned tables. # The configuration for exported BigQuery tables to be partitioned by FHIR resource's last updated time column. "expirationMs": "A String", # Number of milliseconds for which to keep the storage for a partition. @@ -1425,7 +1425,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -1435,10 +1435,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.messages.html b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.messages.html index e8a541c6d7d..69fe69d8eab 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.messages.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.hl7V2Stores.messages.html @@ -120,7 +120,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -133,18 +133,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. }, } @@ -162,7 +162,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -175,18 +175,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. } @@ -236,7 +236,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -249,18 +249,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. } @@ -280,7 +280,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -293,18 +293,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. }, } @@ -324,7 +324,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -337,18 +337,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. }, } @@ -387,7 +387,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -400,18 +400,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. }, ], "nextPageToken": "A String", # Token to retrieve the next page of results or empty if there are no more results in the list. @@ -447,7 +447,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -460,18 +460,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. } updateMask: string, Required. The update mask applies to the resource. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask @@ -489,7 +489,7 @@

Method Details

"labels": { # User-supplied key-value pairs used to organize HL7v2 stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, - "messageType": "A String", # The message type for this message. MSH-9.1. + "messageType": "A String", # Output only. The message type for this message. MSH-9.1. "name": "A String", # Output only. Resource name of the Message, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7_v2_store_id}/messages/{message_id}`. "parsedData": { # The content of a HL7v2 message in a structured format. # Output only. The parsed version of the raw message data. "segments": [ @@ -502,18 +502,18 @@

Method Details

}, ], }, - "patientIds": [ # All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. + "patientIds": [ # Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message. { # A patient identifier and associated type. "type": "A String", # ID type. For example, MRN or NHS. "value": "A String", # The patient's unique identifier. }, ], - "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # The parsed version of the raw message data schematized according to this store's schemas and type definitions. + "schematizedData": { # The content of an HL7v2 message in a structured format as specified by a schema. # Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions. "data": "A String", # JSON output of the parser. "error": "A String", # The error output of the parser. }, - "sendFacility": "A String", # The hospital that this message came from. MSH-4. - "sendTime": "A String", # The datetime the sending application sent this message. MSH-7. + "sendFacility": "A String", # Output only. The hospital that this message came from. MSH-4. + "sendTime": "A String", # Output only. The datetime the sending application sent this message. MSH-7. } diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.html b/docs/dyn/healthcare_v1.projects.locations.datasets.html index 7d4674a9b5d..e3cb7d9ce65 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.html @@ -290,7 +290,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationDataset": "A String", # Required. The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same location as the source dataset. De-identifying data across multiple locations is not supported. "gcsConfigUri": "A String", # Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html index 0f8eba6bf43..60442bbd510 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.dicomStores.html @@ -414,7 +414,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationStore": "A String", # Required. The name of the DICOM store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination DICOM store must not exist. * The caller must have the necessary permissions to create the destination DICOM store. "filterConfig": { # Specifies the filter configuration for DICOM resources. # Filter configuration. diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html index 1658c43b7ea..e706e1a210a 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html @@ -306,7 +306,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -315,11 +315,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -331,8 +331,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -557,7 +557,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -567,10 +567,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -593,7 +593,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -602,11 +602,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -618,8 +618,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -844,7 +844,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -854,10 +854,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -1074,7 +1074,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationStore": "A String", # Required. The name of the FHIR store to create and write the redacted data to. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. * The destination dataset must exist. * The source dataset and destination dataset must both reside in the same location. De-identifying data across multiple locations is not supported. * The destination FHIR store must exist. * The caller must have the healthcare.fhirResources.update permission to write to the destination FHIR store. "gcsConfigUri": "A String", # Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. @@ -1315,7 +1315,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -1324,11 +1324,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -1340,8 +1340,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -1566,7 +1566,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -1576,10 +1576,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -1778,7 +1778,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -1787,11 +1787,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -1803,8 +1803,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -2029,7 +2029,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -2039,10 +2039,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -2083,7 +2083,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -2092,11 +2092,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -2108,8 +2108,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -2334,7 +2334,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -2344,10 +2344,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], @@ -2370,7 +2370,7 @@

Method Details

"accessDeterminationLogConfig": { # Configures consent audit log config for FHIR create, read, update, and delete (CRUD) operations. Cloud audit log for healthcare API must be [enabled](https://cloud.google.com/logging/docs/audit/configure-data-access#config-console-enable). The consent-related logs are included as part of `protoPayload.metadata`. # Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used. "logLevel": "A String", # Optional. Controls the amount of detail to include as part of the audit logs. }, - "accessEnforced": True or False, # Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. + "accessEnforced": True or False, # Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers. "consentHeaderHandling": { # How the server handles the consent header. # Optional. Different options to configure the behaviour of the server when handling the `X-Consent-Scope` header. "profile": "A String", # Optional. Specifies the default server behavior when the header is empty. If not specified, the `ScopeProfile.PERMIT_EMPTY_SCOPE` option is used. }, @@ -2379,11 +2379,11 @@

Method Details

], "version": "A String", # Required. Specifies which consent enforcement version is being used for this FHIR store. This field can only be set once by either CreateFhirStore or UpdateFhirStore. After that, you must call ApplyConsents to change the version. }, - "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. + "defaultSearchHandlingStrict": True or False, # If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false. "disableReferentialIntegrity": True or False, # Immutable. Whether to disable referential integrity in this FHIR store. This field is immutable after FHIR store creation. The default value is false, meaning that the API enforces referential integrity and fails the requests that result in inconsistent state in the FHIR store. When this field is set to true, the API skips referential integrity checks. Consequently, operations that rely on references, such as GetPatientEverything, do not return all the results if broken references exist. - "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. - "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. - "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. + "disableResourceVersioning": True or False, # Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false. + "enableHistoryModifications": True or False, # Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false. + "enableUpdateCreate": True or False, # Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false. "labels": { # User-supplied key-value pairs used to organize FHIR stores. Label keys must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values are optional, must be between 1 and 63 characters long, have a UTF-8 encoding of maximum 128 bytes, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given store. "a_key": "A String", }, @@ -2395,8 +2395,8 @@

Method Details

"notificationConfigs": [ # Specifies where and whether to send notifications upon changes to a Fhir store. { # Contains the configuration for FHIR notifications. "pubsubTopic": "A String", # The [Pub/Sub](https://cloud.google.com/pubsub/docs/) topic that notifications of changes are published on. Supplied by the client. The notification is a `PubsubMessage` with the following fields: * `PubsubMessage.Data` contains the resource name. * `PubsubMessage.MessageId` is the ID of this notification. It is guaranteed to be unique within the topic. * `PubsubMessage.PublishTime` is the time when the message was published. Note that notifications are only sent if the topic is non-empty. [Topic names](https://cloud.google.com/pubsub/docs/overview#names) must be scoped to a project. The Cloud Healthcare API service account, service-@gcp-sa-healthcare.iam.gserviceaccount.com, must have publisher permissions on the given Pub/Sub topic. Not having adequate permissions causes the calls that send notifications to fail (https://cloud.google.com/healthcare-api/docs/permissions-healthcare-api-gcp-products#dicom_fhir_and_hl7v2_store_cloud_pubsub_permissions). If a notification can't be published to Pub/Sub, errors are logged to Cloud Logging. For more information, see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare-api/docs/how-tos/logging). - "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. - "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. + "sendFullResource": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation. + "sendPreviousResourceOnDelete": True or False, # Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the "payloadType" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation. }, ], "searchConfig": { # Contains the configuration for FHIR search. # Configuration for how FHIR resources can be searched. @@ -2621,7 +2621,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "store": "A String", # The full resource name of a Cloud Healthcare FHIR store, for example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. }, @@ -2631,10 +2631,10 @@

Method Details

}, ], "validationConfig": { # Contains the configuration for FHIR profiles and validation. # Configuration for how to validate incoming FHIR resources against configured profiles. - "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. - "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. - "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableFhirpathValidation": True or False, # Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableProfileValidation": True or False, # Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store. + "disableReferenceTypeValidation": True or False, # Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. + "disableRequiredFieldValidation": True or False, # Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced. "enabledImplementationGuides": [ # A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `["http://hl7.org/fhir/us/core/ImplementationGuide/ig"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using "value" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error. "A String", ], diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html index 91ac690d1ec..d8f7c006902 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.html @@ -403,7 +403,7 @@

Method Details

}, ], }, - "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. + "useRegionalDataProcessing": True or False, # Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. }, "destinationDataset": "A String", # Required. The name of the dataset resource to create and write the redacted data to. * The destination dataset must not exist. * The destination dataset must be in the same location as the source dataset. De-identifying data across multiple locations is not supported. "gcsConfigUri": "A String", # Cloud Storage location to read the JSON cloud.healthcare.deidentify.DeidentifyConfig from, overriding the default config. Must be of the form `gs://{bucket_id}/path/to/object`. The Cloud Storage location must grant the Cloud IAM role `roles/storage.objectViewer` to the project's Cloud Healthcare Service Agent service account. Only one of `config` and `gcs_config_uri` can be specified. diff --git a/docs/dyn/iam_v1.organizations.roles.html b/docs/dyn/iam_v1.organizations.roles.html index e24617f8b56..d2fd7ed9885 100644 --- a/docs/dyn/iam_v1.organizations.roles.html +++ b/docs/dyn/iam_v1.organizations.roles.html @@ -82,7 +82,7 @@

Instance Methods

Creates a new custom Role.

delete(name, etag=None, x__xgafv=None)

-

Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.

+

Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.

get(name, x__xgafv=None)

Gets the definition of a Role.

@@ -151,7 +151,7 @@

Method Details

delete(name, etag=None, x__xgafv=None) -
Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.
+  
Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.
 
 Args:
   name: string, The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. (required)
diff --git a/docs/dyn/iam_v1.projects.roles.html b/docs/dyn/iam_v1.projects.roles.html
index 586f98ae8dd..2383f955582 100644
--- a/docs/dyn/iam_v1.projects.roles.html
+++ b/docs/dyn/iam_v1.projects.roles.html
@@ -82,7 +82,7 @@ 

Instance Methods

Creates a new custom Role.

delete(name, etag=None, x__xgafv=None)

-

Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.

+

Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.

get(name, x__xgafv=None)

Gets the definition of a Role.

@@ -151,7 +151,7 @@

Method Details

delete(name, etag=None, x__xgafv=None) -
Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.
+  
Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.
 
 Args:
   name: string, The `name` parameter's value depends on the target resource for the request, namely [projects](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles) or [organizations](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles). Each resource type's `name` value format is described below: * [projects.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/projects.roles/delete): `projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the project level. Example request URL: `https://iam.googleapis.com/v1/projects/{PROJECT_ID}/roles/{CUSTOM_ROLE_ID}` * [organizations.roles.delete](https://cloud.google.com/iam/docs/reference/rest/v1/organizations.roles/delete): `organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}`. This method deletes only [custom roles](https://cloud.google.com/iam/docs/understanding-custom-roles) that have been created at the organization level. Example request URL: `https://iam.googleapis.com/v1/organizations/{ORGANIZATION_ID}/roles/{CUSTOM_ROLE_ID}` Note: Wildcard (*) values are invalid; you must specify a complete project ID or organization ID. (required)
diff --git a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
index 208dda47cf7..39ceb9dee30 100644
--- a/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
+++ b/docs/dyn/iam_v1.projects.serviceAccounts.keys.html
@@ -95,9 +95,6 @@ 

Instance Methods

list(name, keyTypes=None, x__xgafv=None)

Lists every ServiceAccountKey for a service account.

-

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

-

Patches a ServiceAccountKey.

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

Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.

@@ -130,9 +127,6 @@

Method Details

An object of the form: { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. - "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. - "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. - "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -241,9 +235,6 @@

Method Details

An object of the form: { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. - "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. - "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. - "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -286,9 +277,6 @@

Method Details

{ # The service account keys list response. "keys": [ # The public keys for the service account. { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. - "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. - "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. - "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. @@ -311,73 +299,6 @@

Method Details

}
-
- patch(name, body=None, x__xgafv=None) -
Patches a ServiceAccountKey.
-
-Args:
-  name: string, The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # The service account key patch request.
-  "serviceAccountKey": { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. # Required. The service account key to update.
-    "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
-    "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
-    "description": "A String", # Optional. A user provided description of this service account key.
-    "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
-    "disabled": True or False, # The key status.
-    "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
-      { # Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
-        "key": "A String", # The key for this extended status.
-        "value": "A String", # The value for the extended status.
-      },
-    ],
-    "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
-    "keyOrigin": "A String", # The key origin.
-    "keyType": "A String", # The key type.
-    "name": "A String", # The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
-    "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
-    "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
-    "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
-    "validAfterTime": "A String", # The key can be used after this timestamp.
-    "validBeforeTime": "A String", # The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
-  },
-  "updateMask": "A String", # Required. The update mask to apply to the service account key. Only the following fields are eligible for patching: - contact - description
-}
-
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.
-  "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.
-  "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.
-  "description": "A String", # Optional. A user provided description of this service account key.
-  "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.
-  "disabled": True or False, # The key status.
-  "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status.
-    { # Extended status can store additional metadata. For example, for keys disabled due to their private key data being expoesed we may include a message with more information about the exposure.
-      "key": "A String", # The key for this extended status.
-      "value": "A String", # The value for the extended status.
-    },
-  ],
-  "keyAlgorithm": "A String", # Specifies the algorithm (and possibly key size) for the key.
-  "keyOrigin": "A String", # The key origin.
-  "keyType": "A String", # The key type.
-  "name": "A String", # The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.
-  "privateKeyData": "A String", # The private key data. Only provided in `CreateServiceAccountKey` responses. Make sure to keep the private key data secure because it allows for the assertion of the service account identity. When base64 decoded, the private key data can be used to authenticate with Google API client libraries and with gcloud auth activate-service-account.
-  "privateKeyType": "A String", # The output format for the private key. Only provided in `CreateServiceAccountKey` responses, not in `GetServiceAccountKey` or `ListServiceAccountKey` responses. Google never exposes system-managed private keys, and never retains user-managed private keys.
-  "publicKeyData": "A String", # The public key data. Only provided in `GetServiceAccountKey` responses.
-  "validAfterTime": "A String", # The key can be used after this timestamp.
-  "validBeforeTime": "A String", # The key can be used before this timestamp. For system-managed key pairs, this timestamp is the end time for the private key signing operation. The public key could still be used for verification for a few hours after this time.
-}
-
-
upload(name, body=None, x__xgafv=None)
Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.
@@ -400,9 +321,6 @@ 

Method Details

An object of the form: { # Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API. - "contact": "A String", # Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters. - "creator": "A String", # Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user. - "description": "A String", # Optional. A user provided description of this service account key. "disableReason": "A String", # Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled. "disabled": True or False, # The key status. "extendedStatus": [ # Output only. Extended Status provides permanent information about a service account key. For example, if this key was detected as exposed or compromised, that information will remain for the lifetime of the key in the extended_status. diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 059ad88ad4f..4a7ce03a070 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -50,6 +50,7 @@ ## adsenseplatform +* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/adsenseplatform_v1.html) * [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/adsenseplatform_v1alpha.html) @@ -163,6 +164,7 @@ ## authorizedbuyersmarketplace * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/authorizedbuyersmarketplace_v1.html) +* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/authorizedbuyersmarketplace_v1alpha.html) ## backupdr @@ -547,10 +549,6 @@ * [v1beta1](http://googleapis.github.io/google-api-python-client/docs/dyn/domains_v1beta1.html) -## domainsrdap -* [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/domainsrdap_v1.html) - - ## doubleclickbidmanager * [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/doubleclickbidmanager_v2.html) diff --git a/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html b/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html index 3e0fba6088f..c718ebf7113 100644 --- a/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html +++ b/docs/dyn/manufacturers_v1.accounts.languages.productCertifications.html @@ -154,6 +154,9 @@

Method Details

], "issues": [ # Output only. 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. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. @@ -221,6 +224,9 @@

Method Details

], "issues": [ # Output only. 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. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. @@ -294,6 +300,9 @@

Method Details

], "issues": [ # Output only. 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. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. @@ -350,6 +359,9 @@

Method Details

], "issues": [ # Output only. 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. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. diff --git a/docs/dyn/manufacturers_v1.accounts.products.html b/docs/dyn/manufacturers_v1.accounts.products.html index 48fbc73fcb9..adfe5f69c57 100644 --- a/docs/dyn/manufacturers_v1.accounts.products.html +++ b/docs/dyn/manufacturers_v1.accounts.products.html @@ -381,6 +381,9 @@

Method Details

], "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. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. @@ -666,6 +669,9 @@

Method Details

], "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. + "A String", + ], "attribute": "A String", # If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116. "description": "A String", # Longer description of the issue focused on how to resolve it. "destination": "A String", # The destination this issue applies to. diff --git a/docs/dyn/meet_v2.spaces.html b/docs/dyn/meet_v2.spaces.html index 9512ee26de6..d7f913b2575 100644 --- a/docs/dyn/meet_v2.spaces.html +++ b/docs/dyn/meet_v2.spaces.html @@ -82,13 +82,13 @@

Instance Methods

Creates a space.

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

-

Ends an active conference (if there's one).

+

Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).

get(name, x__xgafv=None)

-

Gets a space by `space_id` or `meeting_code`.

+

Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).

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

-

Updates a space.

+

Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).

Method Details

close() @@ -111,9 +111,9 @@

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). } x__xgafv: string, V1 error format. @@ -132,18 +132,18 @@

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). }
endActiveConference(name, body=None, x__xgafv=None) -
Ends an active conference (if there's one).
+  
Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).
 
 Args:
-  name: string, Required. Resource name of the space. (required)
+  name: string, Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -164,10 +164,10 @@ 

Method Details

get(name, x__xgafv=None) -
Gets a space by `space_id` or `meeting_code`.
+  
Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).
 
 Args:
-  name: string, Required. Resource name of the space. (required)
+  name: string, Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -184,18 +184,18 @@ 

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). }
patch(name, body=None, updateMask=None, x__xgafv=None) -
Updates a space.
+  
Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).
 
 Args:
-  name: string, Immutable. Resource name of the space. Format: `spaces/{space}` (required)
+  name: string, Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -207,9 +207,9 @@ 

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). } updateMask: string, Optional. Field mask used to specify the fields to be updated in the space. If update_mask isn't provided, it defaults to '*' and updates all fields provided in the request, including deleting fields not set in the request. @@ -229,9 +229,9 @@

Method Details

"accessType": "A String", # Access type of the meeting space that determines who can join without knocking. Default: The user's default access settings. Controlled by the user's admin for enterprise users or RESTRICTED. "entryPointAccess": "A String", # Defines the entry points that can be used to join meetings hosted in this meeting space. Default: EntryPointAccess.ALL }, - "meetingCode": "A String", # Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space. - "meetingUri": "A String", # Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`. - "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}` + "meetingCode": "A String", # Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space. + "meetingUri": "A String", # Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`. + "name": "A String", # Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space). }
diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html index 1e395b2dce6..dfb4ac59f9e 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.termsOfServiceAgreementStates.html @@ -94,7 +94,7 @@

Method Details

Returns the state of a terms of service agreement.
 
 Args:
-  name: string, Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` (required)
+  name: string, Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -113,7 +113,7 @@ 

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` + "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US` "regionCode": "A String", # Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. "required": { # Describes the terms of service which are required to be accepted. # The required terms of service "termsOfService": "A String", # The [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) that need to be accepted. @@ -147,7 +147,7 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` + "name": "A String", # Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US` "regionCode": "A String", # Region code as defined by https://cldr.unicode.org/. This is the country the current state applies to. "required": { # Describes the terms of service which are required to be accepted. # The required terms of service "termsOfService": "A String", # The [termsOfService](google.shopping.merchant.accounts.v1main.TermsOfService) that need to be accepted. diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html index 782e68c5f86..062bd051fde 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.productInputs.html @@ -237,6 +237,10 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "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. + }, "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -532,6 +536,10 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "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. + }, "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html index 0ef5c8a407e..e8cd960f477 100644 --- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html +++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html @@ -226,6 +226,10 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "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. + }, "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). @@ -566,6 +570,10 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "loyaltyPoints": "A String", # The amount of loyalty points earned on a purchase. + "memberPriceEffectiveDate": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash. + "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. + }, "price": { # The price represented as a number and currency. # The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price. "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros). "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html index 4487d8d0463..b23239c5367 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.preferenceSets.html @@ -172,7 +172,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -389,7 +389,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -546,7 +546,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -711,7 +711,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). diff --git a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html index c8f77e4d0a8..bb969be8896 100644 --- a/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html +++ b/docs/dyn/migrationcenter_v1alpha1.projects.locations.reportConfigs.reports.html @@ -401,7 +401,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -473,7 +473,7 @@

Method Details

"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. }, }, - "monthlyCostCompute": { # Represents an amount of money with its currency type. # Compute monthly cost for this preference set. + "monthlyCostCompute": { # Represents an amount of money with its currency type. # Output only. Compute 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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -488,27 +488,27 @@

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. }, - "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Network Egress monthly cost for this preference set. Only present for virtual machines. + "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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Operating system licensing monthly cost for this preference set. Only present for virtual machines. + "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Output only. Operating system licensing 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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "monthlyCostOther": { # Represents an amount of money with its currency type. # Miscellaneous monthly cost for this preference set. + "monthlyCostOther": { # Represents an amount of money with its currency type. # Output only. Miscellaneous 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. "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. # Storage monthly cost for this preference set. + "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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "monthlyCostTotal": { # Represents an amount of money with its currency type. # Total monthly cost for this preference set. + "monthlyCostTotal": { # Represents an amount of money with its currency type. # Output only. Total 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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -575,7 +575,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -1152,7 +1152,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -1224,7 +1224,7 @@

Method Details

"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. }, }, - "monthlyCostCompute": { # Represents an amount of money with its currency type. # Compute monthly cost for this preference set. + "monthlyCostCompute": { # Represents an amount of money with its currency type. # Output only. Compute 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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -1239,27 +1239,27 @@

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. }, - "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Network Egress monthly cost for this preference set. Only present for virtual machines. + "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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Operating system licensing monthly cost for this preference set. Only present for virtual machines. + "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Output only. Operating system licensing 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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "monthlyCostOther": { # Represents an amount of money with its currency type. # Miscellaneous monthly cost for this preference set. + "monthlyCostOther": { # Represents an amount of money with its currency type. # Output only. Miscellaneous 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. "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. # Storage monthly cost for this preference set. + "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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "monthlyCostTotal": { # Represents an amount of money with its currency type. # Total monthly cost for this preference set. + "monthlyCostTotal": { # Represents an amount of money with its currency type. # Output only. Total 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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -1326,7 +1326,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -1844,7 +1844,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). @@ -1916,7 +1916,7 @@

Method Details

"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. }, }, - "monthlyCostCompute": { # Represents an amount of money with its currency type. # Compute monthly cost for this preference set. + "monthlyCostCompute": { # Represents an amount of money with its currency type. # Output only. Compute 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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -1931,27 +1931,27 @@

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. }, - "monthlyCostNetworkEgress": { # Represents an amount of money with its currency type. # Network Egress monthly cost for this preference set. Only present for virtual machines. + "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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Operating system licensing monthly cost for this preference set. Only present for virtual machines. + "monthlyCostOsLicense": { # Represents an amount of money with its currency type. # Output only. Operating system licensing 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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "monthlyCostOther": { # Represents an amount of money with its currency type. # Miscellaneous monthly cost for this preference set. + "monthlyCostOther": { # Represents an amount of money with its currency type. # Output only. Miscellaneous 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. "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. # Storage monthly cost for this preference set. + "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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, - "monthlyCostTotal": { # Represents an amount of money with its currency type. # Total monthly cost for this preference set. + "monthlyCostTotal": { # Represents an amount of money with its currency type. # Output only. Total 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. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. @@ -2018,7 +2018,7 @@

Method Details

}, ], }, - "multithreading": "A String", # Optional. Preferences for multithreading support. + "multithreading": "A String", # Optional. Preferences for multithreading support on Windows Server. "osPricingPreferences": { # Pricing options for OS images. # Optional. Pricing options for OS images. "rhel": { # Pricing options of an OS image. # Optional. Pricing options for RHEL images. "commitmentPlan": "A String", # Optional. The plan of commitments for committed use discounts (CUD). diff --git a/docs/dyn/pollen_v1.forecast.html b/docs/dyn/pollen_v1.forecast.html index e7790a78e00..8276d34d008 100644 --- a/docs/dyn/pollen_v1.forecast.html +++ b/docs/dyn/pollen_v1.forecast.html @@ -95,12 +95,12 @@

Method Details

Args: days: integer, Required. A number that indicates how many forecast days to request (minimum value 1, maximum value is 5). - languageCode: string, Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. Default value is "en". + languageCode: string, Optional. Allows the client to choose the language for the response. If data cannot be provided for that language, the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. The default value is "en". location_latitude: number, The latitude in degrees. It must be in the range [-90.0, +90.0]. location_longitude: number, The longitude in degrees. It must be in the range [-180.0, +180.0]. - pageSize: integer, Optional. The maximum number of daily info records to return per page. The default and max value is 5 (5 days of data). - pageToken: string, Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token all other request parameters provided must match the previous call that provided the page token. - plantsDescription: boolean, Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. + pageSize: integer, Optional. The maximum number of daily info records to return per page. The default and max value is 5, indicating 5 days of data. + pageToken: string, Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token, all other request parameters provided must match the previous call that provided the page token. + plantsDescription: boolean, Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. The default value is "true". x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -117,7 +117,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. }, - "plantInfo": [ # This list will include (up to) 15 pollen species affecting the location specified in the request. + "plantInfo": [ # This list will include up to 15 pollen species affecting the location specified in the request. { # This object contains the daily information on specific plant. "code": "A String", # The plant code name. For example: "COTTONWOOD". A list of all available codes could be found here. "displayName": "A String", # A human readable representation of the plant name. Example: “Cottonwood". @@ -147,7 +147,7 @@

Method Details

}, }, ], - "pollenTypeInfo": [ # This list will include (up to) three pollen types (grass, weed, tree) affecting the location specified in the request. + "pollenTypeInfo": [ # This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request. { # This object contains the pollen type index and health recommendation information on specific pollen type. "code": "A String", # The pollen type's code name. For example: "GRASS" "displayName": "A String", # A human readable representation of the pollen type name. Example: "Grass" diff --git a/docs/dyn/pollen_v1.mapTypes.heatmapTiles.html b/docs/dyn/pollen_v1.mapTypes.heatmapTiles.html index 66a67e1a368..bf7a1632267 100644 --- a/docs/dyn/pollen_v1.mapTypes.heatmapTiles.html +++ b/docs/dyn/pollen_v1.mapTypes.heatmapTiles.html @@ -96,7 +96,7 @@

Method Details

MAP_TYPE_UNSPECIFIED - Unspecified map type. TREE_UPI - The heatmap type will represent a tree index graphical map. GRASS_UPI - The heatmap type will represent a grass index graphical map. - WEED_UPI - The heatmap type will represent a weed index graphically map. + WEED_UPI - The heatmap type will represent a weed index graphical map. zoom: integer, Required. The map's zoom level. Defines how large or small the contents of a map appear in a map view. * Zoom level 0 is the entire world in a single tile. * Zoom level 1 is the entire world in 4 tiles. * Zoom level 2 is the entire world in 16 tiles. * Zoom level 16 is the entire world in 65,536 tiles. Allowed values: 0-16 (required) x: integer, Required. Defines the east-west point in the requested tile. (required) y: integer, Required. Defines the north-south point in the requested tile. (required) diff --git a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html index e0098b8a96c..f8fab87468a 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.assessments.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.assessments.html @@ -155,7 +155,7 @@

Method Details

}, "event": { # The event being assessed. # Optional. The event being assessed. "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. - "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS. + "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference an Express site key. "firewallPolicyEvaluation": True or False, # Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response. "fraudPrevention": "A String", # Optional. The Fraud Prevention setting for this assessment. "hashedAccountId": "A String", # Optional. Deprecated: use `user_info.account_id` instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret. @@ -367,7 +367,7 @@

Method Details

}, "event": { # The event being assessed. # Optional. The event being assessed. "expectedAction": "A String", # Optional. The expected action for this type of event. This should be the same action provided at token generation time on client-side platforms already integrated with recaptcha enterprise. - "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS. + "express": True or False, # Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference an Express site key. "firewallPolicyEvaluation": True or False, # Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response. "fraudPrevention": "A String", # Optional. The Fraud Prevention setting for this assessment. "hashedAccountId": "A String", # Optional. Deprecated: use `user_info.account_id` instead. Unique stable hashed user identifier for the request. The identifier must be hashed using hmac-sha256 with stable secret. diff --git a/docs/dyn/recaptchaenterprise_v1.projects.keys.html b/docs/dyn/recaptchaenterprise_v1.projects.keys.html index 2d9bc53dddc..c4935c6164b 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.keys.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.keys.html @@ -129,6 +129,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -140,7 +142,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -181,6 +183,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -192,7 +196,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -258,6 +262,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -269,7 +275,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -365,6 +371,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -376,7 +384,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -427,7 +435,7 @@

Method Details

The object takes the form of: { # The migrate key request message. - "skipBillingCheck": True or False, # Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information. + "skipBillingCheck": True or False, # Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha/docs/billing-information. } x__xgafv: string, V1 error format. @@ -448,6 +456,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -459,7 +469,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -502,6 +512,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -513,7 +525,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. @@ -555,6 +567,8 @@

Method Details

}, "createTime": "A String", # Output only. The timestamp corresponding to the creation of this key. "displayName": "A String", # Required. Human-readable display name of this key. Modifiable by user. + "expressSettings": { # Settings specific to keys that can be used for reCAPTCHA Express. # Settings for keys that can be used by reCAPTCHA Express. + }, "iosSettings": { # Settings specific to keys that can be used by iOS apps. # Settings for keys that can be used by iOS apps. "allowAllBundleIds": True or False, # Optional. If set to true, allowed_bundle_ids are not enforced. "allowedBundleIds": [ # Optional. iOS bundle ids of apps allowed to use the key. Example: 'com.companyname.productname.appname' @@ -566,7 +580,7 @@

Method Details

"teamId": "A String", # Required. The Apple team ID (10-character string) owning the provisioning profile used to build your application. }, }, - "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels). + "labels": { # Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels). "a_key": "A String", }, "name": "A String", # Identifier. The resource name for the Key in the format `projects/{project}/keys/{key}`. diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html index 0154f88c249..83c5280d19d 100644 --- a/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html +++ b/docs/dyn/retail_v2alpha.projects.locations.catalogs.userEvents.html @@ -80,6 +80,9 @@

Instance Methods

collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

+

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

+

Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.

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

Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.

@@ -128,6 +131,58 @@

Method Details

}
+
+ export(parent, body=None, x__xgafv=None) +
Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.
+
+Args:
+  parent: string, Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the `ExportUserEvents` method.
+  "filter": "A String", # A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * Example 4: `eventTime > "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`
+  "outputConfig": { # The output configuration setting. # Required. The output location of the data.
+    "bigqueryDestination": { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to.
+      "datasetId": "A String", # Required. The ID of a BigQuery Dataset.
+      "tableIdPrefix": "A String", # Required. The prefix of exported BigQuery tables.
+      "tableType": "A String", # Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query.
+    },
+    "gcsDestination": { # The Google Cloud Storage output destination configuration. # The Google Cloud Storage location where the output is to be written to.
+      "outputUriPrefix": "A String", # Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
+    },
+  },
+}
+
+  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.
+  },
+}
+
+
import_(parent, body=None, x__xgafv=None)
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
index ff43faa6812..b9a1903e4be 100644
--- a/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
+++ b/docs/dyn/retail_v2beta.projects.locations.catalogs.userEvents.html
@@ -80,6 +80,9 @@ 

Instance Methods

collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)

Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.

+

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

+

Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.

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

Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.

@@ -128,6 +131,58 @@

Method Details

}
+
+ export(parent, body=None, x__xgafv=None) +
Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.
+
+Args:
+  parent: string, Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for the `ExportUserEvents` method.
+  "filter": "A String", # A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > "2012-04-23T18:25:43.511Z" eventsMissingCatalogItems eventTime<"2012-04-23T18:25:43.511Z" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Example 2: `eventTime > "2012-04-23T18:25:43.511Z" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < "2018-04-23T18:30:43.511Z"` * Example 4: `eventTime > "2012-04-23T18:25:43.511Z"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`
+  "outputConfig": { # The output configuration setting. # Required. The output location of the data.
+    "bigqueryDestination": { # The BigQuery output destination configuration. # The BigQuery location where the output is to be written to.
+      "datasetId": "A String", # Required. The ID of a BigQuery Dataset.
+      "tableIdPrefix": "A String", # Required. The prefix of exported BigQuery tables.
+      "tableType": "A String", # Required. Describes the table type. The following values are supported: * `table`: A BigQuery native table. * `view`: A virtual table defined by a SQL query.
+    },
+    "gcsDestination": { # The Google Cloud Storage output destination configuration. # The Google Cloud Storage location where the output is to be written to.
+      "outputUriPrefix": "A String", # Required. The output uri prefix for saving output data to json files. Some mapping examples are as follows: output_uri_prefix sample output(assuming the object is foo.json) ======================== ============================================= gs://bucket/ gs://bucket/foo.json gs://bucket/folder/ gs://bucket/folder/foo.json gs://bucket/folder/item_ gs://bucket/folder/item_foo.json
+    },
+  },
+}
+
+  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.
+  },
+}
+
+
import_(parent, body=None, x__xgafv=None)
Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.
diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html
index e12d81eae40..40f7617950a 100644
--- a/docs/dyn/run_v1.namespaces.configurations.html
+++ b/docs/dyn/run_v1.namespaces.configurations.html
@@ -173,7 +173,7 @@ 

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -527,7 +527,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index af49f150918..097da119b2c 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -187,7 +187,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -507,7 +507,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index 27b4dca0f17..e61f491c7f2 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -177,7 +177,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -539,7 +539,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -952,7 +952,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -1330,7 +1330,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -1704,7 +1704,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -2066,7 +2066,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index 2ff940b53c9..205ebf0490a 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -173,7 +173,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -527,7 +527,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index 9537539183c..fdd03828951 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -187,7 +187,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -507,7 +507,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # Spec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index 145d96a3876..5f86f7fda1b 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -186,7 +186,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -548,7 +548,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -961,7 +961,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -1387,7 +1387,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -1761,7 +1761,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. @@ -2123,7 +2123,7 @@

Method Details

"uid": "A String", # Unique, system-generated identifier for this resource. }, "spec": { # RevisionSpec holds the desired state of the Revision (from the client). # RevisionSpec holds the desired state of the Revision (from the client). - "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80. + "containerConcurrency": 42, # ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "containers": [ # Required. Containers holds the list which define the units of execution for this Revision. In the context of a Revision, we disallow a number of fields on this Container, including: name and lifecycle. { # A single application container. This specifies both the container to run, the command to run in the container and the arguments to supply to it. Note that additional arguments may be supplied by the system to the container at runtime. "args": [ # Arguments to the entrypoint. The docker image's CMD is used if this is not provided. Variable references are not supported in Cloud Run. diff --git a/docs/dyn/run_v2.projects.locations.services.html b/docs/dyn/run_v2.projects.locations.services.html index 1f0ad7dd322..af860d9eaaf 100644 --- a/docs/dyn/run_v2.projects.locations.services.html +++ b/docs/dyn/run_v2.projects.locations.services.html @@ -276,7 +276,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, @@ -602,7 +602,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, @@ -915,7 +915,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, @@ -1185,7 +1185,7 @@

Method Details

"labels": { # Optional. Unstructured key value map that can be used to organize and categorize objects. User-provided labels are shared with Google's billing system, so they can be used to filter, or break down billing charges by team, component, environment, state, etc. For more information, visit https://cloud.google.com/resource-manager/docs/creating-managing-labels or https://cloud.google.com/run/docs/configuring/labels. Cloud Run API v2 does not support labels with `run.googleapis.com`, `cloud.googleapis.com`, `serving.knative.dev`, or `autoscaling.knative.dev` namespaces, and they will be rejected. All system labels in v1 now have a corresponding field in v2 RevisionTemplate. "a_key": "A String", }, - "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. + "maxInstanceRequestConcurrency": 42, # Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1. "nodeSelector": { # Hardware constraints configuration. # Optional. The node selector for the revision template. "accelerator": "A String", # Required. GPU accelerator type to attach to an instance. }, diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html index 2fd43d8c96f..33ebdb4e56d 100644 --- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.customModules.html @@ -112,7 +112,7 @@

Method Details

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -158,7 +158,7 @@ 

Method Details

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,7 +176,7 @@ 

Method Details

Gets an Event Threat Detection custom module.
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,7 +205,7 @@ 

Method Details

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -241,7 +241,7 @@ 

Method Details

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html
index b5cf7ae4e3c..889959c7139 100644
--- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html
+++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.effectiveCustomModules.html
@@ -97,7 +97,7 @@ 

Method Details

Gets an effective Event Threat Detection custom module at the given level.
 
 Args:
-  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (required)
+  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -123,7 +123,7 @@ 

Method Details

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html
index 84325a9b542..d08986119b7 100644
--- a/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html
+++ b/docs/dyn/securitycenter_v1.folders.eventThreatDetectionSettings.html
@@ -101,7 +101,7 @@ 

Method Details

Validates the given Event Threat Detection custom module.
 
 Args:
-  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/securitycenter_v1.folders.sources.findings.html b/docs/dyn/securitycenter_v1.folders.sources.findings.html
index 7a1b0057c10..9c9bd7551bb 100644
--- a/docs/dyn/securitycenter_v1.folders.sources.findings.html
+++ b/docs/dyn/securitycenter_v1.folders.sources.findings.html
@@ -782,7 +782,7 @@ 

Method Details

}, ], }, - "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups. + "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. "service": "A String", # The service or resource provider associated with the resource. "type": "A String", # The full resource type of the resource. }, diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html index 268f8a8a840..018e83d4e2b 100644 --- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.customModules.html @@ -112,7 +112,7 @@

Method Details

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -158,7 +158,7 @@ 

Method Details

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,7 +176,7 @@ 

Method Details

Gets an Event Threat Detection custom module.
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,7 +205,7 @@ 

Method Details

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -241,7 +241,7 @@ 

Method Details

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html
index 37e0b01b4c0..bfcde8e8fd5 100644
--- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html
+++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.effectiveCustomModules.html
@@ -97,7 +97,7 @@ 

Method Details

Gets an effective Event Threat Detection custom module at the given level.
 
 Args:
-  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (required)
+  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -123,7 +123,7 @@ 

Method Details

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html
index 707f785b4ac..cb5d0851741 100644
--- a/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html
+++ b/docs/dyn/securitycenter_v1.organizations.eventThreatDetectionSettings.html
@@ -101,7 +101,7 @@ 

Method Details

Validates the given Event Threat Detection custom module.
 
 Args:
-  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/securitycenter_v1.organizations.sources.findings.html b/docs/dyn/securitycenter_v1.organizations.sources.findings.html
index 15a69bd14dc..abe8029a7d9 100644
--- a/docs/dyn/securitycenter_v1.organizations.sources.findings.html
+++ b/docs/dyn/securitycenter_v1.organizations.sources.findings.html
@@ -1878,7 +1878,7 @@ 

Method Details

}, ], }, - "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups. + "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. "service": "A String", # The service or resource provider associated with the resource. "type": "A String", # The full resource type of the resource. }, diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html index a37a492a4da..3dbca62242d 100644 --- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html +++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.customModules.html @@ -112,7 +112,7 @@

Method Details

Creates a resident Event Threat Detection custom module at the scope of the given Resource Manager parent, and also creates inherited custom modules for all descendants of the given parent. These modules are enabled by default.
 
 Args:
-  parent: string, Required. The new custom module's parent. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -158,7 +158,7 @@ 

Method Details

Deletes the specified Event Threat Detection custom module and all of its descendants in the Resource Manager hierarchy. This method is only supported for resident custom modules.
 
 Args:
-  name: string, Required. Name of the custom module to delete. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -176,7 +176,7 @@ 

Method Details

Gets an Event Threat Detection custom module.
 
 Args:
-  name: string, Required. Name of the custom module to get. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/customModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/customModules/{module}". * "projects/{project}/eventThreatDetectionSettings/customModules/{module}". (required)
+  name: string, Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -205,7 +205,7 @@ 

Method Details

Lists all Event Threat Detection custom modules for the given Resource Manager parent. This includes resident modules defined at the scope of the parent along with modules inherited from ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
@@ -241,7 +241,7 @@ 

Method Details

Lists all resident Event Threat Detection custom modules under the given Resource Manager parent and its descendants.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListDescendantEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDescendantEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html
index 06f10162f6a..fd69bcfd4ce 100644
--- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html
+++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.effectiveCustomModules.html
@@ -97,7 +97,7 @@ 

Method Details

Gets an effective Event Threat Detection custom module at the given level.
 
 Args:
-  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * "organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}". * "projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}". (required)
+  name: string, Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. (required)
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -123,7 +123,7 @@ 

Method Details

Lists all effective Event Threat Detection custom modules for the given parent. This includes resident modules defined at the scope of the parent along with modules inherited from its ancestors.
 
 Args:
-  parent: string, Required. Name of the parent to list custom modules for. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   pageSize: integer, The maximum number of modules to return. The service may return fewer than this value. If unspecified, at most 10 configs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
   pageToken: string, A page token, received from a previous `ListEffectiveEventThreatDetectionCustomModules` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListEffectiveEventThreatDetectionCustomModules` must match the call that provided the page token.
   x__xgafv: string, V1 error format.
diff --git a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html
index 9f6a9590f0a..ff7cf07a47f 100644
--- a/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html
+++ b/docs/dyn/securitycenter_v1.projects.eventThreatDetectionSettings.html
@@ -101,7 +101,7 @@ 

Method Details

Validates the given Event Threat Detection custom module.
 
 Args:
-  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * "organizations/{organization}/eventThreatDetectionSettings". * "folders/{folder}/eventThreatDetectionSettings". * "projects/{project}/eventThreatDetectionSettings". (required)
+  parent: string, Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`. (required)
   body: object, The request body.
     The object takes the form of:
 
diff --git a/docs/dyn/securitycenter_v1.projects.sources.findings.html b/docs/dyn/securitycenter_v1.projects.sources.findings.html
index bf3c8b3e7e0..6b82eb44526 100644
--- a/docs/dyn/securitycenter_v1.projects.sources.findings.html
+++ b/docs/dyn/securitycenter_v1.projects.sources.findings.html
@@ -782,7 +782,7 @@ 

Method Details

}, ], }, - "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups. + "resourcePathString": "A String", # A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups. "service": "A String", # The service or resource provider associated with the resource. "type": "A String", # The full resource type of the resource. }, diff --git a/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html index 0501be9241e..8d975ffa3e5 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.containerThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html index fc38963c6cf..8d65eb4d694 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.eventThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.html b/docs/dyn/securitycenter_v1beta2.folders.html index 57581759b8d..174575b6bb1 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.html +++ b/docs/dyn/securitycenter_v1beta2.folders.html @@ -167,7 +167,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -175,7 +175,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -197,7 +197,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -205,7 +205,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -277,7 +277,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -285,7 +285,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -307,7 +307,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -315,7 +315,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -337,7 +337,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -345,7 +345,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -356,12 +356,12 @@

Method Details

Update the ContainerThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -369,7 +369,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -385,7 +385,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -393,7 +393,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -405,12 +405,12 @@

Method Details

Update the EventThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Event Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -418,7 +418,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -433,7 +433,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -441,7 +441,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -499,12 +499,12 @@

Method Details

Update the SecurityHealthAnalyticsSettings resource.
 
 Args:
-  name: string, The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Security Health Analytics service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -512,7 +512,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -528,7 +528,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -536,7 +536,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -548,12 +548,12 @@

Method Details

Update the VirtualMachineThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Virtual Machine Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -561,7 +561,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -577,7 +577,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -585,7 +585,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -597,12 +597,12 @@

Method Details

Update the WebSecurityScannerSettings resource.
 
 Args:
-  name: string, The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Web Security Scanner service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -610,7 +610,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -625,7 +625,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -633,7 +633,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html b/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html index 114921cc15d..342685ed106 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.securityHealthAnalyticsSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html index 7e1a5aab973..068cd199b00 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.virtualMachineThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html b/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html index f8ad579263d..883b4cca8d8 100644 --- a/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html +++ b/docs/dyn/securitycenter_v1beta2.folders.webSecurityScannerSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html index 54e509390c2..8726521fbb4 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.containerThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html index 52e9904c98e..5d775adfb91 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.eventThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.html b/docs/dyn/securitycenter_v1beta2.organizations.html index 6c2ae1b9fa9..ba9d962344e 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.html @@ -170,7 +170,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -178,7 +178,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -200,7 +200,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -208,7 +208,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -280,7 +280,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -288,7 +288,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -335,7 +335,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -343,7 +343,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -365,7 +365,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -373,7 +373,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -384,12 +384,12 @@

Method Details

Update the ContainerThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -397,7 +397,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -413,7 +413,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -421,7 +421,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -433,12 +433,12 @@

Method Details

Update the EventThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Event Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -446,7 +446,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -461,7 +461,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -469,7 +469,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -527,12 +527,12 @@

Method Details

Update the SecurityHealthAnalyticsSettings resource.
 
 Args:
-  name: string, The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Security Health Analytics service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -540,7 +540,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -556,7 +556,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -564,7 +564,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -576,12 +576,12 @@

Method Details

Update the VirtualMachineThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Virtual Machine Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -589,7 +589,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -605,7 +605,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -613,7 +613,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -625,12 +625,12 @@

Method Details

Update the WebSecurityScannerSettings resource.
 
 Args:
-  name: string, The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Web Security Scanner service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -638,7 +638,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -653,7 +653,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -661,7 +661,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html index 6d9306afc1a..9d3fee47828 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.securityHealthAnalyticsSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html index c5cd2272199..8f14c8a7e6d 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.virtualMachineThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html b/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html index 8e7295ffd66..a3ad71975de 100644 --- a/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html +++ b/docs/dyn/securitycenter_v1beta2.organizations.webSecurityScannerSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html index 6c94c893522..b85e1e6e56f 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.containerThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html index 710c3d5fc5c..88726cfb2a3 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.eventThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.html b/docs/dyn/securitycenter_v1beta2.projects.html index 0253b640621..c4e2a627f9b 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.html +++ b/docs/dyn/securitycenter_v1beta2.projects.html @@ -172,7 +172,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -180,7 +180,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -202,7 +202,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -210,7 +210,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -282,7 +282,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -290,7 +290,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -312,7 +312,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -320,7 +320,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -342,7 +342,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -350,7 +350,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -361,12 +361,12 @@

Method Details

Update the ContainerThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -374,7 +374,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -390,7 +390,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -398,7 +398,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -410,12 +410,12 @@

Method Details

Update the EventThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Event Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -423,7 +423,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -438,7 +438,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Event Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -446,7 +446,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
@@ -504,12 +504,12 @@

Method Details

Update the SecurityHealthAnalyticsSettings resource.
 
 Args:
-  name: string, The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
+  name: string, Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Security Health Analytics service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -517,7 +517,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -533,7 +533,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -541,7 +541,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -553,12 +553,12 @@

Method Details

Update the VirtualMachineThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Virtual Machine Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -566,7 +566,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -582,7 +582,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -590,7 +590,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -602,12 +602,12 @@

Method Details

Update the WebSecurityScannerSettings resource.
 
 Args:
-  name: string, The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
+  name: string, Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Web Security Scanner service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -615,7 +615,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. } @@ -630,7 +630,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -638,7 +638,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html index 9100d0dd95b..d066805ecfd 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.containerThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html index f2d8674bbca..e0d0fe70113 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html +++ b/docs/dyn/securitycenter_v1beta2.projects.locations.clusters.html @@ -109,7 +109,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -117,7 +117,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -129,12 +129,12 @@

Method Details

Update the ContainerThreatDetectionSettings resource.
 
 Args:
-  name: string, The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
+  name: string, Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Resource capturing the settings for the Container Threat Detection service.
-  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.
+  "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.
     "a_key": { # Configuration of a module.
       "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy.
       "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent.
@@ -142,7 +142,7 @@ 

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. @@ -158,7 +158,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Container Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -166,7 +166,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Container Threat Detection for scanning. Service accounts are scoped at the project level meaning this field will be empty at any level above a project. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html b/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html index 2729ea1e1f0..680ddf55dc4 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.securityHealthAnalyticsSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Security Health Analytics service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings + "name": "A String", # Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings "serviceAccount": "A String", # Output only. The service account used by Security Health Analytics detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html b/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html index e1043329e89..42ad8c84ce4 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.virtualMachineThreatDetectionSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Virtual Machine Threat Detection service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings + "name": "A String", # Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings "serviceAccount": "A String", # Output only. The service account used by Virtual Machine Threat Detection detectors. "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. diff --git a/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html b/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html index 82b7b3febaf..d0407bef087 100644 --- a/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html +++ b/docs/dyn/securitycenter_v1beta2.projects.webSecurityScannerSettings.html @@ -96,7 +96,7 @@

Method Details

An object of the form: { # Resource capturing the settings for the Web Security Scanner service. - "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's. + "modules": { # The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration. "a_key": { # Configuration of a module. "moduleEnablementState": "A String", # The state of enablement for the module at its level of the resource hierarchy. "value": { # The configuration value for the module. The absence of this field implies its inheritance from the parent. @@ -104,7 +104,7 @@

Method Details

}, }, }, - "name": "A String", # The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings + "name": "A String", # Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings "serviceEnablementState": "A String", # The state of enablement for the service at its level of the resource hierarchy. A DISABLED state will override all module enablement_states to DISABLED. "updateTime": "A String", # Output only. The time the settings were last updated. }
diff --git a/docs/dyn/servicemanagement_v1.services.configs.html b/docs/dyn/servicemanagement_v1.services.configs.html index 481340fb250..fb04454cfc5 100644 --- a/docs/dyn/servicemanagement_v1.services.configs.html +++ b/docs/dyn/servicemanagement_v1.services.configs.html @@ -222,10 +222,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -258,7 +258,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -335,7 +335,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], @@ -837,10 +837,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -873,7 +873,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -950,7 +950,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], @@ -1464,10 +1464,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -1500,7 +1500,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -1577,7 +1577,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], @@ -2091,10 +2091,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -2127,7 +2127,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -2204,7 +2204,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], diff --git a/docs/dyn/servicemanagement_v1.services.html b/docs/dyn/servicemanagement_v1.services.html index ca52972baf8..e4e35931ab5 100644 --- a/docs/dyn/servicemanagement_v1.services.html +++ b/docs/dyn/servicemanagement_v1.services.html @@ -417,10 +417,10 @@

Method Details

"allowedResponseExtensions": [ # A list of full type names or extension IDs of extensions allowed in grpc side channel from backend to client. "A String", ], - "provided": [ # A list of full type names of provided contexts. + "provided": [ # A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension. "A String", ], - "requested": [ # A list of full type names of requested contexts. + "requested": [ # A list of full type names of requested contexts, only the requested context will be made available to the backend. "A String", ], "selector": "A String", # Selects the methods to which this rule applies. Refer to selector for syntax details. @@ -453,7 +453,7 @@

Method Details

"A String", ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -530,7 +530,7 @@

Method Details

"http": { # Defines the HTTP configuration for an API service. It contains a list of HttpRule, each specifying the mapping of an RPC method to one or more HTTP REST API methods. # HTTP configuration. "fullyDecodeReservedExpansion": True or False, # When set to true, URL path parameters will be fully URI-decoded except in cases of single segment matches in reserved expansion, where "%2F" will be left encoded. The default behavior is to not decode RFC 6570 reserved characters in multi segment matches. "rules": [ # A list of HTTP configuration rules that apply to individual API methods. **NOTE:** All service configuration rules follow "last one wins" order. - { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. + { # gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/{name=messages/*}" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: "messages/123456")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:"/v1/messages/{message_id}" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: "123456" revision: 2 sub: SubMessage(subfield: "foo"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A&param=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "message" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" message { text: "Hi!" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: "/v1/messages/{message_id}" body: "*" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { "text": "Hi!" }` - gRPC: `UpdateMessage(message_id: "123456" text: "Hi!")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: "/v1/messages/{message_id}" additional_bindings { get: "/v1/users/{user_id}/messages/{message_id}" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: "123456")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: "me" message_id: "123456")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is "*", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = "/" Segments [ Verb ] ; Segments = Segment { "/" Segment } ; Segment = "*" | "**" | LITERAL | Variable ; Variable = "{" FieldPath [ "=" Segments ] "}" ; FieldPath = IDENT { "." IDENT } ; Verb = ":" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `"{var}"` or `"{var=*}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `"{var=foo/*}"` or `"{var=**}"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except "%2F" and "%2f" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading "/" character. The reason is that the most common use case "{var}" does not capture the leading "/" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature. "additionalBindings": [ # Additional HTTP bindings for the selector. Nested bindings must not contain an `additional_bindings` field themselves (that is, the nesting may only be one level deep). # Object with schema name: HttpRule ], diff --git a/docs/dyn/serviceusage_v1.services.html b/docs/dyn/serviceusage_v1.services.html index 92c71f53320..800009e2442 100644 --- a/docs/dyn/serviceusage_v1.services.html +++ b/docs/dyn/serviceusage_v1.services.html @@ -238,7 +238,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -545,7 +545,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -767,7 +767,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. diff --git a/docs/dyn/serviceusage_v1beta1.services.html b/docs/dyn/serviceusage_v1beta1.services.html index 4fcdc845e6d..a1e199964e9 100644 --- a/docs/dyn/serviceusage_v1beta1.services.html +++ b/docs/dyn/serviceusage_v1beta1.services.html @@ -362,7 +362,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. @@ -584,7 +584,7 @@

Method Details

}, ], }, - "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. + "documentation": { # `Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation. # Additional API documentation. Contains only the summary and the documentation URL. "documentationRootUrl": "A String", # The URL to the root of documentation. "overview": "A String", # Declares a single overview page. For example: documentation: summary: ... overview: (== include overview.md ==) This is a shortcut for the following declaration (using pages style): documentation: summary: ... pages: - name: Overview content: (== include overview.md ==) Note: you cannot specify both `overview` field and `pages` field. "pages": [ # The top level pages for the documentation set. diff --git a/docs/dyn/sheets_v4.spreadsheets.html b/docs/dyn/sheets_v4.spreadsheets.html index 1ee99e8e782..7a547765002 100644 --- a/docs/dyn/sheets_v4.spreadsheets.html +++ b/docs/dyn/sheets_v4.spreadsheets.html @@ -2176,6 +2176,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -7450,6 +7455,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -10000,6 +10010,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -11425,6 +11440,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -11547,6 +11567,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -15207,6 +15232,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -18860,6 +18890,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -22522,6 +22557,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). @@ -26220,6 +26260,11 @@

Method Details

"tableProjectId": "A String", # The ID of a BigQuery project the table belongs to. If not specified, the project_id is assumed. }, }, + "looker": { # The specification of a Looker data source. # A LookerDatasourceSpec. + "explore": "A String", # Name of a LookerML model explore. + "instanceUri": "A String", # A Looker instance URL. + "model": "A String", # Name of a LookerML model. + }, "parameters": [ # The parameters of the data source, used when querying the data source. { # A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query. "name": "A String", # Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, [BigQuery identifier](https://cloud.google.com/bigquery/docs/reference/standard-sql/lexical#identifiers). diff --git a/docs/dyn/spanner_v1.projects.instances.backups.html b/docs/dyn/spanner_v1.projects.instances.backups.html index 7151539183c..c1fcaf72b53 100644 --- a/docs/dyn/spanner_v1.projects.instances.backups.html +++ b/docs/dyn/spanner_v1.projects.instances.backups.html @@ -179,6 +179,9 @@

Method Details

The object takes the form of: { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for the backup. @@ -295,6 +298,9 @@

Method Details

An object of the form: { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for the backup. @@ -404,6 +410,9 @@

Method Details

{ # The response for ListBackups. "backups": [ # The list of matching backups. Backups returned are ordered by `create_time` in descending order, starting from the most recent `create_time`. { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for the backup. @@ -477,6 +486,9 @@

Method Details

The object takes the form of: { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for the backup. @@ -532,6 +544,9 @@

Method Details

An object of the form: { # A backup of a Cloud Spanner database. + "backupSchedules": [ # Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup. + "A String", + ], "createTime": "A String", # Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`. "database": "A String", # Required for the CreateBackup operation. Name of the database from which this backup was created. This needs to be in the same instance as the backup. Values are of the form `projects//instances//databases/`. "databaseDialect": "A String", # Output only. The database dialect information for 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 076f6e0e5af..dca1fc93521 100644 --- a/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html +++ b/docs/dyn/spanner_v1.projects.instances.databases.backupSchedules.html @@ -77,9 +77,27 @@

Instance Methods

close()

Close httplib2 connections.

+

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

+

Creates a new backup schedule.

+

+ delete(name, x__xgafv=None)

+

Deletes a backup schedule.

+

+ get(name, x__xgafv=None)

+

Gets backup schedule for the input schedule name.

getIamPolicy(resource, body=None, x__xgafv=None)

Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.

+

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

+

Lists all the backup schedules for the database.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates a backup schedule.

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

Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.

@@ -92,6 +110,124 @@

Method Details

Close httplib2 connections.
+
+ create(parent, backupScheduleId=None, body=None, x__xgafv=None) +
Creates a new backup schedule.
+
+Args:
+  parent: string, Required. The name of the database that this backup schedule applies to. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "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.
+  },
+  "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.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+  backupScheduleId: string, Required. The Id to use for the backup schedule. The `backup_schedule_id` appended to `parent` forms the full backup schedule name of the form `projects//instances//databases//backupSchedules/`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "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.
+  },
+  "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.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+ +
+ delete(name, x__xgafv=None) +
Deletes a backup schedule.
+
+Args:
+  name: string, Required. The name of the schedule to delete. Values are of the form `projects//instances//databases//backupSchedules/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets backup schedule for the input schedule name.
+
+Args:
+  name: string, Required. The name of the schedule to retrieve. Values are of the form `projects//instances//databases//backupSchedules/`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "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.
+  },
+  "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.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+
getIamPolicy(resource, body=None, x__xgafv=None)
Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.
@@ -135,6 +271,127 @@ 

Method Details

}
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
Lists all the backup schedules for the database.
+
+Args:
+  parent: string, Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/ (required)
+  pageSize: integer, Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.
+  pageToken: string, Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListBackupSchedulesResponse to the same `parent`.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # The response for ListBackupSchedules.
+  "backupSchedules": [ # The list of backup schedules for a database.
+    { # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+      "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+        "encryptionType": "A String", # Required. The encryption type of the backup.
+        "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+        "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+          "A String",
+        ],
+      },
+      "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.
+      },
+      "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.
+        "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+          "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+          "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+          "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+        },
+      },
+      "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+    },
+  ],
+  "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent ListBackupSchedules call to fetch more of the schedules.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
Updates a backup schedule.
+
+Args:
+  name: 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. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "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.
+  },
+  "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.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+  updateMask: string, Required. A mask specifying which fields in the BackupSchedule resource should be updated. This mask is relative to the BackupSchedule resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10
+  "encryptionConfig": { # Encryption configuration for the backup to create. # Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database.
+    "encryptionType": "A String", # Required. The encryption type of the backup.
+    "kmsKeyName": "A String", # Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.
+    "kmsKeyNames": [ # Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.
+      "A String",
+    ],
+  },
+  "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.
+  },
+  "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.
+    "cronSpec": { # CrontabSpec can be used to specify the version time and frequency at which the backup should be created. # Cron style schedule specification.
+      "creationWindow": "A String", # Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.
+      "text": "A String", # Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.
+      "timeZone": "A String", # Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.
+    },
+  },
+  "updateTime": "A String", # Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.
+}
+
+
setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.
diff --git a/docs/dyn/sqladmin_v1.connect.html b/docs/dyn/sqladmin_v1.connect.html
index 8389132b0d2..8f31c2a469d 100644
--- a/docs/dyn/sqladmin_v1.connect.html
+++ b/docs/dyn/sqladmin_v1.connect.html
@@ -170,6 +170,7 @@ 

Method Details

"selfLink": "A String", # The URI of this resource. "sha1Fingerprint": "A String", # Sha1 Fingerprint. }, + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. }
diff --git a/docs/dyn/sqladmin_v1.instances.html b/docs/dyn/sqladmin_v1.instances.html index 87a30d36af2..c1d5691082f 100644 --- a/docs/dyn/sqladmin_v1.instances.html +++ b/docs/dyn/sqladmin_v1.instances.html @@ -79,7 +79,7 @@

Instance Methods

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

addServerCa(project, instance, x__xgafv=None)

-

Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.

+

Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.

clone(project, instance, body=None, x__xgafv=None)

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

@@ -142,7 +142,7 @@

Instance Methods

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

rotateServerCa(project, instance, body=None, x__xgafv=None)

-

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

+

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.

startReplica(project, instance, x__xgafv=None)

Starts the replication in the read replica instance.

@@ -193,7 +193,7 @@

Method Details

addServerCa(project, instance, x__xgafv=None) -
Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.
+  
Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -1443,6 +1443,7 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1489,6 +1490,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -1884,6 +1886,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1930,6 +1933,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2283,6 +2287,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2329,6 +2334,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2608,6 +2614,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2654,6 +2661,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -3494,7 +3502,7 @@

Method Details

rotateServerCa(project, instance, body=None, x__xgafv=None) -
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.
+  
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -4382,6 +4390,7 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -4428,6 +4437,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. diff --git a/docs/dyn/sqladmin_v1beta4.connect.html b/docs/dyn/sqladmin_v1beta4.connect.html index 02ff6136d38..c56b9f5ea14 100644 --- a/docs/dyn/sqladmin_v1beta4.connect.html +++ b/docs/dyn/sqladmin_v1beta4.connect.html @@ -170,6 +170,7 @@

Method Details

"selfLink": "A String", # The URI of this resource. "sha1Fingerprint": "A String", # Sha1 Fingerprint. }, + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. }
diff --git a/docs/dyn/sqladmin_v1beta4.instances.html b/docs/dyn/sqladmin_v1beta4.instances.html index 7ade086e208..0abf5d5b90c 100644 --- a/docs/dyn/sqladmin_v1beta4.instances.html +++ b/docs/dyn/sqladmin_v1beta4.instances.html @@ -79,7 +79,7 @@

Instance Methods

Acquire a lease for the setup of SQL Server Reporting Services (SSRS).

addServerCa(project, instance, x__xgafv=None)

-

Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.

+

Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.

clone(project, instance, body=None, x__xgafv=None)

Creates a Cloud SQL instance as a clone of the source instance. Using this operation might cause your instance to restart.

@@ -142,7 +142,7 @@

Instance Methods

Restores a backup of a Cloud SQL instance. Using this operation might cause your instance to restart.

rotateServerCa(project, instance, body=None, x__xgafv=None)

-

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.

+

Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.

startReplica(project, instance, x__xgafv=None)

Starts the replication in the read replica instance.

@@ -193,7 +193,7 @@

Method Details

addServerCa(project, instance, x__xgafv=None) -
Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.
+  
Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -1443,6 +1443,7 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1489,6 +1490,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -1884,6 +1886,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -1930,6 +1933,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2283,6 +2287,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2329,6 +2334,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -2608,6 +2614,7 @@

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -2654,6 +2661,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. @@ -3494,7 +3502,7 @@

Method Details

rotateServerCa(project, instance, body=None, x__xgafv=None) -
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.
+  
Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.
 
 Args:
   project: string, Project ID of the project that contains the instance. (required)
@@ -4382,6 +4390,7 @@ 

Method Details

"pscEnabled": True or False, # Whether PSC connectivity is enabled for this instance. }, "requireSsl": True or False, # Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag. + "serverCaMode": "A String", # Specify what type of CA is used for the server certificate. "sslMode": "A String", # Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections. }, "kind": "A String", # This is always `sql#settings`. @@ -4428,6 +4437,7 @@

Method Details

"suspensionReason": [ # If the instance state is SUSPENDED, the reason for the suspension. "A String", ], + "switchTransactionLogsToCloudStorageEnabled": True or False, # Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage. "upgradableDatabaseVersions": [ # Output only. All database versions that are available for upgrade. { # An available database version. It can be a major or a minor version. "displayName": "A String", # The database version's display name. diff --git a/docs/dyn/translate_v3.projects.html b/docs/dyn/translate_v3.projects.html index e2c4e416a77..0af0592cb67 100644 --- a/docs/dyn/translate_v3.projects.html +++ b/docs/dyn/translate_v3.projects.html @@ -219,7 +219,7 @@

Method Details

"a_key": "A String", }, "mimeType": "A String", # Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html". - "model": "A String", # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used + "model": "A String", # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used "sourceLanguageCode": "A String", # Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. "targetLanguageCode": "A String", # Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support. "transliterationConfig": { # Configures transliteration feature on top of translation. # Optional. Transliteration to be applied. diff --git a/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html b/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html index f7b6f084f83..30d26501d18 100644 --- a/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html +++ b/docs/dyn/translate_v3.projects.locations.glossaries.glossaryEntries.html @@ -112,7 +112,7 @@

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -143,7 +143,7 @@

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -199,7 +199,7 @@

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -241,7 +241,7 @@

Method Details

"glossaryEntries": [ # Optional. The Glossary Entries { # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. @@ -285,13 +285,13 @@

Method Details

Updates a glossary entry.
 
 Args:
-  name: string, Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" (required)
+  name: string, Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Represents a single entry in a glossary.
   "description": "A String", # Describes the glossary entry.
-  "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*"
+  "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*"
   "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary.
     "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text,
       "languageCode": "A String", # The language for this glossary term.
@@ -322,7 +322,7 @@ 

Method Details

{ # Represents a single entry in a glossary. "description": "A String", # Describes the glossary entry. - "name": "A String", # Required. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" + "name": "A String", # Identifier. The resource name of the entry. Format: "projects/*/locations/*/glossaries/*/glossaryEntries/*" "termsPair": { # Represents a single entry for an unidirectional glossary. # Used for an unidirectional glossary. "sourceTerm": { # Represents a single glossary term # The source term is the term that will get match in the text, "languageCode": "A String", # The language for this glossary term. diff --git a/docs/dyn/translate_v3.projects.locations.html b/docs/dyn/translate_v3.projects.locations.html index 4a96446f5af..7fd25f4d269 100644 --- a/docs/dyn/translate_v3.projects.locations.html +++ b/docs/dyn/translate_v3.projects.locations.html @@ -146,10 +146,28 @@

Method Details

The object takes the form of: { # The request for sending an AdaptiveMt translation query. - "content": [ # Required. The content of the input in string format. For now only one sentence per request is supported. + "content": [ # Required. The content of the input in string format. "A String", ], "dataset": "A String", # Required. The resource name for the dataset to use for adaptive MT. `projects/{project}/locations/{location-id}/adaptiveMtDatasets/{dataset}` + "glossaryConfig": { # Configures which glossary is used for a specific target language and defines options for applying that glossary. # Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned. + "glossary": "A String", # Required. The `glossary` to be applied for this translation. The format depends on the glossary: - User-provided custom glossary: `projects/{project-number-or-id}/locations/{location-id}/glossaries/{glossary-id}` + "ignoreCase": True or False, # Optional. Indicates match is case insensitive. The default value is `false` if missing. + }, + "referenceSentenceConfig": { # Message of caller-provided reference configuration. # Configuration for caller provided reference sentences. + "referenceSentencePairLists": [ # Reference sentences pair lists. Each list will be used as the references to translate the sentence under "content" field at the corresponding index. Length of the list is required to be equal to the length of "content" field. + { # A list of reference sentence pairs. + "referenceSentencePairs": [ # Reference sentence pairs. + { # A pair of sentences used as reference in source and target languages. + "sourceSentence": "A String", # Source sentence in the sentence pair. + "targetSentence": "A String", # Target sentence in the sentence pair. + }, + ], + }, + ], + "sourceLanguageCode": "A String", # Source language code. + "targetLanguageCode": "A String", # Target language code. + }, } x__xgafv: string, V1 error format. @@ -161,6 +179,11 @@

Method Details

An object of the form: { # An AdaptiveMtTranslate response. + "glossaryTranslations": [ # Text translation response if a glossary is provided in the request. This could be the same as 'translation' above if no terms apply. + { # An AdaptiveMt translation. + "translatedText": "A String", # Output only. The translated text. + }, + ], "languageCode": "A String", # Output only. The translation's language code. "translations": [ # Output only. The translation. { # An AdaptiveMt translation. @@ -582,7 +605,7 @@

Method Details

"a_key": "A String", }, "mimeType": "A String", # Optional. The format of the source text, for example, "text/html", "text/plain". If left blank, the MIME type defaults to "text/html". - "model": "A String", # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used + "model": "A String", # Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used "sourceLanguageCode": "A String", # Optional. The ISO-639 language code of the input text if known, for example, "en-US" or "sr-Latn". Supported language codes are listed in Language Support. If the source language isn't specified, the API attempts to identify the source language automatically and returns the source language within the response. "targetLanguageCode": "A String", # Required. The ISO-639 language code to use for translation of the input text, set to one of the language codes listed in Language Support. "transliterationConfig": { # Configures transliteration feature on top of translation. # Optional. Transliteration to be applied. diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html index 13b820abe65..ffcc45a4ee5 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.html @@ -140,6 +140,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -182,6 +229,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -331,6 +425,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -373,6 +514,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -462,6 +650,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -504,6 +739,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. diff --git a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html index f230dd4115e..329074ac357 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.imageImports.imageImportJobs.html @@ -190,6 +190,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -289,6 +336,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. 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 90252c842f7..40ed69337fb 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cloneJobs.html @@ -204,6 +204,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -345,6 +346,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -462,6 +464,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. "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 b81a6797723..7921a1d4678 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -204,6 +204,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -455,6 +456,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -682,6 +684,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. "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 ee89aec584b..0d8c33e63af 100644 --- a/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1.projects.locations.sources.migratingVms.html @@ -238,6 +238,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -292,6 +293,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -496,6 +498,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -593,6 +596,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -993,6 +997,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1047,6 +1052,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1251,6 +1257,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1348,6 +1355,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1648,6 +1656,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1702,6 +1711,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1906,6 +1916,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2003,6 +2014,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2307,6 +2319,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2361,6 +2374,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2565,6 +2579,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2662,6 +2677,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. "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 85434e5fc97..e82d184fee6 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.html @@ -140,6 +140,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -182,6 +229,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -331,6 +425,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -373,6 +514,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -462,6 +650,53 @@

Method Details

"encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine. "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. }, + "machineImageTargetDefaults": { # The target details of the machine image resource that will be created by the image import job. # Immutable. Target details for importing a machine image, will be used by ImageImportJob. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImport. "recentImageImportJobs": [ # Output only. The result of the most recent runs for this ImageImport. All jobs for this ImageImport can be listed via ListImageImportJobs. { # ImageImportJob describes the progress and result of an image import. @@ -504,6 +739,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. diff --git a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html index 6b3d3710f5f..a2ee38786f9 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.imageImports.imageImportJobs.html @@ -190,6 +190,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. @@ -289,6 +336,53 @@

Method Details

"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. }, ], + "machineImageTargetDetails": { # The target details of the machine image resource that will be created by the image import job. # Output only. Target details used to import a machine image. + "additionalLicenses": [ # Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME + "A String", + ], + "description": "A String", # Optional. An optional description of the machine image. + "encryption": { # Encryption message describes the details of the applied encryption. # Immutable. The encryption to apply to the machine image. + "kmsKey": "A String", # Required. The name of the encryption key that is stored in Google Cloud KMS. + }, + "labels": { # Optional. The labels to apply to the instance created by the machine image. + "a_key": "A String", + }, + "machineImageName": "A String", # Required. The name of the machine image to be created. + "machineImageParametersOverrides": { # Parameters overriding decisions based on the source machine image configurations. # Optional. Parameters overriding decisions based on the source machine image configurations. + "machineType": "A String", # Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource. + }, + "networkInterfaces": [ # Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import. + { # NetworkInterface represents a NIC of a VM. + "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. + "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. + }, + ], + "osAdaptationParameters": { # Parameters affecting the OS adaptation process. # Optional. Use to set the parameters relevant for the OS adaptation process. + "generalize": True or False, # Optional. Set to true in order to generalize the imported image. The generalization process enables co-existence of multiple VMs created from the same image. For Windows, generalizing the image removes computer-specific information such as installed drivers and the computer security identifier (SID). + "licenseType": "A String", # Optional. Choose which type of license to apply to the imported image. + }, + "serviceAccount": { # Service account to assign to the instance created by the machine image. # Optional. The service account to assign to the instance created by the machine image. + "email": "A String", # Required. The email address of the service account. + "scopes": [ # Optional. The list of scopes to be made available for this service account. + "A String", + ], + }, + "shieldedInstanceConfig": { # Shielded instance configuration. # Optional. Shielded instance configuration. + "enableIntegrityMonitoring": True or False, # Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled. + "enableVtpm": True or False, # Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI. + "secureBoot": "A String", # Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI. + }, + "singleRegionStorage": True or False, # Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected. + "skipOsAdaptation": { # Mentions that the machine image import is not using OS adaptation process. # Optional. Use to skip OS adaptation process. + }, + "tags": [ # Optional. The tags to apply to the instance created by the machine image. + "A String", + ], + "targetProject": "A String", # Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created. + }, "name": "A String", # Output only. The resource path of the ImageImportJob. "state": "A String", # Output only. The state of the image import. "steps": [ # Output only. The image import steps list representing its progress. 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 7ab21ae760c..1edd4ae2b95 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cloneJobs.html @@ -205,6 +205,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -257,6 +258,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -336,6 +338,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -453,6 +456,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -505,6 +509,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -584,6 +589,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -677,6 +683,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -729,6 +736,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -808,6 +816,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. "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 e85ec57d634..2f6a4a3ad2e 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.cutoverJobs.html @@ -205,6 +205,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -257,6 +258,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -449,6 +451,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -566,6 +569,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -618,6 +622,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -810,6 +815,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -903,6 +909,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -955,6 +962,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1147,6 +1155,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. "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 753aa2c294b..f504a96590a 100644 --- a/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html +++ b/docs/dyn/vmmigration_v1alpha1.projects.locations.sources.migratingVms.html @@ -239,6 +239,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -294,6 +295,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -346,6 +348,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -554,6 +557,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -606,6 +610,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -685,6 +690,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -758,6 +764,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -810,6 +817,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1002,6 +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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1060,6 +1069,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1321,6 +1331,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1376,6 +1387,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1428,6 +1440,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1636,6 +1649,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1688,6 +1702,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1767,6 +1782,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1840,6 +1856,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -1892,6 +1909,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2084,6 +2102,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2142,6 +2161,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2303,6 +2323,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2358,6 +2379,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2410,6 +2432,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2618,6 +2641,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2670,6 +2694,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2749,6 +2774,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2822,6 +2848,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -2874,6 +2901,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3066,6 +3094,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3124,6 +3153,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3289,6 +3319,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3344,6 +3375,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3396,6 +3428,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3604,6 +3637,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3656,6 +3690,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3735,6 +3770,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3808,6 +3844,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -3860,6 +3897,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -4052,6 +4090,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], @@ -4110,6 +4149,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. "subnetwork": "A String", # Optional. The subnetwork to connect the NIC to. }, ], diff --git a/docs/dyn/walletobjects_v1.eventticketobject.html b/docs/dyn/walletobjects_v1.eventticketobject.html index 99da6f8eac9..80a8e2d75b5 100644 --- a/docs/dyn/walletobjects_v1.eventticketobject.html +++ b/docs/dyn/walletobjects_v1.eventticketobject.html @@ -1812,6 +1812,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3610,6 +3613,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5396,6 +5402,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -7181,6 +7190,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -8982,6 +8994,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -10790,6 +10805,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -12577,6 +12595,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -14362,6 +14383,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -16149,6 +16173,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -17934,6 +17961,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. diff --git a/docs/dyn/walletobjects_v1.flightclass.html b/docs/dyn/walletobjects_v1.flightclass.html index dfdf83c6766..faa9a88e6c4 100644 --- a/docs/dyn/walletobjects_v1.flightclass.html +++ b/docs/dyn/walletobjects_v1.flightclass.html @@ -1134,11 +1134,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -2312,11 +2312,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3478,11 +3478,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -4643,11 +4643,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5824,11 +5824,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -6993,11 +6993,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -8158,11 +8158,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -9325,11 +9325,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -10490,11 +10490,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. diff --git a/docs/dyn/walletobjects_v1.flightobject.html b/docs/dyn/walletobjects_v1.flightobject.html index 8753e11d6f8..07cde39ef7f 100644 --- a/docs/dyn/walletobjects_v1.flightobject.html +++ b/docs/dyn/walletobjects_v1.flightobject.html @@ -1500,11 +1500,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -1966,6 +1966,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3412,11 +3415,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3878,6 +3881,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5312,11 +5318,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5778,6 +5784,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -7211,11 +7220,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -7677,6 +7686,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -9126,11 +9138,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -9592,6 +9604,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -11029,11 +11044,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -11495,6 +11510,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -12928,11 +12946,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -13394,6 +13412,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -14829,11 +14850,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -15295,6 +15316,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -16728,11 +16752,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -17194,6 +17218,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. diff --git a/docs/dyn/walletobjects_v1.genericobject.html b/docs/dyn/walletobjects_v1.genericobject.html index 1b831bc55df..4f0408b701f 100644 --- a/docs/dyn/walletobjects_v1.genericobject.html +++ b/docs/dyn/walletobjects_v1.genericobject.html @@ -699,6 +699,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -1358,6 +1361,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -2005,6 +2011,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -2651,6 +2660,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -3313,6 +3325,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -3963,6 +3978,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -4609,6 +4627,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -5257,6 +5278,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -5903,6 +5927,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. diff --git a/docs/dyn/walletobjects_v1.giftcardobject.html b/docs/dyn/walletobjects_v1.giftcardobject.html index a53123b8a94..28a737590d7 100644 --- a/docs/dyn/walletobjects_v1.giftcardobject.html +++ b/docs/dyn/walletobjects_v1.giftcardobject.html @@ -1706,6 +1706,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -3321,6 +3324,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -4924,6 +4930,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -6526,6 +6535,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -8144,6 +8156,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -9750,6 +9765,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -11352,6 +11370,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -12956,6 +12977,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -14558,6 +14582,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. diff --git a/docs/dyn/walletobjects_v1.jwt.html b/docs/dyn/walletobjects_v1.jwt.html index 6c10eed619e..024552cf10c 100644 --- a/docs/dyn/walletobjects_v1.jwt.html +++ b/docs/dyn/walletobjects_v1.jwt.html @@ -2830,6 +2830,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "seatInfo": { # Seating details for this ticket. "gate": { # The gate the ticket holder should enter to get to their seat, such as "A" or "West". This field is localizable so you may translate words or use different alphabets for the characters in an identifier. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -3933,11 +3936,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5457,11 +5460,11 @@

Method Details

}, ], }, - "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. - "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources. + "localBoardingDateTime": "A String", # The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. + "localEstimatedOrActualArrivalDateTime": "A String", # The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. + "localEstimatedOrActualDepartureDateTime": "A String", # The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localGateClosingDateTime": "A String", # The gate closing time as it would be printed on the boarding pass. Do not set this field if you do not want to print it in the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. - "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources. + "localScheduledArrivalDateTime": "A String", # The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. "localScheduledDepartureDateTime": "A String", # Required. The scheduled date and time when the aircraft is expected to depart the gate (not the runway) Note: This field should not change too close to the departure time. For updates to departure times (delays, etc), please set `localEstimatedOrActualDepartureDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. "localizedIssuerName": { # Translated strings for the issuer_name. Recommended maximum length is 20 characters to ensure full string is displayed on smaller screens. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -5923,6 +5926,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "securityProgramLogo": { # Wrapping type for Google hosted images. Next ID: 7 # An image for the security program that applies to the passenger. "contentDescription": { # Description of the image used for accessibility. "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. @@ -7213,6 +7219,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. If this is not provided, the object would be considered `ACTIVE`. "subheader": { # The title label of the pass, such as location where this pass can be used. Appears right above the title in the title row in the pass detail view. @@ -9833,6 +9842,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -12622,6 +12634,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -15282,6 +15297,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -18468,6 +18486,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. diff --git a/docs/dyn/walletobjects_v1.loyaltyobject.html b/docs/dyn/walletobjects_v1.loyaltyobject.html index aba265b5452..5361bf69441 100644 --- a/docs/dyn/walletobjects_v1.loyaltyobject.html +++ b/docs/dyn/walletobjects_v1.loyaltyobject.html @@ -1830,6 +1830,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -3594,6 +3597,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -5346,6 +5352,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -7097,6 +7106,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -8864,6 +8876,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -10638,6 +10653,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -12391,6 +12409,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -14142,6 +14163,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -15895,6 +15919,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. @@ -17646,6 +17673,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "secondaryLoyaltyPoints": { # The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points. "balance": { # The account holder's loyalty point balance, such as "500" or "$10.00". Recommended maximum length is 7 characters. This is a required field of `loyaltyPoints` and `secondaryLoyaltyPoints`. "double": 3.14, # The double form of a balance. Only one of these subtypes (string, int, double, money) should be populated. diff --git a/docs/dyn/walletobjects_v1.offerobject.html b/docs/dyn/walletobjects_v1.offerobject.html index fb9ee8718bd..f9dc2a2695e 100644 --- a/docs/dyn/walletobjects_v1.offerobject.html +++ b/docs/dyn/walletobjects_v1.offerobject.html @@ -1732,6 +1732,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -3373,6 +3376,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -5002,6 +5008,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -6630,6 +6639,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -8274,6 +8286,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -9906,6 +9921,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -11534,6 +11552,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -13164,6 +13185,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -14792,6 +14816,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. diff --git a/docs/dyn/walletobjects_v1.transitobject.html b/docs/dyn/walletobjects_v1.transitobject.html index bb770720411..8fcd15db34b 100644 --- a/docs/dyn/walletobjects_v1.transitobject.html +++ b/docs/dyn/walletobjects_v1.transitobject.html @@ -2045,6 +2045,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -4379,6 +4382,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -6701,6 +6707,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -9022,6 +9031,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -11359,6 +11371,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -13684,6 +13699,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -16005,6 +16023,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -18328,6 +18349,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. @@ -20649,6 +20673,9 @@

Method Details

"type": "A String", # The type of this barcode. "valuePattern": "A String", # String encoded barcode value. This string supports the following substitutions: * {totp_value_n}: Replaced with the TOTP value (see TotpDetails.parameters). * {totp_timestamp_millis}: Replaced with the timestamp (millis since epoch) at which the barcode was generated. * {totp_timestamp_seconds}: Replaced with the timestamp (seconds since epoch) at which the barcode was generated. }, + "saveRestrictions": { # Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support. # Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass. + "restrictToEmailSha256": "A String", # Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like "." or "+", except "@". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions. + }, "smartTapRedemptionValue": "A String", # The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported. "state": "A String", # Required. The state of the object. This field is used to determine how an object is displayed in the app. For example, an `inactive` object is moved to the "Expired passes" section. "textModulesData": [ # Text module data. If text module data is also defined on the class, both will be displayed. The maximum number of these fields displayed is 10 from the object and 10 from the class. diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html index f9282d0411d..b240fc117e2 100644 --- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html +++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.executions.html @@ -150,6 +150,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -211,6 +212,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -265,6 +267,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -350,6 +353,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, @@ -422,6 +426,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, diff --git a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html index 907d7fa3fbe..cfe73c5edd7 100644 --- a/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html +++ b/docs/dyn/workflowexecutions_v1.projects.locations.workflows.html @@ -147,6 +147,7 @@

Method Details

], }, }, + "executionHistoryLevel": "A String", # Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction. "labels": { # Labels associated with this execution. Labels can contain at most 64 entries. Keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, and dashes. Label keys must start with a letter. International characters are allowed. By default, labels are inherited from the workflow but are overridden by any labels associated with the execution. "a_key": "A String", }, diff --git a/docs/dyn/workflows_v1.projects.locations.workflows.html b/docs/dyn/workflows_v1.projects.locations.workflows.html index f3a998dc9f4..d6f2c3f3768 100644 --- a/docs/dyn/workflows_v1.projects.locations.workflows.html +++ b/docs/dyn/workflows_v1.projects.locations.workflows.html @@ -116,7 +116,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Workflow program to be executed by Workflows. +{ # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], @@ -227,7 +227,7 @@

Method Details

Returns: An object of the form: - { # Workflow program to be executed by Workflows. + { # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], @@ -283,7 +283,7 @@

Method Details

"A String", ], "workflows": [ # The workflows that match the request. - { # Workflow program to be executed by Workflows. + { # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], @@ -336,7 +336,7 @@

Method Details

{ # Response for the ListWorkflowRevisions method. "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "workflows": [ # The revisions of the workflow, ordered in reverse chronological order. - { # Workflow program to be executed by Workflows. + { # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], @@ -407,7 +407,7 @@

Method Details

body: object, The request body. The object takes the form of: -{ # Workflow program to be executed by Workflows. +{ # LINT.IfChange Workflow program to be executed by Workflows. "allKmsKeys": [ # Output only. A list of all KMS crypto keys used to encrypt or decrypt the data associated with the workflow. "A String", ], diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html index 61da7cce064..de121e9bbf8 100644 --- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html @@ -170,7 +170,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -201,7 +201,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -377,7 +377,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -408,7 +408,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -572,7 +572,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -603,7 +603,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -721,7 +721,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -752,7 +752,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -885,7 +885,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -916,7 +916,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html index 4039768cf8d..4abb55917f9 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.html @@ -170,7 +170,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -204,7 +204,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -216,7 +216,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -397,7 +397,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -431,7 +431,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -443,7 +443,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -612,7 +612,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -646,7 +646,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -658,7 +658,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -781,7 +781,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -815,7 +815,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -827,7 +827,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. @@ -965,7 +965,7 @@

Method Details

"deleteTime": "A String", # Output only. Time when this workstation configuration was soft-deleted. "disableTcpConnections": True or False, # Optional. Disables support for plain TCP connections in the workstation. By default the service supports TCP connections through a websocket relay. Setting this option to true disables that relay, which prevents the usage of services that require plain TCP connections, such as SSH. When enabled, all communication must occur over HTTPS or WSS. "displayName": "A String", # Optional. Human-readable name for this workstation configuration. - "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging). + "enableAuditAgent": True or False, # Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type="gce_instance" log_name:"/logs/linux-auditd" "encryptionKey": { # A customer-managed encryption key (CMEK) for the Compute Engine resources of the associated workstation configuration. Specify the name of your Cloud KMS encryption key and the default service account. We recommend that you use a separate service account and follow [Cloud KMS best practices](https://cloud.google.com/kms/docs/separation-of-duties). # Immutable. Encrypts resources of this workstation configuration using a customer-managed encryption key (CMEK). If specified, the boot disk of the Compute Engine instance and the persistent disk are encrypted using this encryption key. If this field is not set, the disks are encrypted using a generated key. Customer-managed encryption keys do not protect disk metadata. If the customer-managed encryption key is rotated, when the workstation instance is stopped, the system attempts to recreate the persistent disk with the new version of the key. Be sure to keep older versions of the key until the persistent disk is recreated. Otherwise, data on the persistent disk might be lost. If the encryption key is revoked, the workstation session automatically stops within 7 hours. Immutable after the workstation configuration is created. "kmsKey": "A String", # Immutable. The name of the Google Cloud KMS encryption key. For example, `"projects/PROJECT_ID/locations/REGION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"`. The key must be in the same region as the workstation configuration. "kmsKeyServiceAccount": "A String", # Immutable. The service account to use with the specified KMS key. We recommend that you use a separate service account and follow KMS best practices. For more information, see [Separation of duties](https://cloud.google.com/kms/docs/separation-of-duties) and `gcloud kms keys add-iam-policy-binding` [`--member`](https://cloud.google.com/sdk/gcloud/reference/kms/keys/add-iam-policy-binding#--member). @@ -999,7 +999,7 @@

Method Details

}, ], "bootDiskSizeGb": 42, # Optional. The size of the boot disk for the VM in gigabytes (GB). The minimum boot disk size is `30` GB. Defaults to `50` GB. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. "id": "A String", # Optional. Required. The id to be used for the boost config. "machineType": "A String", # Optional. The type of machine that boosted VM instances will use—for example, `e2-standard-4`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). Defaults to `e2-standard-4`. "poolSize": 42, # Optional. The number of boost VMs that the system should keep idle so that workstations can be boosted quickly. Defaults to `0`. @@ -1011,7 +1011,7 @@

Method Details

}, "disablePublicIpAddresses": True or False, # Optional. When set to true, disables public IP addresses for VMs. If you disable public IP addresses, you must set up Private Google Access or Cloud NAT on your network. If you use Private Google Access and you use `private.googleapis.com` or `restricted.googleapis.com` for Container Registry and Artifact Registry, make sure that you set up DNS records for domains `*.gcr.io` and `*.pkg.dev`. Defaults to false (VMs have public IP addresses). "disableSsh": True or False, # Optional. Whether to disable SSH access to the VM. - "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. + "enableNestedVirtualization": True or False, # Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. "machineType": "A String", # Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). "poolSize": 42, # Optional. The number of VMs that the system should keep idle so that new workstations can be started quickly for new users. Defaults to `0` in the API. "pooledInstances": 42, # Output only. Number of instances currently available in the pool for faster workstation startup. diff --git a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html index 226d08d664a..ddd0e3610c2 100644 --- a/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html +++ b/docs/dyn/workstations_v1beta.projects.locations.workstationClusters.workstationConfigs.workstations.html @@ -138,6 +138,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. @@ -276,6 +281,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. @@ -374,6 +384,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. @@ -426,6 +441,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. @@ -493,6 +513,11 @@

Method Details

"annotations": { # Optional. Client-specified annotations. "a_key": "A String", }, + "boostConfigs": [ # Output only. List of available boost configuration ids that this workstation can be boosted up to + { # Boost config for this workstation. This object is populated from the parent workstation config. + "id": "A String", # Output only. Boost config id. + }, + ], "createTime": "A String", # Output only. Time when this workstation was created. "deleteTime": "A String", # Output only. Time when this workstation was soft-deleted. "displayName": "A String", # Optional. Human-readable name for this workstation. diff --git a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json index 9c72c3a8fc6..5e2efc129f8 100644 --- a/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/accesscontextmanager.v1.json @@ -1290,7 +1290,7 @@ } } }, -"revision": "20240708", +"revision": "20240716", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -1742,7 +1742,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "EgressSource" }, @@ -1771,7 +1771,7 @@ "id": "EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -2549,7 +2549,7 @@ "properties": { "vpcSubnetwork": { "$ref": "VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/adsenseplatform.v1.json b/googleapiclient/discovery_cache/documents/adsenseplatform.v1.json new file mode 100644 index 00000000000..d45f007e704 --- /dev/null +++ b/googleapiclient/discovery_cache/documents/adsenseplatform.v1.json @@ -0,0 +1,721 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/adsense": { +"description": "View and manage your AdSense data" +}, +"https://www.googleapis.com/auth/adsense.readonly": { +"description": "View your AdSense data" +} +} +} +}, +"basePath": "", +"baseUrl": "https://adsenseplatform.googleapis.com/", +"batchPath": "batch", +"canonicalName": "AdSense Platform", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/adsense/platforms/", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "adsenseplatform:v1", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://adsenseplatform.mtls.googleapis.com/", +"name": "adsenseplatform", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"platforms": { +"resources": { +"accounts": { +"methods": { +"close": { +"description": "Closes a sub-account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}:close", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.close", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Account to close. Format: platforms/{platform}/accounts/{account_id}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:close", +"request": { +"$ref": "CloseAccountRequest" +}, +"response": { +"$ref": "CloseAccountResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"create": { +"description": "Creates a sub-account.", +"flatPath": "v1/platforms/{platformsId}/accounts", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Platform to create an account for. Format: platforms/{platform}", +"location": "path", +"pattern": "^platforms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/accounts", +"request": { +"$ref": "Account" +}, +"response": { +"$ref": "Account" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"get": { +"description": "Gets information about the selected sub-account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Account" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"list": { +"description": "Lists a partial view of sub-accounts for a specific parent account.", +"flatPath": "v1/platforms/{platformsId}/accounts", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Platform who parents the accounts. Format: platforms/{platform}", +"location": "path", +"pattern": "^platforms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/accounts", +"response": { +"$ref": "ListAccountsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"lookup": { +"description": "Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.", +"flatPath": "v1/platforms/{platformsId}/accounts:lookup", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.lookup", +"parameterOrder": [ +"parent" +], +"parameters": { +"creationRequestId": { +"description": "Optional. The creation_request_id provided when calling createAccount.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Platform who parents the account. Format: platforms/{platform}", +"location": "path", +"pattern": "^platforms/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/accounts:lookup", +"response": { +"$ref": "LookupAccountResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +} +}, +"resources": { +"events": { +"methods": { +"create": { +"description": "Creates an account event.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/events", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.events.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Account to log events about. Format: platforms/{platform}/accounts/{account}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/events", +"request": { +"$ref": "Event" +}, +"response": { +"$ref": "Event" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +} +} +}, +"sites": { +"methods": { +"create": { +"description": "Creates a site for a specified account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.sites.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Account to create site. Format: platforms/{platform}/accounts/{account_id}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sites", +"request": { +"$ref": "Site" +}, +"response": { +"$ref": "Site" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"delete": { +"description": "Deletes a site from a specified account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", +"httpMethod": "DELETE", +"id": "adsenseplatform.platforms.accounts.sites.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +}, +"get": { +"description": "Gets a site from a specified sub-account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.sites.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Site" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"list": { +"description": "Lists sites for a specific account.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites", +"httpMethod": "GET", +"id": "adsenseplatform.platforms.accounts.sites.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/sites", +"response": { +"$ref": "ListSitesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense", +"https://www.googleapis.com/auth/adsense.readonly" +] +}, +"requestReview": { +"description": "Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.", +"flatPath": "v1/platforms/{platformsId}/accounts/{accountsId}/sites/{sitesId}:requestReview", +"httpMethod": "POST", +"id": "adsenseplatform.platforms.accounts.sites.requestReview", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"location": "path", +"pattern": "^platforms/[^/]+/accounts/[^/]+/sites/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:requestReview", +"response": { +"$ref": "RequestSiteReviewResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/adsense" +] +} +} +} +} +} +} +} +}, +"revision": "20240722", +"rootUrl": "https://adsenseplatform.googleapis.com/", +"schemas": { +"Account": { +"description": "Representation of an Account.", +"id": "Account", +"properties": { +"createTime": { +"description": "Output only. Creation time of the account.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creationRequestId": { +"description": "Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.", +"type": "string" +}, +"displayName": { +"description": "Display name of this account.", +"type": "string" +}, +"name": { +"description": "Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+", +"readOnly": true, +"type": "string" +}, +"regionCode": { +"description": "Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.", +"type": "string" +}, +"state": { +"description": "Output only. Approval state of the account.", +"enum": [ +"STATE_UNSPECIFIED", +"UNCHECKED", +"APPROVED", +"DISAPPROVED" +], +"enumDescriptions": [ +"Unspecified.", +"Unchecked.", +"The account is ready to serve ads.", +"The account has been blocked from serving ads." +], +"readOnly": true, +"type": "string" +}, +"timeZone": { +"$ref": "TimeZone", +"description": "Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts." +} +}, +"type": "object" +}, +"Address": { +"description": "Address data.", +"id": "Address", +"properties": { +"address1": { +"description": "First line of address. Max length 64 bytes or 30 characters.", +"type": "string" +}, +"address2": { +"description": "Second line of address. Max length 64 bytes or 30 characters.", +"type": "string" +}, +"city": { +"description": "City. Max length 60 bytes or 30 characters.", +"type": "string" +}, +"company": { +"description": "Name of the company. Max length 255 bytes or 34 characters.", +"type": "string" +}, +"contact": { +"description": "Contact name of the company. Max length 128 bytes or 34 characters.", +"type": "string" +}, +"fax": { +"description": "Fax number with international code (i.e. +441234567890).", +"type": "string" +}, +"phone": { +"description": "Phone number with international code (i.e. +441234567890).", +"type": "string" +}, +"regionCode": { +"description": "Country/Region code. The region is specified as a CLDR region code (e.g. \"US\", \"FR\").", +"type": "string" +}, +"state": { +"description": "State. Max length 60 bytes or 30 characters.", +"type": "string" +}, +"zip": { +"description": "Zip/post code. Max length 10 bytes or 10 characters.", +"type": "string" +} +}, +"type": "object" +}, +"CloseAccountRequest": { +"description": "Request definition for the account close rpc.", +"id": "CloseAccountRequest", +"properties": {}, +"type": "object" +}, +"CloseAccountResponse": { +"description": "Response definition for the account close rpc.", +"id": "CloseAccountResponse", +"properties": {}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"Event": { +"description": "A platform sub-account event to record spam signals.", +"id": "Event", +"properties": { +"eventInfo": { +"$ref": "EventInfo", +"description": "Required. Information associated with the event." +}, +"eventTime": { +"description": "Required. Event timestamp.", +"format": "google-datetime", +"type": "string" +}, +"eventType": { +"description": "Required. Event type.", +"enum": [ +"EVENT_TYPE_UNSPECIFIED", +"LOG_IN_VIA_PLATFORM", +"SIGN_UP_VIA_PLATFORM" +], +"enumDescriptions": [ +"Do not use. You must set an event type explicitly.", +"Log in via platform.", +"Sign up via platform." +], +"type": "string" +} +}, +"type": "object" +}, +"EventInfo": { +"description": "Private information for partner recorded events (PII).", +"id": "EventInfo", +"properties": { +"billingAddress": { +"$ref": "Address", +"description": "The billing address of the publisher associated with this event, if available." +}, +"email": { +"description": "Required. The email address that is associated with the publisher when performing the event.", +"type": "string" +} +}, +"type": "object" +}, +"ListAccountsResponse": { +"description": "Response definition for the list accounts rpc.", +"id": "ListAccountsResponse", +"properties": { +"accounts": { +"description": "The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.", +"items": { +"$ref": "Account" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", +"type": "string" +} +}, +"type": "object" +}, +"ListSitesResponse": { +"description": "Response definition for the site list rpc.", +"id": "ListSitesResponse", +"properties": { +"nextPageToken": { +"description": "Continuation token used to page through sites. To retrieve the next page of the results, set the next request's \"page_token\" value to this.", +"type": "string" +}, +"sites": { +"description": "The sites returned in this list response.", +"items": { +"$ref": "Site" +}, +"type": "array" +} +}, +"type": "object" +}, +"LookupAccountResponse": { +"description": "Response definition for the lookup account rpc.", +"id": "LookupAccountResponse", +"properties": { +"name": { +"description": "The name of the Account Format: platforms/{platform}/accounts/{account_id}", +"type": "string" +} +}, +"type": "object" +}, +"RequestSiteReviewResponse": { +"description": "Response definition for the site request review rpc.", +"id": "RequestSiteReviewResponse", +"properties": {}, +"type": "object" +}, +"Site": { +"description": "Representation of a Site.", +"id": "Site", +"properties": { +"domain": { +"description": "Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.", +"type": "string" +}, +"name": { +"description": "Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. State of a site.", +"enum": [ +"STATE_UNSPECIFIED", +"REQUIRES_REVIEW", +"GETTING_READY", +"READY", +"NEEDS_ATTENTION" +], +"enumDescriptions": [ +"State unspecified.", +"Either: - The site hasn't been checked yet. - The site is inactive and needs another review before it can show ads again. Learn how to [request a review for an inactive site](https://support.google.com/adsense/answer/9393996).", +"Google is running some checks on the site. This usually takes a few days, but in some cases it can take two to four weeks.", +"The site is ready to show ads. Learn how to [set up ads on the site](https://support.google.com/adsense/answer/7037624).", +"Publisher needs to fix some issues before the site is ready to show ads. Learn what to do [if a new site isn't ready](https://support.google.com/adsense/answer/9061852)." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"TimeZone": { +"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", +"id": "TimeZone", +"properties": { +"id": { +"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", +"type": "string" +}, +"version": { +"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "AdSense Platform API", +"version": "v1", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index 8867fb7591e..51b2d54074d 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -1391,7 +1391,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the Dataset.", +"description": "Output only. Identifier. The resource name of the Dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -2268,7 +2268,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the DatasetVersion.", +"description": "Output only. Identifier. The resource name of the DatasetVersion.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, @@ -11179,6 +11179,167 @@ } }, "notebookExecutionJobs": { +"methods": { +"create": { +"description": "Creates a NotebookExecutionJob.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.notebookExecutionJobs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"notebookExecutionJobId": { +"description": "Optional. User specified ID for the NotebookExecutionJob.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location to create the NotebookExecutionJob. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/notebookExecutionJobs", +"request": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a NotebookExecutionJob.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.notebookExecutionJobs.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the NotebookExecutionJob resource to be deleted.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a NotebookExecutionJob.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs/{notebookExecutionJobsId}", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.notebookExecutionJobs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the NotebookExecutionJob resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", +"enum": [ +"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", +"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", +"NOTEBOOK_EXECUTION_JOB_VIEW_FULL" +], +"enumDescriptions": [ +"When unspecified, the API defaults to the BASIC view.", +"Includes all fields except for direct notebook inputs.", +"Includes all fields." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists NotebookExecutionJobs in a Location.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/notebookExecutionJobs", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.notebookExecutionJobs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookExecutionJob` supports = and !=. `notebookExecutionJob` represents the NotebookExecutionJob ID. * `displayName` supports = and != and regex. * `schedule` supports = and != and regex. Some examples: * `notebookExecutionJob=\"123\"` * `notebookExecutionJob=\"my-execution-job\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"`", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `display_name` * `create_time` * `update_time` Example: `display_name, create_time desc`.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The standard list page token. Typically obtained via ListNotebookExecutionJobs.next_page_token of the previous NotebookService.ListNotebookExecutionJobs call.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the Location from which to list the NotebookExecutionJobs. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"view": { +"description": "Optional. The NotebookExecutionJob view. Defaults to BASIC.", +"enum": [ +"NOTEBOOK_EXECUTION_JOB_VIEW_UNSPECIFIED", +"NOTEBOOK_EXECUTION_JOB_VIEW_BASIC", +"NOTEBOOK_EXECUTION_JOB_VIEW_FULL" +], +"enumDescriptions": [ +"When unspecified, the API defaults to the BASIC view.", +"Includes all fields except for direct notebook inputs.", +"Includes all fields." +], +"location": "query", +"type": "string" +} +}, +"path": "v1/{+parent}/notebookExecutionJobs", +"response": { +"$ref": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -16767,8 +16928,13 @@ "name" ], "parameters": { +"isHuggingFaceModel": { +"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", +"location": "query", +"type": "boolean" +}, "languageCode": { -"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).", +"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", "location": "query", "type": "string" }, @@ -16810,11 +16976,11 @@ } } }, -"revision": "20240709", +"revision": "20240715", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { -"description": "Next ID: 8 Generate video response.", +"description": "Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", "properties": { "generatedSamples": { @@ -16835,10 +17001,6 @@ "type": "string" }, "type": "array" -}, -"reportingMetrics": { -"$ref": "IntelligenceCloudAutomlXpsReportingMetrics", -"description": "Billable prediction metrics." } }, "type": "object" @@ -18444,6 +18606,12 @@ }, "readOnly": true, "type": "array" +}, +"score": { +"description": "Output only. Confidence score of the candidate.", +"format": "double", +"readOnly": true, +"type": "number" } }, "type": "object" @@ -18655,21 +18823,21 @@ "id": "GoogleCloudAiplatformV1ComputeTokensRequest", "properties": { "contents": { -"description": "Required. Input content.", +"description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1Content" }, "type": "array" }, "instances": { -"description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", +"description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", +"description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", "type": "string" } }, @@ -18871,22 +19039,33 @@ "id": "GoogleCloudAiplatformV1CountTokensRequest", "properties": { "contents": { -"description": "Required. Input content.", +"description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1Content" }, "type": "array" }, "instances": { -"description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", +"description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", +"description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" +}, +"systemInstruction": { +"$ref": "GoogleCloudAiplatformV1Content", +"description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." +}, +"tools": { +"description": "Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.", +"items": { +"$ref": "GoogleCloudAiplatformV1Tool" +}, +"type": "array" } }, "type": "object" @@ -19089,6 +19268,21 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata": { +"description": "Metadata information for NotebookService.CreateNotebookExecutionJob.", +"id": "GoogleCloudAiplatformV1CreateNotebookExecutionJobOperationMetadata", +"properties": { +"genericMetadata": { +"$ref": "GoogleCloudAiplatformV1GenericOperationMetadata", +"description": "The operation generic information." +}, +"progressMessage": { +"description": "A human-readable message that shows the intermediate progress details of NotebookRuntime.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata": { "description": "Metadata information for NotebookService.CreateNotebookRuntimeTemplate.", "id": "GoogleCloudAiplatformV1CreateNotebookRuntimeTemplateOperationMetadata", @@ -19648,7 +19842,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the Dataset.", +"description": "Output only. Identifier. The resource name of the Dataset.", "readOnly": true, "type": "string" }, @@ -19702,7 +19896,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the DatasetVersion.", +"description": "Output only. Identifier. The resource name of the DatasetVersion.", "readOnly": true, "type": "string" }, @@ -20313,6 +20507,15 @@ "readOnly": true, "type": "string" }, +"dedicatedEndpointDns": { +"description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.", +"readOnly": true, +"type": "string" +}, +"dedicatedEndpointEnabled": { +"description": "If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.", +"type": "boolean" +}, "deployedModels": { "description": "Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.", "items": { @@ -23546,45 +23749,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1GroundingAttribution": { -"description": "Grounding attribution.", -"id": "GoogleCloudAiplatformV1GroundingAttribution", -"properties": { -"confidenceScore": { -"description": "Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.", -"format": "float", -"readOnly": true, -"type": "number" -}, -"segment": { -"$ref": "GoogleCloudAiplatformV1Segment", -"description": "Output only. Segment of the content this attribution belongs to.", -"readOnly": true -}, -"web": { -"$ref": "GoogleCloudAiplatformV1GroundingAttributionWeb", -"description": "Optional. Attribution from the web." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1GroundingAttributionWeb": { -"description": "Attribution from the web.", -"id": "GoogleCloudAiplatformV1GroundingAttributionWeb", -"properties": { -"title": { -"description": "Output only. Title of the attribution.", -"readOnly": true, -"type": "string" -}, -"uri": { -"description": "Output only. URI reference of the attribution.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1GroundingChunk": { "description": "Grounding chunk.", "id": "GoogleCloudAiplatformV1GroundingChunk", @@ -23634,13 +23798,6 @@ "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1GroundingMetadata", "properties": { -"groundingAttributions": { -"description": "Optional. List of grounding attributions.", -"items": { -"$ref": "GoogleCloudAiplatformV1GroundingAttribution" -}, -"type": "array" -}, "groundingChunks": { "description": "List of supporting references retrieved from specified grounding source.", "items": { @@ -25082,6 +25239,24 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse": { +"description": "Response message for [NotebookService.CreateNotebookExecutionJob]", +"id": "GoogleCloudAiplatformV1ListNotebookExecutionJobsResponse", +"properties": { +"nextPageToken": { +"description": "A token to retrieve next page of results. Pass to ListNotebookExecutionJobs.page_token to obtain that page.", +"type": "string" +}, +"notebookExecutionJobs": { +"description": "List of NotebookExecutionJobs in the requested page.", +"items": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJob" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse": { "description": "Response message for NotebookService.ListNotebookRuntimeTemplates.", "id": "GoogleCloudAiplatformV1ListNotebookRuntimeTemplatesResponse", @@ -27420,6 +27595,13 @@ false "format": "int32", "type": "integer" }, +"numericFilters": { +"description": "Optional. The list of numeric filters.", +"items": { +"$ref": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter" +}, +"type": "array" +}, "parameters": { "$ref": "GoogleCloudAiplatformV1NearestNeighborQueryParameters", "description": "Optional. Parameters that can be set to tune query on the fly." @@ -27454,6 +27636,54 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter": { +"description": "Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: \u201ca\u201d value_int: 42} {name: \u201cb\u201d value_float: 1.0} Database Point 1: {name: \u201ca\u201d value_int: 10} {name: \u201cb\u201d value_float: 2.0} Database Point 2: {name: \u201ca\u201d value_int: -1} {name: \u201cb\u201d value_float: 3.0} Query: {name: \u201ca\u201d value_int: 12 operator: LESS} // Matches Point 1, 2 {name: \u201cb\u201d value_float: 2.0 operator: EQUAL} // Matches Point 1", +"id": "GoogleCloudAiplatformV1NearestNeighborQueryNumericFilter", +"properties": { +"name": { +"description": "Required. Column name in BigQuery that used as filters.", +"type": "string" +}, +"op": { +"description": "Optional. This MUST be specified for queries and must NOT be specified for database points.", +"enum": [ +"OPERATOR_UNSPECIFIED", +"LESS", +"LESS_EQUAL", +"EQUAL", +"GREATER_EQUAL", +"GREATER", +"NOT_EQUAL" +], +"enumDescriptions": [ +"Unspecified operator.", +"Entities are eligible if their value is < the query's.", +"Entities are eligible if their value is <= the query's.", +"Entities are eligible if their value is == the query's.", +"Entities are eligible if their value is >= the query's.", +"Entities are eligible if their value is > the query's.", +"Entities are eligible if their value is != the query's." +], +"type": "string" +}, +"valueDouble": { +"description": "double value type.", +"format": "double", +"type": "number" +}, +"valueFloat": { +"description": "float value type.", +"format": "float", +"type": "number" +}, +"valueInt": { +"description": "int value type.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1NearestNeighborQueryParameters": { "description": "Parameters that can be overrided in each query to tune query latency and recall.", "id": "GoogleCloudAiplatformV1NearestNeighborQueryParameters", @@ -27724,6 +27954,159 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1NotebookExecutionJob": { +"description": "NotebookExecutionJob represents an instance of a notebook execution.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJob", +"properties": { +"createTime": { +"description": "Output only. Timestamp when this NotebookExecutionJob was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataformRepositorySource": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", +"description": "The Dataform Repository pointing to a single file notebook repository." +}, +"directNotebookSource": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", +"description": "The contents of an input notebook file." +}, +"displayName": { +"description": "The display name of the NotebookExecutionJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.", +"type": "string" +}, +"executionTimeout": { +"description": "Max running time of the execution job in seconds (default 86400s / 24 hrs).", +"format": "google-duration", +"type": "string" +}, +"executionUser": { +"description": "The user email to run the execution as. Only supported by Colab runtimes.", +"type": "string" +}, +"gcsNotebookSource": { +"$ref": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", +"description": "The Cloud Storage url pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`" +}, +"gcsOutputUri": { +"description": "The Cloud Storage location to upload the result to. Format: `gs://bucket-name`", +"type": "string" +}, +"jobState": { +"description": "Output only. The state of the NotebookExecutionJob.", +"enum": [ +"JOB_STATE_UNSPECIFIED", +"JOB_STATE_QUEUED", +"JOB_STATE_PENDING", +"JOB_STATE_RUNNING", +"JOB_STATE_SUCCEEDED", +"JOB_STATE_FAILED", +"JOB_STATE_CANCELLING", +"JOB_STATE_CANCELLED", +"JOB_STATE_PAUSED", +"JOB_STATE_EXPIRED", +"JOB_STATE_UPDATING", +"JOB_STATE_PARTIALLY_SUCCEEDED" +], +"enumDescriptions": [ +"The job state is unspecified.", +"The job has been just created or resumed and processing has not yet begun.", +"The service is preparing to run the job.", +"The job is in progress.", +"The job completed successfully.", +"The job failed.", +"The job is being cancelled. From this state the job may only go to either `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED` or `JOB_STATE_CANCELLED`.", +"The job has been cancelled.", +"The job has been stopped, and can be resumed.", +"The job has expired.", +"The job is being updated. Only jobs in the `RUNNING` state can be updated. After updating, the job goes back to the `RUNNING` state.", +"The job is partially succeeded, some results may be missing due to errors." +], +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "The labels with user-defined metadata to organize NotebookExecutionJobs. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", +"type": "object" +}, +"name": { +"description": "Output only. The resource name of this NotebookExecutionJob. Format: `projects/{project_id}/locations/{location}/notebookExecutionJobs/{job_id}`", +"readOnly": true, +"type": "string" +}, +"notebookRuntimeTemplateResourceName": { +"description": "The NotebookRuntimeTemplate to source compute configuration from.", +"type": "string" +}, +"scheduleResourceName": { +"description": "Output only. The Schedule resource name if this job is triggered by one. Format: `projects/{project_id}/locations/{location}/schedules/{schedule_id}`", +"readOnly": true, +"type": "string" +}, +"serviceAccount": { +"description": "The service account to run the execution as.", +"type": "string" +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "Output only. Populated when the NotebookExecutionJob is completed. When there is an error during notebook execution, the error details are populated.", +"readOnly": true +}, +"updateTime": { +"description": "Output only. Timestamp when this NotebookExecutionJob was most recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource": { +"description": "The Dataform Repository containing the input notebook.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJobDataformRepositorySource", +"properties": { +"commitSha": { +"description": "The commit SHA to read repository with. If unset, the file will be read at HEAD.", +"type": "string" +}, +"dataformRepositoryResourceName": { +"description": "The resource name of the Dataform Repository. Format: `projects/{project_id}/locations/{location}/repositories/{repository_id}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource": { +"description": "The content of the input notebook in ipynb format.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJobDirectNotebookSource", +"properties": { +"content": { +"description": "The base64-encoded contents of the input notebook file.", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource": { +"description": "The Cloud Storage uri for the input notebook.", +"id": "GoogleCloudAiplatformV1NotebookExecutionJobGcsNotebookSource", +"properties": { +"generation": { +"description": "The version of the Cloud Storage object to read. If unset, the current version of the object is read. See https://cloud.google.com/storage/docs/metadata#generation-number.", +"type": "string" +}, +"uri": { +"description": "The Cloud Storage uri pointing to the ipynb file. Format: `gs://bucket/notebook_file.ipynb`", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1NotebookIdleShutdownConfig": { "description": "The idle shutdown configuration of NotebookRuntimeTemplate, which contains the idle_timeout as required field.", "id": "GoogleCloudAiplatformV1NotebookIdleShutdownConfig", @@ -28290,6 +28673,10 @@ false "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.", "type": "string" }, +"pscInterfaceConfig": { +"$ref": "GoogleCloudAiplatformV1PscInterfaceConfig", +"description": "Optional. Configuration for PSC-I for PersistentResource." +}, "reservedIpRanges": { "description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { @@ -29072,6 +29459,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1PscInterfaceConfig": { +"description": "Configuration for PSC-I.", +"id": "GoogleCloudAiplatformV1PscInterfaceConfig", +"properties": { +"networkAttachment": { +"description": "Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1PublisherModel": { "description": "A Model Garden Publisher Model.", "id": "GoogleCloudAiplatformV1PublisherModel", @@ -29945,6 +30343,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1RayLogsSpec": { +"description": "Configuration for the Ray OSS Logs.", +"id": "GoogleCloudAiplatformV1RayLogsSpec", +"properties": { +"disabled": { +"description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1RayMetricSpec", @@ -29968,6 +30377,10 @@ false "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, +"rayLogsSpec": { +"$ref": "GoogleCloudAiplatformV1RayLogsSpec", +"description": "Optional. OSS Ray logging configurations." +}, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1RayMetricSpec", "description": "Optional. Ray metrics configurations." @@ -30375,7 +30788,8 @@ false "id": "GoogleCloudAiplatformV1Retrieval", "properties": { "disableAttribution": { -"description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", +"deprecated": true, +"description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, "vertexAiSearch": { @@ -30935,6 +31349,20 @@ false "description": "Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.", "type": "boolean" }, +"strategy": { +"description": "Optional. This determines which type of scheduling strategy to use.", +"enum": [ +"STRATEGY_UNSPECIFIED", +"ON_DEMAND", +"LOW_COST" +], +"enumDescriptions": [ +"Strategy will default to ON_DEMAND.", +"Regular on-demand provisioning strategy.", +"Low cost by making potential use of spot resources." +], +"type": "string" +}, "timeout": { "description": "The maximum job running time. The default is 7 days.", "format": "google-duration", @@ -32193,6 +32621,7 @@ false "id": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig", "properties": { "disableAttribution": { +"deprecated": true, "description": "If set, skip finding claim attributions (i.e not generate grounding citation).", "type": "boolean" }, @@ -36132,14 +36561,16 @@ false "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", -"ADAPTER_SIZE_SIXTEEN" +"ADAPTER_SIZE_SIXTEEN", +"ADAPTER_SIZE_THIRTY_TWO" ], "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 4.", "Adapter size 8.", -"Adapter size 16." +"Adapter size 16.", +"Adapter size 32." ], "type": "string" }, @@ -38486,70 +38917,6 @@ false } }, "type": "object" -}, -"IntelligenceCloudAutomlXpsMetricEntry": { -"id": "IntelligenceCloudAutomlXpsMetricEntry", -"properties": { -"argentumMetricId": { -"description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", -"type": "string" -}, -"doubleValue": { -"description": "A double value.", -"format": "double", -"type": "number" -}, -"int64Value": { -"description": "A signed 64-bit integer value.", -"format": "int64", -"type": "string" -}, -"metricName": { -"description": "The metric name defined in the service configuration.", -"type": "string" -}, -"systemLabels": { -"description": "Billing system labels for this (metric, value) pair.", -"items": { -"$ref": "IntelligenceCloudAutomlXpsMetricEntryLabel" -}, -"type": "array" -} -}, -"type": "object" -}, -"IntelligenceCloudAutomlXpsMetricEntryLabel": { -"id": "IntelligenceCloudAutomlXpsMetricEntryLabel", -"properties": { -"labelName": { -"description": "The name of the label.", -"type": "string" -}, -"labelValue": { -"description": "The value of the label.", -"type": "string" -} -}, -"type": "object" -}, -"IntelligenceCloudAutomlXpsReportingMetrics": { -"id": "IntelligenceCloudAutomlXpsReportingMetrics", -"properties": { -"effectiveTrainingDuration": { -"deprecated": true, -"description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", -"format": "google-duration", -"type": "string" -}, -"metricEntries": { -"description": "One entry per metric name. The values must be aggregated per metric name.", -"items": { -"$ref": "IntelligenceCloudAutomlXpsMetricEntry" -}, -"type": "array" -} -}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index 6e14dd34949..589feb70cf0 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -1980,7 +1980,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the Dataset.", +"description": "Output only. Identifier. The resource name of the Dataset.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", "required": true, @@ -2857,7 +2857,7 @@ ], "parameters": { "name": { -"description": "Output only. The resource name of the DatasetVersion.", +"description": "Output only. Identifier. The resource name of the DatasetVersion.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", "required": true, @@ -20336,8 +20336,13 @@ "name" ], "parameters": { +"isHuggingFaceModel": { +"description": "Optional. Boolean indicates whether the requested model is a Hugging Face model.", +"location": "query", +"type": "boolean" +}, "languageCode": { -"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).", +"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.", "location": "query", "type": "string" }, @@ -20389,7 +20394,7 @@ "type": "string" }, "languageCode": { -"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en).", +"description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).", "location": "query", "type": "string" }, @@ -20447,11 +20452,11 @@ } } }, -"revision": "20240709", +"revision": "20240715", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionGenerateVideoResponse": { -"description": "Next ID: 8 Generate video response.", +"description": "Generate video response.", "id": "CloudAiLargeModelsVisionGenerateVideoResponse", "properties": { "generatedSamples": { @@ -20472,10 +20477,6 @@ "type": "string" }, "type": "array" -}, -"reportingMetrics": { -"$ref": "IntelligenceCloudAutomlXpsReportingMetrics", -"description": "Billable prediction metrics." } }, "type": "object" @@ -21002,6 +21003,17 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig": { +"description": "The API secret.", +"id": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", +"properties": { +"apiKeySecretVersion": { +"description": "Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1Artifact": { "description": "Instance of a general artifact.", "id": "GoogleCloudAiplatformV1beta1Artifact", @@ -22339,6 +22351,12 @@ }, "readOnly": true, "type": "array" +}, +"score": { +"description": "Output only. Confidence score of the candidate.", +"format": "double", +"readOnly": true, +"type": "number" } }, "type": "object" @@ -22550,21 +22568,21 @@ "id": "GoogleCloudAiplatformV1beta1ComputeTokensRequest", "properties": { "contents": { -"description": "Required. Input content.", +"description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { -"description": "Required. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", +"description": "Optional. The instances that are the input to token computing API call. Schema is identical to the prediction schema of the text model, even for the non-text models, like chat models, or Codey models.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", +"description": "Optional. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*", "type": "string" } }, @@ -22766,22 +22784,33 @@ "id": "GoogleCloudAiplatformV1beta1CountTokensRequest", "properties": { "contents": { -"description": "Required. Input content.", +"description": "Optional. Input content.", "items": { "$ref": "GoogleCloudAiplatformV1beta1Content" }, "type": "array" }, "instances": { -"description": "Required. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", +"description": "Optional. The instances that are the input to token counting call. Schema is identical to the prediction schema of the underlying model.", "items": { "type": "any" }, "type": "array" }, "model": { -"description": "Required. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", +"description": "Optional. The name of the publisher model requested to serve the prediction. Format: `projects/{project}/locations/{location}/publishers/*/models/*`", "type": "string" +}, +"systemInstruction": { +"$ref": "GoogleCloudAiplatformV1beta1Content", +"description": "Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph." +}, +"tools": { +"description": "Optional. A list of `Tools` the model may use to generate the next response. A `Tool` is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1Tool" +}, +"type": "array" } }, "type": "object" @@ -23629,7 +23658,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the Dataset.", +"description": "Output only. Identifier. The resource name of the Dataset.", "readOnly": true, "type": "string" }, @@ -23683,7 +23712,7 @@ "type": "string" }, "name": { -"description": "Output only. The resource name of the DatasetVersion.", +"description": "Output only. Identifier. The resource name of the DatasetVersion.", "readOnly": true, "type": "string" }, @@ -24311,6 +24340,15 @@ "readOnly": true, "type": "string" }, +"dedicatedEndpointDns": { +"description": "Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.", +"readOnly": true, +"type": "string" +}, +"dedicatedEndpointEnabled": { +"description": "If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.", +"type": "boolean" +}, "deployedModels": { "description": "Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.", "items": { @@ -27920,66 +27958,6 @@ }, "type": "object" }, -"GoogleCloudAiplatformV1beta1GroundingAttribution": { -"description": "Grounding attribution.", -"id": "GoogleCloudAiplatformV1beta1GroundingAttribution", -"properties": { -"confidenceScore": { -"description": "Optional. Output only. Confidence score of the attribution. Ranges from 0 to 1. 1 is the most confident.", -"format": "float", -"readOnly": true, -"type": "number" -}, -"retrievedContext": { -"$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", -"description": "Optional. Attribution from context retrieved by the retrieval tools." -}, -"segment": { -"$ref": "GoogleCloudAiplatformV1beta1Segment", -"description": "Output only. Segment of the content this attribution belongs to.", -"readOnly": true -}, -"web": { -"$ref": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", -"description": "Optional. Attribution from the web." -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext": { -"description": "Attribution from context retrieved by the retrieval tools.", -"id": "GoogleCloudAiplatformV1beta1GroundingAttributionRetrievedContext", -"properties": { -"title": { -"description": "Output only. Title of the attribution.", -"readOnly": true, -"type": "string" -}, -"uri": { -"description": "Output only. URI reference of the attribution.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudAiplatformV1beta1GroundingAttributionWeb": { -"description": "Attribution from the web.", -"id": "GoogleCloudAiplatformV1beta1GroundingAttributionWeb", -"properties": { -"title": { -"description": "Output only. Title of the attribution.", -"readOnly": true, -"type": "string" -}, -"uri": { -"description": "Output only. URI reference of the attribution.", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudAiplatformV1beta1GroundingChunk": { "description": "Grounding chunk.", "id": "GoogleCloudAiplatformV1beta1GroundingChunk", @@ -28029,13 +28007,6 @@ "description": "Metadata returned to client when grounding is enabled.", "id": "GoogleCloudAiplatformV1beta1GroundingMetadata", "properties": { -"groundingAttributions": { -"description": "Optional. List of grounding attributions.", -"items": { -"$ref": "GoogleCloudAiplatformV1beta1GroundingAttribution" -}, -"type": "array" -}, "groundingChunks": { "description": "List of supporting references retrieved from specified grounding source.", "items": { @@ -28463,6 +28434,10 @@ "$ref": "GoogleCloudAiplatformV1beta1GoogleDriveSource", "description": "Google Drive location. Supports importing individual files as well as Google Drive folders." }, +"jiraSource": { +"$ref": "GoogleCloudAiplatformV1beta1JiraSource", +"description": "Jira queries with their corresponding authentication." +}, "maxEmbeddingRequestsPerMin": { "description": "Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used.", "format": "int32", @@ -28471,6 +28446,10 @@ "ragFileChunkingConfig": { "$ref": "GoogleCloudAiplatformV1beta1RagFileChunkingConfig", "description": "Specifies the size and overlap of chunks after importing RagFiles." +}, +"slackSource": { +"$ref": "GoogleCloudAiplatformV1beta1SlackSource", +"description": "Slack channels with their corresponding access tokens." } }, "type": "object" @@ -28984,6 +28963,53 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1JiraSource": { +"description": "The Jira source for the ImportRagFilesRequest.", +"id": "GoogleCloudAiplatformV1beta1JiraSource", +"properties": { +"jiraQueries": { +"description": "Required. The Jira queries.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1JiraSourceJiraQueries": { +"description": "JiraQueries contains the Jira queries and corresponding authentication.", +"id": "GoogleCloudAiplatformV1beta1JiraSourceJiraQueries", +"properties": { +"apiKeyConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", +"description": "Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/)." +}, +"customQueries": { +"description": "A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/", +"items": { +"type": "string" +}, +"type": "array" +}, +"email": { +"description": "Required. The Jira email address.", +"type": "string" +}, +"projects": { +"description": "A list of Jira projects to import in their entirety.", +"items": { +"type": "string" +}, +"type": "array" +}, +"serverUri": { +"description": "Required. The Jira server URI.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1LargeModelReference": { "description": "Contains information about the Large Model.", "id": "GoogleCloudAiplatformV1beta1LargeModelReference", @@ -31373,6 +31399,16 @@ false "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringOutputSpec", "description": "Optional default monitoring metrics/logs export spec, it can be overridden in the ModelMonitoringJob output spec. If not specified, a default Google Cloud Storage bucket will be created under your project." }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "tabularObjective": { "$ref": "GoogleCloudAiplatformV1beta1ModelMonitoringObjectiveSpecTabularObjective", "description": "Optional default tabular model monitoring objective." @@ -32838,6 +32874,13 @@ false "format": "int32", "type": "integer" }, +"numericFilters": { +"description": "Optional. The list of numeric filters.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter" +}, +"type": "array" +}, "parameters": { "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters", "description": "Optional. Parameters that can be set to tune query on the fly." @@ -32872,6 +32915,54 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter": { +"description": "Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: \u201ca\u201d value_int: 42} {name: \u201cb\u201d value_float: 1.0} Database Point 1: {name: \u201ca\u201d value_int: 10} {name: \u201cb\u201d value_float: 2.0} Database Point 2: {name: \u201ca\u201d value_int: -1} {name: \u201cb\u201d value_float: 3.0} Query: {name: \u201ca\u201d value_int: 12 operator: LESS} // Matches Point 1, 2 {name: \u201cb\u201d value_float: 2.0 operator: EQUAL} // Matches Point 1", +"id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryNumericFilter", +"properties": { +"name": { +"description": "Required. Column name in BigQuery that used as filters.", +"type": "string" +}, +"op": { +"description": "Optional. This MUST be specified for queries and must NOT be specified for database points.", +"enum": [ +"OPERATOR_UNSPECIFIED", +"LESS", +"LESS_EQUAL", +"EQUAL", +"GREATER_EQUAL", +"GREATER", +"NOT_EQUAL" +], +"enumDescriptions": [ +"Unspecified operator.", +"Entities are eligible if their value is < the query's.", +"Entities are eligible if their value is <= the query's.", +"Entities are eligible if their value is == the query's.", +"Entities are eligible if their value is >= the query's.", +"Entities are eligible if their value is > the query's.", +"Entities are eligible if their value is != the query's." +], +"type": "string" +}, +"valueDouble": { +"description": "double value type.", +"format": "double", +"type": "number" +}, +"valueFloat": { +"description": "float value type.", +"format": "float", +"type": "number" +}, +"valueInt": { +"description": "int value type.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters": { "description": "Parameters that can be overrided in each query to tune query latency and recall.", "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters", @@ -33861,6 +33952,10 @@ false "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.", "type": "string" }, +"pscInterfaceConfig": { +"$ref": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", +"description": "Optional. Configuration for PSC-I for PersistentResource." +}, "reservedIpRanges": { "description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { @@ -33995,6 +34090,16 @@ false "$ref": "GoogleCloudAiplatformV1beta1PipelineJobRuntimeConfig", "description": "Runtime config of the pipeline." }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "scheduleName": { "description": "Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.", "readOnly": true, @@ -34643,6 +34748,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1PscInterfaceConfig": { +"description": "Configuration for PSC-I.", +"id": "GoogleCloudAiplatformV1beta1PscInterfaceConfig", +"properties": { +"networkAttachment": { +"description": "Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1PublisherModel": { "description": "A Model Garden Publisher Model.", "id": "GoogleCloudAiplatformV1beta1PublisherModel", @@ -35717,6 +35833,10 @@ false "description": "Output only. Google Drive location. Supports importing individual files as well as Google Drive folders.", "readOnly": true }, +"jiraSource": { +"$ref": "GoogleCloudAiplatformV1beta1JiraSource", +"description": "The RagFile is imported from a Jira query." +}, "name": { "description": "Output only. The resource name of the RagFile.", "readOnly": true, @@ -35743,6 +35863,10 @@ false "readOnly": true, "type": "string" }, +"slackSource": { +"$ref": "GoogleCloudAiplatformV1beta1SlackSource", +"description": "The RagFile is imported from a Slack channel." +}, "updateTime": { "description": "Output only. Timestamp when this RagFile was last updated.", "format": "google-datetime", @@ -35796,6 +35920,17 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1RayLogsSpec": { +"description": "Configuration for the Ray OSS Logs.", +"id": "GoogleCloudAiplatformV1beta1RayLogsSpec", +"properties": { +"disabled": { +"description": "Optional. Flag to disable the export of Ray OSS logs to Cloud Logging.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1RayMetricSpec": { "description": "Configuration for the Ray metrics.", "id": "GoogleCloudAiplatformV1beta1RayMetricSpec", @@ -35819,6 +35954,10 @@ false "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, +"rayLogsSpec": { +"$ref": "GoogleCloudAiplatformV1beta1RayLogsSpec", +"description": "Optional. OSS Ray logging configurations." +}, "rayMetricSpec": { "$ref": "GoogleCloudAiplatformV1beta1RayMetricSpec", "description": "Optional. Ray metrics configurations." @@ -36411,7 +36550,8 @@ false "id": "GoogleCloudAiplatformV1beta1Retrieval", "properties": { "disableAttribution": { -"description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", +"deprecated": true, +"description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, "vertexAiSearch": { @@ -37105,6 +37245,20 @@ false "description": "Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.", "type": "boolean" }, +"strategy": { +"description": "Optional. This determines which type of scheduling strategy to use.", +"enum": [ +"STRATEGY_UNSPECIFIED", +"ON_DEMAND", +"LOW_COST" +], +"enumDescriptions": [ +"Strategy will default to ON_DEMAND.", +"Regular on-demand provisioning strategy.", +"Low cost by making potential use of spot resources." +], +"type": "string" +}, "timeout": { "description": "The maximum job running time. The default is 7 days.", "format": "google-duration", @@ -41271,6 +41425,59 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SlackSource": { +"description": "The Slack source for the ImportRagFilesRequest.", +"id": "GoogleCloudAiplatformV1beta1SlackSource", +"properties": { +"channels": { +"description": "Required. The Slack channels.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SlackSourceSlackChannels": { +"description": "SlackChannels contains the Slack channels and corresponding access token.", +"id": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannels", +"properties": { +"apiKeyConfig": { +"$ref": "GoogleCloudAiplatformV1beta1ApiAuthApiKeyConfig", +"description": "Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token." +}, +"channels": { +"description": "Required. The Slack channel IDs.", +"items": { +"$ref": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel": { +"description": "SlackChannel contains the Slack channel ID and the time range to import.", +"id": "GoogleCloudAiplatformV1beta1SlackSourceSlackChannelsSlackChannel", +"properties": { +"channelId": { +"description": "Required. The Slack channel ID.", +"type": "string" +}, +"endTime": { +"description": "Optional. The ending timestamp for messages to import.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Optional. The starting timestamp for messages to import.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1SmoothGradConfig": { "description": "Config for SmoothGrad approximation of gradients. When enabled, the gradients are approximated by averaging the gradients from noisy samples in the vicinity of the inputs. Adding noise can help improve the computed gradients. Refer to this paper for more details: https://arxiv.org/pdf/1706.03825.pdf", "id": "GoogleCloudAiplatformV1beta1SmoothGradConfig", @@ -42412,14 +42619,16 @@ false "ADAPTER_SIZE_ONE", "ADAPTER_SIZE_FOUR", "ADAPTER_SIZE_EIGHT", -"ADAPTER_SIZE_SIXTEEN" +"ADAPTER_SIZE_SIXTEEN", +"ADAPTER_SIZE_THIRTY_TWO" ], "enumDescriptions": [ "Adapter size is unspecified.", "Adapter size 1.", "Adapter size 4.", "Adapter size 8.", -"Adapter size 16." +"Adapter size 16.", +"Adapter size 32." ], "type": "string" }, @@ -44974,70 +45183,6 @@ false } }, "type": "object" -}, -"IntelligenceCloudAutomlXpsMetricEntry": { -"id": "IntelligenceCloudAutomlXpsMetricEntry", -"properties": { -"argentumMetricId": { -"description": "For billing metrics that are using legacy sku's, set the legacy billing metric id here. This will be sent to Chemist as the \"cloudbilling.googleapis.com/argentum_metric_id\" label. Otherwise leave empty.", -"type": "string" -}, -"doubleValue": { -"description": "A double value.", -"format": "double", -"type": "number" -}, -"int64Value": { -"description": "A signed 64-bit integer value.", -"format": "int64", -"type": "string" -}, -"metricName": { -"description": "The metric name defined in the service configuration.", -"type": "string" -}, -"systemLabels": { -"description": "Billing system labels for this (metric, value) pair.", -"items": { -"$ref": "IntelligenceCloudAutomlXpsMetricEntryLabel" -}, -"type": "array" -} -}, -"type": "object" -}, -"IntelligenceCloudAutomlXpsMetricEntryLabel": { -"id": "IntelligenceCloudAutomlXpsMetricEntryLabel", -"properties": { -"labelName": { -"description": "The name of the label.", -"type": "string" -}, -"labelValue": { -"description": "The value of the label.", -"type": "string" -} -}, -"type": "object" -}, -"IntelligenceCloudAutomlXpsReportingMetrics": { -"id": "IntelligenceCloudAutomlXpsReportingMetrics", -"properties": { -"effectiveTrainingDuration": { -"deprecated": true, -"description": "The effective time training used. If set, this is used for quota management and billing. Deprecated. AutoML BE doesn't use this. Don't set.", -"format": "google-duration", -"type": "string" -}, -"metricEntries": { -"description": "One entry per metric name. The values must be aggregated per metric name.", -"items": { -"$ref": "IntelligenceCloudAutomlXpsMetricEntry" -}, -"type": "array" -} -}, -"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json index 93e1b0aae25..ef2e4a58f17 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1alpha.json @@ -209,7 +209,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", +"description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`", "location": "path", "pattern": "^accounts/[^/]+/dataSharingSettings$", "required": true, @@ -349,7 +349,7 @@ ], "parameters": { "account": { -"description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: \"accounts/100\"", +"description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -2180,7 +2180,7 @@ "methods": { "create": { "deprecated": true, -"description": "Creates a conversion event with the specified attributes.", +"description": "Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", "httpMethod": "POST", "id": "analyticsadmin.properties.conversionEvents.create", @@ -2209,7 +2209,7 @@ }, "delete": { "deprecated": true, -"description": "Deletes a conversion event in a property.", +"description": "Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "DELETE", "id": "analyticsadmin.properties.conversionEvents.delete", @@ -2235,7 +2235,7 @@ }, "get": { "deprecated": true, -"description": "Retrieve a single conversion event.", +"description": "Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.get", @@ -2262,7 +2262,7 @@ }, "list": { "deprecated": true, -"description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", +"description": "Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.list", @@ -2300,7 +2300,7 @@ }, "patch": { "deprecated": true, -"description": "Updates a conversion event with the specified attributes.", +"description": "Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.", "flatPath": "v1alpha/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "PATCH", "id": "analyticsadmin.properties.conversionEvents.patch", @@ -2792,7 +2792,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: \"properties/123/dataStreams/456/globalSiteTag\"", +"description": "Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag`", "location": "path", "pattern": "^properties/[^/]+/dataStreams/[^/]+/globalSiteTag$", "required": true, @@ -3103,35 +3103,6 @@ } } }, -"eventEditRules": { -"methods": { -"reorder": { -"description": "Changes the processing order of event edit rules on the specified stream.", -"flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", -"httpMethod": "POST", -"id": "analyticsadmin.properties.dataStreams.eventEditRules.reorder", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. Example format: properties/123/dataStreams/456", -"location": "path", -"pattern": "^properties/[^/]+/dataStreams/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1alpha/{+parent}/eventEditRules:reorder", -"request": { -"$ref": "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest" -}, -"response": { -"$ref": "GoogleProtobufEmpty" -} -} -} -}, "measurementProtocolSecrets": { "methods": { "create": { @@ -3938,7 +3909,7 @@ ], "parameters": { "parent": { -"description": "Required. Format: properties/{property_id} Example: properties/1234", +"description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -3966,7 +3937,7 @@ ], "parameters": { "name": { -"description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678", +"description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`", "location": "path", "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", "required": true, @@ -4002,7 +3973,7 @@ "type": "string" }, "parent": { -"description": "Required. Format: properties/{property_id} Example: properties/1234", +"description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -4733,7 +4704,7 @@ } } }, -"revision": "20240707", +"revision": "20240722", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -8326,20 +8297,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest": { -"description": "Request message for ReorderEventEditRules RPC.", -"id": "GoogleAnalyticsAdminV1alphaReorderEventEditRulesRequest", -"properties": { -"eventEditRules": { -"description": "Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink": { "description": "A link that references a source property under the parent rollup property.", "id": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink", @@ -8577,7 +8534,7 @@ "type": "string" }, "property": { -"description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: \"properties/100\"", +"description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`", "type": "string" }, "resourceType": { diff --git a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json index c5994be2a5c..c1ab57d0f77 100644 --- a/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json +++ b/googleapiclient/discovery_cache/documents/analyticsadmin.v1beta.json @@ -203,7 +203,7 @@ ], "parameters": { "name": { -"description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: \"accounts/1000/dataSharingSettings\"", +"description": "Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings`", "location": "path", "pattern": "^accounts/[^/]+/dataSharingSettings$", "required": true, @@ -343,7 +343,7 @@ ], "parameters": { "account": { -"description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: \"accounts/100\"", +"description": "Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100`", "location": "path", "pattern": "^accounts/[^/]+$", "required": true, @@ -630,7 +630,7 @@ "methods": { "create": { "deprecated": true, -"description": "Creates a conversion event with the specified attributes.", +"description": "Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", "httpMethod": "POST", "id": "analyticsadmin.properties.conversionEvents.create", @@ -659,7 +659,7 @@ }, "delete": { "deprecated": true, -"description": "Deletes a conversion event in a property.", +"description": "Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "DELETE", "id": "analyticsadmin.properties.conversionEvents.delete", @@ -685,7 +685,7 @@ }, "get": { "deprecated": true, -"description": "Retrieve a single conversion event.", +"description": "Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.get", @@ -712,7 +712,7 @@ }, "list": { "deprecated": true, -"description": "Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", +"description": "Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents", "httpMethod": "GET", "id": "analyticsadmin.properties.conversionEvents.list", @@ -750,7 +750,7 @@ }, "patch": { "deprecated": true, -"description": "Updates a conversion event with the specified attributes.", +"description": "Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.", "flatPath": "v1beta/properties/{propertiesId}/conversionEvents/{conversionEventsId}", "httpMethod": "PATCH", "id": "analyticsadmin.properties.conversionEvents.patch", @@ -1253,35 +1253,6 @@ } }, "resources": { -"eventEditRules": { -"methods": { -"reorder": { -"description": "Changes the processing order of event edit rules on the specified stream.", -"flatPath": "v1beta/properties/{propertiesId}/dataStreams/{dataStreamsId}/eventEditRules:reorder", -"httpMethod": "POST", -"id": "analyticsadmin.properties.dataStreams.eventEditRules.reorder", -"parameterOrder": [ -"parent" -], -"parameters": { -"parent": { -"description": "Required. Example format: properties/123/dataStreams/456", -"location": "path", -"pattern": "^properties/[^/]+/dataStreams/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1beta/{+parent}/eventEditRules:reorder", -"request": { -"$ref": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest" -}, -"response": { -"$ref": "GoogleProtobufEmpty" -} -} -} -}, "measurementProtocolSecrets": { "methods": { "create": { @@ -1450,7 +1421,7 @@ ], "parameters": { "parent": { -"description": "Required. Format: properties/{property_id} Example: properties/1234", +"description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -1478,7 +1449,7 @@ ], "parameters": { "name": { -"description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678", +"description": "Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678`", "location": "path", "pattern": "^properties/[^/]+/firebaseLinks/[^/]+$", "required": true, @@ -1514,7 +1485,7 @@ "type": "string" }, "parent": { -"description": "Required. Format: properties/{property_id} Example: properties/1234", +"description": "Required. Format: properties/{property_id} Example: `properties/1234`", "location": "path", "pattern": "^properties/[^/]+$", "required": true, @@ -1817,7 +1788,7 @@ } } }, -"revision": "20240707", +"revision": "20240722", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { @@ -3352,20 +3323,6 @@ }, "type": "object" }, -"GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest": { -"description": "Request message for ReorderEventEditRules RPC.", -"id": "GoogleAnalyticsAdminV1betaReorderEventEditRulesRequest", -"properties": { -"eventEditRules": { -"description": "Required. EventEditRule resource names for the specified data stream, in the needed processing order. All EventEditRules for the stream must be present in the list.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleAnalyticsAdminV1betaRunAccessReportRequest": { "description": "The request for a Data Access Record Report.", "id": "GoogleAnalyticsAdminV1betaRunAccessReportRequest", @@ -3522,7 +3479,7 @@ "type": "string" }, "property": { -"description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: \"properties/100\"", +"description": "Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`", "type": "string" }, "resourceType": { diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index 8f92c22e6d5..a6be87257f6 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -585,7 +585,7 @@ "enrollmentTokens": { "methods": { "create": { -"description": "Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.", +"description": "Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore.", "flatPath": "v1/enterprises/{enterprisesId}/enrollmentTokens", "httpMethod": "POST", "id": "androidmanagement.enterprises.enrollmentTokens.create", @@ -1168,7 +1168,7 @@ } } }, -"revision": "20240708", +"revision": "20240724", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -4248,9 +4248,9 @@ false "DEVICE_INCOMPATIBLE" ], "enumDescriptions": [ -"This value is disallowed.", +"This value is not used.", "The setting is not supported in the API level of the Android version running on the device.", -"The management mode (profile owner, device owner, etc.) doesn't support the setting.", +"The management mode (such as fully managed or work profile) doesn't support the setting.", "The user has not taken required action to comply with the setting.", "The setting has an invalid value.", "The app required to implement the policy is not installed.", @@ -4326,9 +4326,9 @@ false "DEVICE_INCOMPATIBLE" ], "enumDescriptions": [ -"This value is disallowed.", +"This value is not used.", "The setting is not supported in the API level of the Android version running on the device.", -"The management mode (profile owner, device owner, etc.) doesn't support the setting.", +"The management mode (such as fully managed or work profile) doesn't support the setting.", "The user has not taken required action to comply with the setting.", "The setting has an invalid value.", "The app required to implement the policy is not installed.", diff --git a/googleapiclient/discovery_cache/documents/apim.v1alpha.json b/googleapiclient/discovery_cache/documents/apim.v1alpha.json index 03cb5ee4a9d..88ba6e3aa2f 100644 --- a/googleapiclient/discovery_cache/documents/apim.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/apim.v1alpha.json @@ -174,6 +174,42 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"listApiObservationTags": { +"description": "ListApiObservationTags lists all extant tags on any observation in the given project.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:listApiObservationTags", +"httpMethod": "GET", +"id": "apim.projects.locations.listApiObservationTags", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}:listApiObservationTags", +"response": { +"$ref": "ListApiObservationTagsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -324,7 +360,7 @@ ] }, "list": { -"description": "ListObservationJobs gets all ObservationJobs for a given project and location", +"description": "ListObservationJobs gets all ObservationJobs for a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.list", @@ -363,6 +399,34 @@ "resources": { "apiObservations": { "methods": { +"batchEditTags": { +"description": "BatchEditTagsApiObservations adds or removes Tags for ApiObservations.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations:batchEditTags", +"httpMethod": "POST", +"id": "apim.projects.locations.observationJobs.apiObservations.batchEditTags", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/observationJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/apiObservations:batchEditTags", +"request": { +"$ref": "BatchEditTagsApiObservationsRequest" +}, +"response": { +"$ref": "BatchEditTagsApiObservationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "get": { "description": "GetApiObservation retrieves a single ApiObservation by name.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}", @@ -389,7 +453,7 @@ ] }, "list": { -"description": "ListApiObservations gets all ApiObservations for a given project and location and ObservationJob", +"description": "ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.apiObservations.list", @@ -454,7 +518,7 @@ ] }, "list": { -"description": "ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation", +"description": "ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationJobs/{observationJobsId}/apiObservations/{apiObservationsId}/apiOperations", "httpMethod": "GET", "id": "apim.projects.locations.observationJobs.apiObservations.apiOperations.list", @@ -586,7 +650,7 @@ ] }, "list": { -"description": "ListObservationSources gets all ObservationSources for a given project and location", +"description": "ListObservationSources gets all ObservationSources for a given project and location.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/observationSources", "httpMethod": "GET", "id": "apim.projects.locations.observationSources.list", @@ -751,7 +815,7 @@ } } }, -"revision": "20240701", +"revision": "20240717", "rootUrl": "https://apim.googleapis.com/", "schemas": { "ApiObservation": { @@ -856,6 +920,34 @@ }, "type": "object" }, +"BatchEditTagsApiObservationsRequest": { +"description": "Message for requesting batch edit tags for ApiObservations", +"id": "BatchEditTagsApiObservationsRequest", +"properties": { +"requests": { +"description": "Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.", +"items": { +"$ref": "EditTagsApiObservationsRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BatchEditTagsApiObservationsResponse": { +"description": "Message for response to edit Tags for ApiObservations", +"id": "BatchEditTagsApiObservationsResponse", +"properties": { +"apiObservations": { +"description": "ApiObservations that were changed", +"items": { +"$ref": "ApiObservation" +}, +"type": "array" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -868,6 +960,24 @@ "properties": {}, "type": "object" }, +"EditTagsApiObservationsRequest": { +"description": "Message for requesting edit tags for ApiObservation", +"id": "EditTagsApiObservationsRequest", +"properties": { +"apiObservationId": { +"description": "Required. Identifier of ApiObservation need to be edit tags Format example: \"apigee.googleapis.com|us-west1|443\"", +"type": "string" +}, +"tagActions": { +"description": "Required. Tag actions to be applied", +"items": { +"$ref": "TagAction" +}, +"type": "array" +} +}, +"type": "object" +}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1110,6 +1220,24 @@ }, "type": "object" }, +"ListApiObservationTagsResponse": { +"description": "Message for response to listing tags", +"id": "ListApiObservationTagsResponse", +"properties": { +"apiObservationTags": { +"description": "The tags from the specified project", +"items": { +"type": "string" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, "ListApiObservationsResponse": { "description": "Message for response to listing ApiObservations", "id": "ListApiObservationsResponse", @@ -1472,6 +1600,31 @@ } }, "type": "object" +}, +"TagAction": { +"description": "Message for edit tag action", +"id": "TagAction", +"properties": { +"action": { +"description": "Required. Action to be applied", +"enum": [ +"ACTION_UNSPECIFIED", +"ADD", +"REMOVE" +], +"enumDescriptions": [ +"Unspecified.", +"Addition of a Tag.", +"Removal of a Tag." +], +"type": "string" +}, +"tag": { +"description": "Required. Tag to be added or removed", +"type": "string" +} +}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index e998ab9e8e0..df88f3a7f3f 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -2013,7 +2013,7 @@ } } }, -"revision": "20240708", +"revision": "20240717", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -3351,6 +3351,11 @@ false "name": { "description": "The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set", "type": "string" +}, +"pullPercent": { +"description": "The percentage of pull traffic to redirect from GCR to AR when using partial redirection.", +"format": "int32", +"type": "integer" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json index 57e1457810b..b8461d2230a 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -1414,7 +1414,7 @@ } } }, -"revision": "20240704", +"revision": "20240717", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { @@ -2028,6 +2028,11 @@ false "name": { "description": "The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set", "type": "string" +}, +"pullPercent": { +"description": "The percentage of pull traffic to redirect from GCR to AR when using partial redirection.", +"format": "int32", +"type": "integer" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index 9cccf6b3651..90abe38fe59 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240703", +"revision": "20240712", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -719,7 +719,7 @@ "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"KSA R5 Controls.", +"Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1202,7 +1202,7 @@ "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"KSA R5 Controls.", +"Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index 36f40905192..3b9c27b760d 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -588,7 +588,7 @@ } } }, -"revision": "20240703", +"revision": "20240712", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -716,7 +716,7 @@ "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"KSA R5 Controls.", +"Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" @@ -1197,7 +1197,7 @@ "Information protection as per DoD IL5 requirements.", "Information protection as per DoD IL2 requirements.", "Assured Workloads for Japan Regions", -"KSA R5 Controls.", +"Assured Workloads Sovereign Controls KSA", "Assured Workloads for Regional Controls" ], "type": "string" diff --git a/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json new file mode 100644 index 00000000000..db21257c0cb --- /dev/null +++ b/googleapiclient/discovery_cache/documents/authorizedbuyersmarketplace.v1alpha.json @@ -0,0 +1,3513 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/authorized-buyers-marketplace": { +"description": "See, create, edit, and delete your Authorized Buyers Marketplace entities." +} +} +} +}, +"basePath": "", +"baseUrl": "https://authorizedbuyersmarketplace.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Authorized Buyers Marketplace", +"description": "The Authorized Buyers Marketplace API lets buyers programmatically discover inventory; propose, retrieve and negotiate deals with publishers.", +"discoveryVersion": "v1", +"documentationLink": "https://developers.google.com/authorized-buyers/apis/marketplace/reference/rest/", +"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": "authorizedbuyersmarketplace:v1alpha", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://authorizedbuyersmarketplace.mtls.googleapis.com/", +"name": "authorizedbuyersmarketplace", +"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": { +"bidders": { +"resources": { +"auctionPackages": { +"methods": { +"list": { +"description": "List the auction packages. Buyers can use the URL path \"/v1alpha/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients.", +"flatPath": "v1alpha/bidders/{biddersId}/auctionPackages", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.bidders.auctionPackages.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.", +"location": "path", +"pattern": "^bidders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/auctionPackages", +"response": { +"$ref": "ListAuctionPackagesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +}, +"finalizedDeals": { +"methods": { +"list": { +"description": "Lists finalized deals. Use the URL path \"/v1alpha/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.", +"flatPath": "v1alpha/bidders/{biddersId}/finalizedDeals", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.bidders.finalizedDeals.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from ListFinalizedDealsResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.", +"location": "path", +"pattern": "^bidders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/finalizedDeals", +"response": { +"$ref": "ListFinalizedDealsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +} +} +}, +"buyers": { +"resources": { +"auctionPackages": { +"methods": { +"get": { +"description": "Gets an auction package given its name.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "List the auction packages. Buyers can use the URL path \"/v1alpha/buyers/{accountId}/auctionPackages\" to list auction packages for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/auctionPackages\" to list auction packages for the bidder, its media planners, its buyers, and all their clients.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. Max allowed page size is 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned. ListAuctionPackagesResponse.nextPageToken", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`.", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/auctionPackages", +"response": { +"$ref": "ListAuctionPackagesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"subscribe": { +"description": "Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribe", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribe", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:subscribe", +"request": { +"$ref": "SubscribeAuctionPackageRequest" +}, +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"subscribeClients": { +"description": "Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:subscribeClients", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.subscribeClients", +"parameterOrder": [ +"auctionPackage" +], +"parameters": { +"auctionPackage": { +"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+auctionPackage}:subscribeClients", +"request": { +"$ref": "SubscribeClientsRequest" +}, +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"unsubscribe": { +"description": "Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribe", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribe", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:unsubscribe", +"request": { +"$ref": "UnsubscribeAuctionPackageRequest" +}, +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"unsubscribeClients": { +"description": "Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.", +"flatPath": "v1alpha/buyers/{buyersId}/auctionPackages/{auctionPackagesId}:unsubscribeClients", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.auctionPackages.unsubscribeClients", +"parameterOrder": [ +"auctionPackage" +], +"parameters": { +"auctionPackage": { +"description": "Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}`", +"location": "path", +"pattern": "^buyers/[^/]+/auctionPackages/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+auctionPackage}:unsubscribeClients", +"request": { +"$ref": "UnsubscribeClientsRequest" +}, +"response": { +"$ref": "AuctionPackage" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +}, +"clients": { +"methods": { +"activate": { +"description": "Activates an existing client. The state of the client will be updated to \"ACTIVE\". This method has no effect if the client is already in \"ACTIVE\" state.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}:activate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.activate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:activate", +"request": { +"$ref": "ActivateClientRequest" +}, +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"create": { +"description": "Creates a new client.", +"flatPath": "v1alpha/buyers/{buyersId}/clients", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the buyer. Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/clients", +"request": { +"$ref": "Client" +}, +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"deactivate": { +"description": "Deactivates an existing client. The state of the client will be updated to \"INACTIVE\". This method has no effect if the client is already in \"INACTIVE\" state.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}:deactivate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.deactivate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:deactivate", +"request": { +"$ref": "DeactivateClientRequest" +}, +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a client with a given resource name.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.clients.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{accountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists all the clients for the current buyer.", +"flatPath": "v1alpha/buyers/{buyersId}/clients", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.clients.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is \"1234\", the value of this field should be `partnerClientId = \"1234\"`, in order to get only the client whose partnerClientId is \"1234\" in the response.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. If left blank, a default page size of 500 will be applied.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the buyer. Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/clients", +"response": { +"$ref": "ListClientsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"patch": { +"description": "Updates an existing client.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}", +"httpMethod": "PATCH", +"id": "authorizedbuyersmarketplace.buyers.clients.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Client" +}, +"response": { +"$ref": "Client" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +}, +"resources": { +"users": { +"methods": { +"activate": { +"description": "Activates an existing client user. The state of the client user will be updated from \"INACTIVE\" to \"ACTIVE\". This method has no effect if the client user is already in \"ACTIVE\" state. An error will be returned if the client user to activate is still in \"INVITED\" state.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:activate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.users.activate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:activate", +"request": { +"$ref": "ActivateClientUserRequest" +}, +"response": { +"$ref": "ClientUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"create": { +"description": "Creates a new client user in \"INVITED\" state. An email invitation will be sent to the new user, once accepted the user will become active.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.users.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/users", +"request": { +"$ref": "ClientUser" +}, +"response": { +"$ref": "ClientUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"deactivate": { +"description": "Deactivates an existing client user. The state of the client user will be updated from \"ACTIVE\" to \"INACTIVE\". This method has no effect if the client user is already in \"INACTIVE\" state. An error will be returned if the client user to deactivate is still in \"INVITED\" state.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}:deactivate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.clients.users.deactivate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:deactivate", +"request": { +"$ref": "DeactivateClientUserRequest" +}, +"response": { +"$ref": "ClientUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"delete": { +"description": "Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", +"httpMethod": "DELETE", +"id": "authorizedbuyersmarketplace.buyers.clients.users.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Retrieves an existing client user.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users/{usersId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.clients.users.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+/users/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "ClientUser" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists all client users for a specified client.", +"flatPath": "v1alpha/buyers/{buyersId}/clients/{clientsId}/users", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.clients.users.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Requested page size. If left blank, a default page size of 500 will be applied.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", +"location": "path", +"pattern": "^buyers/[^/]+/clients/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/users", +"response": { +"$ref": "ListClientUsersResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +} +} +}, +"dataSegments": { +"methods": { +"activate": { +"description": "Activates a data segment.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:activate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.activate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of data segment to activate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"location": "path", +"pattern": "^buyers/[^/]+/dataSegments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:activate", +"request": { +"$ref": "ActivateDataSegmentRequest" +}, +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"create": { +"description": "Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where this data segment will be created. Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/dataSegments", +"request": { +"$ref": "DataSegment" +}, +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"deactivate": { +"description": "Deactivates a data segment.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}:deactivate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.deactivate", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of data segment to deactivate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"location": "path", +"pattern": "^buyers/[^/]+/dataSegments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:deactivate", +"request": { +"$ref": "DeactivateDataSegmentRequest" +}, +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a data segment given its name.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of data segment to get. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"location": "path", +"pattern": "^buyers/[^/]+/dataSegments/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "List the data segments owned by a curator.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Name of the parent buyer that can access the data segment. Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/dataSegments", +"response": { +"$ref": "ListDataSegmentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"patch": { +"description": "Updates a data segment.", +"flatPath": "v1alpha/buyers/{buyersId}/dataSegments/{dataSegmentsId}", +"httpMethod": "PATCH", +"id": "authorizedbuyersmarketplace.buyers.dataSegments.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"location": "path", +"pattern": "^buyers/[^/]+/dataSegments/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "DataSegment" +}, +"response": { +"$ref": "DataSegment" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +}, +"finalizedDeals": { +"methods": { +"addCreative": { +"description": "Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:addCreative", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.addCreative", +"parameterOrder": [ +"deal" +], +"parameters": { +"deal": { +"description": "Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+deal}:addCreative", +"request": { +"$ref": "AddCreativeRequest" +}, +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a finalized deal given its name.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists finalized deals. Use the URL path \"/v1alpha/buyers/{accountId}/finalizedDeals\" to list finalized deals for the current buyer and its clients. Bidders can use the URL path \"/v1alpha/bidders/{accountId}/finalizedDeals\" to list finalized deals for the bidder, its buyers and all their clients.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from ListFinalizedDealsResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`.", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/finalizedDeals", +"response": { +"$ref": "ListFinalizedDealsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"pause": { +"description": "Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:pause", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.pause", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:pause", +"request": { +"$ref": "PauseFinalizedDealRequest" +}, +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"resume": { +"description": "Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:resume", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.resume", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:resume", +"request": { +"$ref": "ResumeFinalizedDealRequest" +}, +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"setReadyToServe": { +"description": "Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.", +"flatPath": "v1alpha/buyers/{buyersId}/finalizedDeals/{finalizedDealsId}:setReadyToServe", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.finalizedDeals.setReadyToServe", +"parameterOrder": [ +"deal" +], +"parameters": { +"deal": { +"description": "Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}`", +"location": "path", +"pattern": "^buyers/[^/]+/finalizedDeals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+deal}:setReadyToServe", +"request": { +"$ref": "SetReadyToServeRequest" +}, +"response": { +"$ref": "FinalizedDeal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +}, +"proposals": { +"methods": { +"accept": { +"description": "Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:accept", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.accept", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:accept", +"request": { +"$ref": "AcceptProposalRequest" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"addNote": { +"description": "Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:addNote", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.addNote", +"parameterOrder": [ +"proposal" +], +"parameters": { +"proposal": { +"description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+proposal}:addNote", +"request": { +"$ref": "AddNoteRequest" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"cancelNegotiation": { +"description": "Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}:cancelNegotiation", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.cancelNegotiation", +"parameterOrder": [ +"proposal" +], +"parameters": { +"proposal": { +"description": "Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+proposal}:cancelNegotiation", +"request": { +"$ref": "CancelNegotiationRequest" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a proposal using its resource name. The proposal is returned at the latest revision.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.proposals.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}`", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.proposals.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from ListProposalsResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent that owns the collection of proposals Format: `buyers/{accountId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/proposals", +"response": { +"$ref": "ListProposalsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"patch": { +"description": "Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}", +"httpMethod": "PATCH", +"id": "authorizedbuyersmarketplace.buyers.proposals.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Proposal" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"sendRfp": { +"description": "Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals:sendRfp", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.sendRfp", +"parameterOrder": [ +"buyer" +], +"parameters": { +"buyer": { +"description": "Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`.", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+buyer}/proposals:sendRfp", +"request": { +"$ref": "SendRfpRequest" +}, +"response": { +"$ref": "Proposal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +}, +"resources": { +"deals": { +"methods": { +"batchUpdate": { +"description": "Batch updates multiple deals in the same proposal.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals:batchUpdate", +"httpMethod": "POST", +"id": "authorizedbuyersmarketplace.buyers.proposals.deals.batchUpdate", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/deals:batchUpdate", +"request": { +"$ref": "BatchUpdateDealsRequest" +}, +"response": { +"$ref": "BatchUpdateDealsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"get": { +"description": "Gets a deal given its name. The deal is returned at its head revision.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.proposals.deals.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "Deal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.proposals.deals.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from ListDealsResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/deals", +"response": { +"$ref": "ListDealsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"patch": { +"description": "Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.", +"flatPath": "v1alpha/buyers/{buyersId}/proposals/{proposalsId}/deals/{dealsId}", +"httpMethod": "PATCH", +"id": "authorizedbuyersmarketplace.buyers.proposals.deals.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", +"location": "path", +"pattern": "^buyers/[^/]+/proposals/[^/]+/deals/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "Deal" +}, +"response": { +"$ref": "Deal" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +} +} +}, +"publisherProfiles": { +"methods": { +"get": { +"description": "Gets the requested publisher profile by name.", +"flatPath": "v1alpha/buyers/{buyersId}/publisherProfiles/{publisherProfilesId}", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.publisherProfiles.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}`", +"location": "path", +"pattern": "^buyers/[^/]+/publisherProfiles/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "PublisherProfile" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +}, +"list": { +"description": "Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.", +"flatPath": "v1alpha/buyers/{buyersId}/publisherProfiles", +"httpMethod": "GET", +"id": "authorizedbuyersmarketplace.buyers.publisherProfiles.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The page token as returned from a previous ListPublisherProfilesResponse.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}`", +"location": "path", +"pattern": "^buyers/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/publisherProfiles", +"response": { +"$ref": "ListPublisherProfilesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/authorized-buyers-marketplace" +] +} +} +} +} +} +}, +"revision": "20240718", +"rootUrl": "https://authorizedbuyersmarketplace.googleapis.com/", +"schemas": { +"AcceptProposalRequest": { +"description": "Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any.", +"id": "AcceptProposalRequest", +"properties": { +"proposalRevision": { +"description": "The last known client revision number of the proposal.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"ActivateClientRequest": { +"description": "Request message for activating a client.", +"id": "ActivateClientRequest", +"properties": {}, +"type": "object" +}, +"ActivateClientUserRequest": { +"description": "Request message for activating a client user.", +"id": "ActivateClientUserRequest", +"properties": {}, +"type": "object" +}, +"ActivateDataSegmentRequest": { +"description": "Request message for activating a data segment", +"id": "ActivateDataSegmentRequest", +"properties": {}, +"type": "object" +}, +"AdSize": { +"description": "Represents size of a single ad slot, or a creative.", +"id": "AdSize", +"properties": { +"height": { +"description": "The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", +"format": "int64", +"type": "string" +}, +"type": { +"description": "The type of the ad slot size.", +"enum": [ +"TYPE_UNSPECIFIED", +"PIXEL", +"INTERSTITIAL", +"NATIVE", +"FLUID" +], +"enumDescriptions": [ +"A placeholder for an undefined size type.", +"Ad slot with size specified by height and width in pixels.", +"Special size to describe an interstitial ad slot.", +"Native (mobile) ads rendered by the publisher.", +"Fluid size (responsive size) can be resized automatically with the change of outside environment." +], +"type": "string" +}, +"width": { +"description": "The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"AddCreativeRequest": { +"description": "Request message for adding creative to be used in the bidding process for the finalized deal.", +"id": "AddCreativeRequest", +"properties": { +"creative": { +"description": "Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.", +"type": "string" +} +}, +"type": "object" +}, +"AddNoteRequest": { +"description": "Request to add a note.", +"id": "AddNoteRequest", +"properties": { +"note": { +"$ref": "Note", +"description": "The note to add." +} +}, +"type": "object" +}, +"AuctionPackage": { +"description": "Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.", +"id": "AuctionPackage", +"properties": { +"createTime": { +"description": "Output only. Time the auction package was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creator": { +"description": "Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. A description of the auction package.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "The display_name assigned to the auction package.", +"type": "string" +}, +"eligibleSeatIds": { +"description": "Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"name": { +"description": "Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.", +"type": "string" +}, +"subscribedBuyers": { +"description": "Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"subscribedClients": { +"description": "Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"subscribedMediaPlanners": { +"description": "Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.", +"items": { +"$ref": "MediaPlanner" +}, +"readOnly": true, +"type": "array" +}, +"updateTime": { +"description": "Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BatchUpdateDealsRequest": { +"description": "Request message for batch updating deals.", +"id": "BatchUpdateDealsRequest", +"properties": { +"requests": { +"description": "Required. List of request messages to update deals.", +"items": { +"$ref": "UpdateDealRequest" +}, +"type": "array" +} +}, +"type": "object" +}, +"BatchUpdateDealsResponse": { +"description": "Response message for batch updating deals.", +"id": "BatchUpdateDealsResponse", +"properties": { +"deals": { +"description": "Deals updated.", +"items": { +"$ref": "Deal" +}, +"type": "array" +} +}, +"type": "object" +}, +"CancelNegotiationRequest": { +"description": "Request to cancel an ongoing negotiation.", +"id": "CancelNegotiationRequest", +"properties": {}, +"type": "object" +}, +"Client": { +"description": "A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.", +"id": "Client", +"properties": { +"displayName": { +"description": "Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`", +"readOnly": true, +"type": "string" +}, +"partnerClientId": { +"description": "Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.", +"type": "string" +}, +"role": { +"description": "Required. The role assigned to the client. Each role implies a set of permissions granted to the client.", +"enum": [ +"CLIENT_ROLE_UNSPECIFIED", +"CLIENT_DEAL_VIEWER", +"CLIENT_DEAL_NEGOTIATOR", +"CLIENT_DEAL_APPROVER" +], +"enumDescriptions": [ +"A placeholder for an undefined client role. This value should never be specified in user input for create or update method, otherwise an error will be returned.", +"Users associated with this client role can only view proposals and deals in the Marketplace UI. They cannot negotiate or approve proposals and deals sent from publishers or send RFP to publishers.", +"Users associated with this client role can view and negotiate on the proposals and deals in the Marketplace UI sent from publishers and send RFP to publishers, but cannot approve the proposals and deals by themselves. The buyer can approve the proposals and deals on behalf of the client.", +"Users associated with this client role can view, negotiate and approve proposals and deals in the Marketplace UI and send RFP to publishers." +], +"type": "string" +}, +"sellerVisible": { +"description": "Whether the client will be visible to sellers.", +"type": "boolean" +}, +"state": { +"description": "Output only. The state of the client.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"INACTIVE" +], +"enumDescriptions": [ +"A placeholder for an undefined client state. Should not be used.", +"A client that is currently active and allowed to access the Authorized Buyers UI.", +"A client that is currently inactive and not allowed to access the Authorized Buyers UI." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"ClientUser": { +"description": "A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.", +"id": "ClientUser", +"properties": { +"email": { +"description": "Required. The client user's email address that has to be unique across all users for the same client.", +"type": "string" +}, +"name": { +"description": "Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. The state of the client user.", +"enum": [ +"STATE_UNSPECIFIED", +"INVITED", +"ACTIVE", +"INACTIVE" +], +"enumDescriptions": [ +"A placeholder for an undefined user state.", +"A user who was created but hasn't accepted the invitation yet, not allowed to access the Authorized Buyers UI.", +"A user that is currently active and allowed to access the Authorized Buyers UI.", +"A user that is currently inactive and not allowed to access the Authorized Buyers UI." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Contact": { +"description": "Contains information on how a buyer or seller can be reached.", +"id": "Contact", +"properties": { +"displayName": { +"description": "The display_name of the contact.", +"type": "string" +}, +"email": { +"description": "Email address for the contact.", +"type": "string" +} +}, +"type": "object" +}, +"CreativeRequirements": { +"description": "Message captures data about the creatives in the deal.", +"id": "CreativeRequirements", +"properties": { +"creativeFormat": { +"description": "Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.", +"enum": [ +"CREATIVE_FORMAT_UNSPECIFIED", +"DISPLAY", +"VIDEO", +"AUDIO" +], +"enumDescriptions": [ +"A placeholder for an unspecified creative format.", +"Banner creatives such as image or HTML5 assets.", +"Video creatives that can be played in a video player.", +"Audio creatives that can play during audio content or point to a third party ad server." +], +"readOnly": true, +"type": "string" +}, +"creativePreApprovalPolicy": { +"description": "Output only. Specifies the creative pre-approval policy.", +"enum": [ +"CREATIVE_PRE_APPROVAL_POLICY_UNSPECIFIED", +"SELLER_PRE_APPROVAL_REQUIRED", +"SELLER_PRE_APPROVAL_NOT_REQUIRED" +], +"enumDescriptions": [ +"A placeholder for an undefined creative pre-approval policy.", +"The seller needs to approve each creative before it can serve.", +"The seller does not need to approve each creative before it can serve." +], +"readOnly": true, +"type": "string" +}, +"creativeSafeFrameCompatibility": { +"description": "Output only. Specifies whether the creative is safeFrame compatible.", +"enum": [ +"CREATIVE_SAFE_FRAME_COMPATIBILITY_UNSPECIFIED", +"COMPATIBLE", +"INCOMPATIBLE" +], +"enumDescriptions": [ +"A placeholder for an undefined creative safe-frame compatibility.", +"The creatives need to be compatible with the safe frame option.", +"The creatives can be incompatible with the safe frame option." +], +"readOnly": true, +"type": "string" +}, +"maxAdDurationMs": { +"description": "Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"programmaticCreativeSource": { +"description": "Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.", +"enum": [ +"PROGRAMMATIC_CREATIVE_SOURCE_UNSPECIFIED", +"ADVERTISER", +"PUBLISHER" +], +"enumDescriptions": [ +"A placeholder for an undefined programmatic creative source.", +"The advertiser provides the creatives.", +"The publisher provides the creatives to be served." +], +"readOnly": true, +"type": "string" +}, +"skippableAdType": { +"description": "Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.", +"enum": [ +"SKIPPABLE_AD_TYPE_UNSPECIFIED", +"SKIPPABLE", +"INSTREAM_SELECT", +"NOT_SKIPPABLE", +"ANY" +], +"enumDescriptions": [ +"A placeholder for an unspecified skippable ad type.", +"Video ad that can be skipped after 5 seconds. This value will appear in RTB bid requests as SkippableBidRequestType::REQUIRE_SKIPPABLE.", +"Video ad that can be skipped after 5 seconds, and is counted as engaged view after 30 seconds. The creative is hosted on YouTube only, and viewcount of the YouTube video increments after the engaged view. This value will appear in RTB bid requests as SkippableBidRequestType::REQUIRE_SKIPPABLE.", +"This video ad is not skippable. This value will appear in RTB bid requests as SkippableBidRequestType::BLOCK_SKIPPABLE.", +"This video ad can be skipped after 5 seconds or not-skippable. This value will appear in RTB bid requests as SkippableBidRequestType::ALLOW_SKIPPABLE." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"CriteriaTargeting": { +"description": "Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax.", +"id": "CriteriaTargeting", +"properties": { +"excludedCriteriaIds": { +"description": "A list of numeric IDs to be excluded.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"targetedCriteriaIds": { +"description": "A list of numeric IDs to be included.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"DataSegment": { +"description": "Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.", +"id": "DataSegment", +"properties": { +"cpmFee": { +"$ref": "Money", +"description": "Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package." +}, +"createTime": { +"description": "Output only. Time the data segment was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`", +"type": "string" +}, +"state": { +"description": "Output only. The state of the data segment.", +"enum": [ +"STATE_UNSPECIFIED", +"ACTIVE", +"INACTIVE" +], +"enumDescriptions": [ +"Default value.", +"The data segment is active.", +"The data segment is inactive." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. Time the data segment was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DayPart": { +"description": "Defines targeting for a period of time on a specific week day.", +"id": "DayPart", +"properties": { +"dayOfWeek": { +"description": "Day of week for the period.", +"enum": [ +"DAY_OF_WEEK_UNSPECIFIED", +"MONDAY", +"TUESDAY", +"WEDNESDAY", +"THURSDAY", +"FRIDAY", +"SATURDAY", +"SUNDAY" +], +"enumDescriptions": [ +"The day of the week is unspecified.", +"Monday", +"Tuesday", +"Wednesday", +"Thursday", +"Friday", +"Saturday", +"Sunday" +], +"type": "string" +}, +"endTime": { +"$ref": "TimeOfDay", +"description": "Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored." +}, +"startTime": { +"$ref": "TimeOfDay", +"description": "Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored." +} +}, +"type": "object" +}, +"DayPartTargeting": { +"description": "Represents Daypart targeting.", +"id": "DayPartTargeting", +"properties": { +"dayParts": { +"description": "The targeted weekdays and times", +"items": { +"$ref": "DayPart" +}, +"type": "array" +}, +"timeZoneType": { +"description": "The time zone type of the day parts", +"enum": [ +"TIME_ZONE_TYPE_UNSPECIFIED", +"SELLER", +"USER" +], +"enumDescriptions": [ +"Default value. This field is unused.", +"The publisher's time zone", +"The user's time zone" +], +"type": "string" +} +}, +"type": "object" +}, +"DeactivateClientRequest": { +"description": "Request message for disabling a client.", +"id": "DeactivateClientRequest", +"properties": {}, +"type": "object" +}, +"DeactivateClientUserRequest": { +"description": "Request message for deactivating a client user.", +"id": "DeactivateClientUserRequest", +"properties": {}, +"type": "object" +}, +"DeactivateDataSegmentRequest": { +"description": "Request message for deactivating a data segment", +"id": "DeactivateDataSegmentRequest", +"properties": {}, +"type": "object" +}, +"Deal": { +"description": "A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.", +"id": "Deal", +"properties": { +"billedBuyer": { +"description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"buyer": { +"description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"client": { +"description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. The time of the deal creation.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creativeRequirements": { +"$ref": "CreativeRequirements", +"description": "Output only. Metadata about the creatives of this deal.", +"readOnly": true +}, +"dealType": { +"description": "Output only. Type of deal.", +"enum": [ +"DEAL_TYPE_UNSPECIFIED", +"PREFERRED_DEAL", +"PRIVATE_AUCTION", +"PROGRAMMATIC_GUARANTEED" +], +"enumDescriptions": [ +"Default, unspecified deal type.", +"Preferred deals.", +"Private auction deals.", +"Programmatic guaranteed deals." +], +"readOnly": true, +"type": "string" +}, +"deliveryControl": { +"$ref": "DeliveryControl", +"description": "Output only. Specifies the pacing set by the publisher.", +"readOnly": true +}, +"description": { +"description": "Output only. Free text description for the deal terms.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.", +"readOnly": true, +"type": "string" +}, +"eligibleSeatIds": { +"description": "Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"estimatedGrossSpend": { +"$ref": "Money", +"description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly." +}, +"flightEndTime": { +"description": "Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.", +"format": "google-datetime", +"type": "string" +}, +"flightStartTime": { +"description": "Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.", +"format": "google-datetime", +"type": "string" +}, +"mediaPlanner": { +"$ref": "MediaPlanner", +"description": "Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).", +"readOnly": true +}, +"name": { +"description": "Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}", +"type": "string" +}, +"preferredDealTerms": { +"$ref": "PreferredDealTerms", +"description": "The terms for preferred deals." +}, +"privateAuctionTerms": { +"$ref": "PrivateAuctionTerms", +"description": "The terms for private auction deals." +}, +"programmaticGuaranteedTerms": { +"$ref": "ProgrammaticGuaranteedTerms", +"description": "The terms for programmatic guaranteed deals." +}, +"proposalRevision": { +"description": "Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"publisherProfile": { +"description": "Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`", +"type": "string" +}, +"sellerTimeZone": { +"$ref": "TimeZone", +"description": "Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.", +"readOnly": true +}, +"targeting": { +"$ref": "MarketplaceTargeting", +"description": "Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized." +}, +"updateTime": { +"description": "Output only. The time when the deal was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"DealPausingInfo": { +"description": "Information related to deal pausing.", +"id": "DealPausingInfo", +"properties": { +"pauseReason": { +"description": "The reason for the pausing of the deal; empty for active deals.", +"type": "string" +}, +"pauseRole": { +"description": "The party that first paused the deal; unspecified for active deals.", +"enum": [ +"BUYER_SELLER_ROLE_UNSPECIFIED", +"BUYER", +"SELLER" +], +"enumDescriptions": [ +"A placeholder for an undefined buyer/seller role.", +"Specifies the role as buyer.", +"Specifies the role as seller." +], +"type": "string" +}, +"pausingConsented": { +"description": "Whether pausing is consented between buyer and seller for the deal.", +"type": "boolean" +} +}, +"type": "object" +}, +"DeliveryControl": { +"description": "Message contains details about how the deal will be paced.", +"id": "DeliveryControl", +"properties": { +"companionDeliveryType": { +"description": "Output only. Specifies roadblocking in a main companion lineitem.", +"enum": [ +"COMPANION_DELIVERY_TYPE_UNSPECIFIED", +"DELIVERY_OPTIONAL", +"DELIVERY_AT_LEAST_ONE", +"DELIVERY_ALL" +], +"enumDescriptions": [ +"A placeholder for an unspecified companion delivery type.", +"Companions are not required to serve a creative set. The creative set can serve an inventory that has zero or more matching companions.", +"At least one companion must be served in order for the creative set to be used.", +"All companions in the set must be served in order for the creative set to be used. This can still serve to inventory that has more companions than can be filled." +], +"readOnly": true, +"type": "string" +}, +"creativeRotationType": { +"description": "Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.", +"enum": [ +"CREATIVE_ROTATION_TYPE_UNSPECIFIED", +"ROTATION_EVEN", +"ROTATION_OPTIMIZED", +"ROTATION_MANUAL", +"ROTATION_SEQUENTIAL" +], +"enumDescriptions": [ +"Creatives are displayed roughly the same number of times over the duration of the deal.", +"Creatives are displayed roughly the same number of times over the duration of the deal.", +"Creatives are served roughly proportionally to their performance.", +"Creatives are served roughly proportionally to their weights.", +"Creatives are served exactly in sequential order, also known as Storyboarding." +], +"readOnly": true, +"type": "string" +}, +"deliveryRateType": { +"description": "Output only. Specifies how the impression delivery will be paced.", +"enum": [ +"DELIVERY_RATE_TYPE_UNSPECIFIED", +"EVENLY", +"FRONT_LOADED", +"AS_FAST_AS_POSSIBLE" +], +"enumDescriptions": [ +"A placeholder for an undefined delivery rate type.", +"Impressions are served uniformly over the life of the deal.", +"Impressions are served front-loaded.", +"Impressions are served as fast as possible." +], +"readOnly": true, +"type": "string" +}, +"frequencyCap": { +"description": "Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.", +"items": { +"$ref": "FrequencyCap" +}, +"readOnly": true, +"type": "array" +}, +"roadblockingType": { +"description": "Output only. Specifies the roadblocking type in display creatives.", +"enum": [ +"ROADBLOCKING_TYPE_UNSPECIFIED", +"ONLY_ONE", +"ONE_OR_MORE", +"AS_MANY_AS_POSSIBLE", +"ALL_ROADBLOCK", +"CREATIVE_SET" +], +"enumDescriptions": [ +"A placeholder for an unspecified roadblocking type.", +"Only one creative from a deal can serve per ad request. https://support.google.com/admanager/answer/177277.", +"Any number of creatives from a deal can serve together per ad request.", +"As many creatives from a deal as can fit on a page will serve. This could mean anywhere from one to all of a deal's creatives given the size constraints of ad slots on a page.", +"All or none of the creatives from a deal will serve.", +"A main/companion creative set roadblocking type." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"Empty": { +"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", +"id": "Empty", +"properties": {}, +"type": "object" +}, +"FinalizedDeal": { +"description": "A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.", +"id": "FinalizedDeal", +"properties": { +"deal": { +"$ref": "Deal", +"description": "A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated." +}, +"dealPausingInfo": { +"$ref": "DealPausingInfo", +"description": "Information related to deal pausing for the deal." +}, +"dealServingStatus": { +"description": "Serving status of the deal.", +"enum": [ +"DEAL_SERVING_STATUS_UNSPECIFIED", +"ACTIVE", +"ENDED", +"PAUSED_BY_BUYER", +"PAUSED_BY_SELLER" +], +"enumDescriptions": [ +"Unspecified.", +"The deal is actively serving or ready to serve when the start date is reached.", +"The deal serving has ended.", +"The deal serving is paused by buyer.", +"The deal serving is paused by seller." +], +"type": "string" +}, +"name": { +"description": "The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`", +"type": "string" +}, +"readyToServe": { +"description": "Whether the Programmatic Guaranteed deal is ready for serving.", +"type": "boolean" +}, +"rtbMetrics": { +"$ref": "RtbMetrics", +"description": "Real-time bidding metrics for this deal." +} +}, +"type": "object" +}, +"FirstPartyMobileApplicationTargeting": { +"description": "Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded.", +"id": "FirstPartyMobileApplicationTargeting", +"properties": { +"excludedAppIds": { +"description": "A list of application IDs to be excluded.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetedAppIds": { +"description": "A list of application IDs to be included.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"FrequencyCap": { +"description": "Message contains details about publisher-set frequency caps of the delivery.", +"id": "FrequencyCap", +"properties": { +"maxImpressions": { +"description": "The maximum number of impressions that can be served to a user within the specified time period.", +"format": "int32", +"type": "integer" +}, +"timeUnitType": { +"description": "The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.", +"enum": [ +"TIME_UNIT_TYPE_UNSPECIFIED", +"MINUTE", +"HOUR", +"DAY", +"WEEK", +"MONTH", +"LIFETIME", +"POD", +"STREAM" +], +"enumDescriptions": [ +"A placeholder for an undefined time unit type. This just indicates the variable with this value hasn't been initialized.", +"Minute unit.", +"Hour unit.", +"Day unit.", +"Week unit.", +"Month unit.", +"Lifecycle/Lifetime unit.", +"Pod unit.", +"Stream unit." +], +"type": "string" +}, +"timeUnitsCount": { +"description": "The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"InventorySizeTargeting": { +"description": "Represents the size of an ad unit that can be targeted on a bid request.", +"id": "InventorySizeTargeting", +"properties": { +"excludedInventorySizes": { +"description": "A list of inventory sizes to be excluded.", +"items": { +"$ref": "AdSize" +}, +"type": "array" +}, +"targetedInventorySizes": { +"description": "A list of inventory sizes to be included.", +"items": { +"$ref": "AdSize" +}, +"type": "array" +} +}, +"type": "object" +}, +"InventoryTypeTargeting": { +"description": "Targeting of the inventory types a bid request can originate from.", +"id": "InventoryTypeTargeting", +"properties": { +"inventoryTypes": { +"description": "The list of targeted inventory types for the bid request.", +"items": { +"enum": [ +"INVENTORY_TYPE_UNSPECIFIED", +"BROWSER", +"MOBILE_APP", +"VIDEO_PLAYER" +], +"enumDescriptions": [ +"Unspecified inventory type", +"Desktop or mobile web browser excluding ads inside a video player", +"Mobile apps other than video players and web browsers", +"Instream video and audio" +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListAuctionPackagesResponse": { +"description": "Response message for listing auction packages.", +"id": "ListAuctionPackagesResponse", +"properties": { +"auctionPackages": { +"description": "The list of auction packages.", +"items": { +"$ref": "AuctionPackage" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListClientUsersResponse": { +"description": "Response message for the list method.", +"id": "ListClientUsersResponse", +"properties": { +"clientUsers": { +"description": "The returned list of client users.", +"items": { +"$ref": "ClientUser" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListClientsResponse": { +"description": "Response message for the list method.", +"id": "ListClientsResponse", +"properties": { +"clients": { +"description": "The returned list of clients.", +"items": { +"$ref": "Client" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListDataSegmentsResponse": { +"description": "Response message for listing data segments.", +"id": "ListDataSegmentsResponse", +"properties": { +"dataSegments": { +"description": "The list of data segments.", +"items": { +"$ref": "DataSegment" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListDealsResponse": { +"description": "Response message for listing deals in a proposal.", +"id": "ListDealsResponse", +"properties": { +"deals": { +"description": "The list of deals.", +"items": { +"$ref": "Deal" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to fetch the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListFinalizedDealsResponse": { +"description": "Response message for listing finalized deals.", +"id": "ListFinalizedDealsResponse", +"properties": { +"finalizedDeals": { +"description": "The list of finalized deals.", +"items": { +"$ref": "FinalizedDeal" +}, +"type": "array" +}, +"nextPageToken": { +"description": "Token to fetch the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"ListProposalsResponse": { +"description": "Response message for listing proposals.", +"id": "ListProposalsResponse", +"properties": { +"nextPageToken": { +"description": "Continuation token for fetching the next page of results.", +"type": "string" +}, +"proposals": { +"description": "The list of proposals.", +"items": { +"$ref": "Proposal" +}, +"type": "array" +} +}, +"type": "object" +}, +"ListPublisherProfilesResponse": { +"description": "Response message for profiles visible to the buyer.", +"id": "ListPublisherProfilesResponse", +"properties": { +"nextPageToken": { +"description": "Token to fetch the next page of results.", +"type": "string" +}, +"publisherProfiles": { +"description": "The list of matching publisher profiles.", +"items": { +"$ref": "PublisherProfile" +}, +"type": "array" +} +}, +"type": "object" +}, +"MarketplaceTargeting": { +"description": "Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise.", +"id": "MarketplaceTargeting", +"properties": { +"daypartTargeting": { +"$ref": "DayPartTargeting", +"description": "Daypart targeting information." +}, +"excludedSensitiveCategoryIds": { +"description": "Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.", +"items": { +"format": "int64", +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"geoTargeting": { +"$ref": "CriteriaTargeting", +"description": "Output only. Geo criteria IDs to be included/excluded.", +"readOnly": true +}, +"inventorySizeTargeting": { +"$ref": "InventorySizeTargeting", +"description": "Output only. Inventory sizes to be included/excluded.", +"readOnly": true +}, +"inventoryTypeTargeting": { +"$ref": "InventoryTypeTargeting", +"description": "Output only. Inventory type targeting information.", +"readOnly": true +}, +"placementTargeting": { +"$ref": "PlacementTargeting", +"description": "Output only. Placement targeting information, for example, URL, mobile applications.", +"readOnly": true +}, +"technologyTargeting": { +"$ref": "TechnologyTargeting", +"description": "Output only. Technology targeting information, for example, operating system, device category.", +"readOnly": true +}, +"userListTargeting": { +"$ref": "CriteriaTargeting", +"description": "Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader." +}, +"verticalTargeting": { +"$ref": "CriteriaTargeting", +"description": "Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals", +"readOnly": true +}, +"videoTargeting": { +"$ref": "VideoTargeting", +"description": "Output only. Video targeting information.", +"readOnly": true +} +}, +"type": "object" +}, +"MediaPlanner": { +"description": "Describes a single Media Planner account.", +"id": "MediaPlanner", +"properties": { +"accountId": { +"description": "Output only. Account ID of the media planner.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"MobileApplicationTargeting": { +"description": "Mobile application targeting settings.", +"id": "MobileApplicationTargeting", +"properties": { +"firstPartyTargeting": { +"$ref": "FirstPartyMobileApplicationTargeting", +"description": "Publisher owned apps to be targeted or excluded by the publisher to display the ads in." +} +}, +"type": "object" +}, +"Money": { +"description": "Represents an amount of money with its currency type.", +"id": "Money", +"properties": { +"currencyCode": { +"description": "The three-letter currency code defined in ISO 4217.", +"type": "string" +}, +"nanos": { +"description": "Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", +"format": "int32", +"type": "integer" +}, +"units": { +"description": "The whole units of the amount. For example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"Note": { +"description": "A text note attached to the proposal to facilitate the communication between buyers and sellers.", +"id": "Note", +"properties": { +"createTime": { +"description": "Output only. When this note was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"creatorRole": { +"description": "Output only. The role who created the note.", +"enum": [ +"BUYER_SELLER_ROLE_UNSPECIFIED", +"BUYER", +"SELLER" +], +"enumDescriptions": [ +"A placeholder for an undefined buyer/seller role.", +"Specifies the role as buyer.", +"Specifies the role as seller." +], +"readOnly": true, +"type": "string" +}, +"note": { +"description": "The text of the note. Maximum length is 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, +"OperatingSystemTargeting": { +"description": "Represents targeting information for operating systems.", +"id": "OperatingSystemTargeting", +"properties": { +"operatingSystemCriteria": { +"$ref": "CriteriaTargeting", +"description": "IDs of operating systems to be included/excluded." +}, +"operatingSystemVersionCriteria": { +"$ref": "CriteriaTargeting", +"description": "IDs of operating system versions to be included/excluded." +} +}, +"type": "object" +}, +"PauseFinalizedDealRequest": { +"description": "Request message for pausing a finalized deal.", +"id": "PauseFinalizedDealRequest", +"properties": { +"reason": { +"description": "The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters.", +"type": "string" +} +}, +"type": "object" +}, +"PlacementTargeting": { +"description": "Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed.", +"id": "PlacementTargeting", +"properties": { +"mobileApplicationTargeting": { +"$ref": "MobileApplicationTargeting", +"description": "Mobile application targeting information in a deal. This doesn't apply to Auction Packages." +}, +"uriTargeting": { +"$ref": "UriTargeting", +"description": "URLs to be included/excluded." +} +}, +"type": "object" +}, +"PreferredDealTerms": { +"description": "Pricing terms for Preferred Deals.", +"id": "PreferredDealTerms", +"properties": { +"fixedPrice": { +"$ref": "Price", +"description": "Fixed price for the deal." +} +}, +"type": "object" +}, +"Price": { +"description": "Represents a price and a pricing type for a deal.", +"id": "Price", +"properties": { +"amount": { +"$ref": "Money", +"description": "The actual price with currency specified." +}, +"type": { +"description": "The pricing type for the deal.", +"enum": [ +"TYPE_UNSPECIFIED", +"CPM", +"CPD" +], +"enumDescriptions": [ +"A placeholder for an undefined pricing type. If the pricing type is unspecified, CPM will be used instead.", +"Cost per thousand impressions.", +"Cost per day." +], +"type": "string" +} +}, +"type": "object" +}, +"PrivateAuctionTerms": { +"description": "Pricing terms for Private Auctions.", +"id": "PrivateAuctionTerms", +"properties": { +"floorPrice": { +"$ref": "Price", +"description": "The minimum price buyer has to bid to compete in the private auction." +}, +"openAuctionAllowed": { +"description": "Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, +"PrivateData": { +"description": "Buyers are allowed to store certain types of private data in a proposal or deal.", +"id": "PrivateData", +"properties": { +"referenceId": { +"description": "A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).", +"type": "string" +} +}, +"type": "object" +}, +"ProgrammaticGuaranteedTerms": { +"description": "Pricing terms for Programmatic Guaranteed Deals.", +"id": "ProgrammaticGuaranteedTerms", +"properties": { +"fixedPrice": { +"$ref": "Price", +"description": "Fixed price for the deal." +}, +"guaranteedLooks": { +"description": "Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.", +"format": "int64", +"type": "string" +}, +"impressionCap": { +"description": "The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.", +"format": "int64", +"type": "string" +}, +"minimumDailyLooks": { +"description": "Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.", +"format": "int64", +"type": "string" +}, +"percentShareOfVoice": { +"description": "For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.", +"format": "int64", +"type": "string" +}, +"reservationType": { +"description": "The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.", +"enum": [ +"RESERVATION_TYPE_UNSPECIFIED", +"STANDARD", +"SPONSORSHIP" +], +"enumDescriptions": [ +"An unspecified reservation type.", +"Non-sponsorship deal.", +"Sponsorship deals don't have impression goal (guaranteed_looks) and they are served based on the flight dates. For CPM Sponsorship deals, impression_cap is the lifetime impression limit." +], +"type": "string" +} +}, +"type": "object" +}, +"Proposal": { +"description": "Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.", +"id": "Proposal", +"properties": { +"billedBuyer": { +"description": "Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"buyer": { +"description": "Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`", +"readOnly": true, +"type": "string" +}, +"buyerContacts": { +"description": "Contact information for the buyer.", +"items": { +"$ref": "Contact" +}, +"type": "array" +}, +"buyerPrivateData": { +"$ref": "PrivateData", +"description": "Buyer private data (hidden from seller)." +}, +"client": { +"description": "Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`", +"readOnly": true, +"type": "string" +}, +"dealType": { +"description": "Output only. Type of deal the proposal contains.", +"enum": [ +"DEAL_TYPE_UNSPECIFIED", +"PREFERRED_DEAL", +"PRIVATE_AUCTION", +"PROGRAMMATIC_GUARANTEED" +], +"enumDescriptions": [ +"Default, unspecified deal type.", +"Preferred deals.", +"Private auction deals.", +"Programmatic guaranteed deals." +], +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.", +"readOnly": true, +"type": "string" +}, +"isRenegotiating": { +"description": "Output only. True if the proposal was previously finalized and is now being renegotiated.", +"readOnly": true, +"type": "boolean" +}, +"lastUpdaterOrCommentorRole": { +"description": "Output only. The role of the last user that either updated the proposal or left a comment.", +"enum": [ +"BUYER_SELLER_ROLE_UNSPECIFIED", +"BUYER", +"SELLER" +], +"enumDescriptions": [ +"A placeholder for an undefined buyer/seller role.", +"Specifies the role as buyer.", +"Specifies the role as seller." +], +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}", +"type": "string" +}, +"notes": { +"description": "A list of notes from the buyer and the seller attached to this proposal.", +"items": { +"$ref": "Note" +}, +"type": "array" +}, +"originatorRole": { +"description": "Output only. Indicates whether the buyer/seller created the proposal.", +"enum": [ +"BUYER_SELLER_ROLE_UNSPECIFIED", +"BUYER", +"SELLER" +], +"enumDescriptions": [ +"A placeholder for an undefined buyer/seller role.", +"Specifies the role as buyer.", +"Specifies the role as seller." +], +"readOnly": true, +"type": "string" +}, +"pausingConsented": { +"description": "Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.", +"type": "boolean" +}, +"proposalRevision": { +"description": "Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"publisherProfile": { +"description": "Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.", +"type": "string" +}, +"sellerContacts": { +"description": "Output only. Contact information for the seller.", +"items": { +"$ref": "Contact" +}, +"readOnly": true, +"type": "array" +}, +"state": { +"description": "Output only. Indicates the state of the proposal.", +"enum": [ +"STATE_UNSPECIFIED", +"BUYER_REVIEW_REQUESTED", +"SELLER_REVIEW_REQUESTED", +"BUYER_ACCEPTANCE_REQUESTED", +"FINALIZED", +"TERMINATED" +], +"enumDescriptions": [ +"Unspecified proposal state", +"When a proposal is waiting for buyer to review.", +"When the proposal is waiting for the seller to review.", +"When the seller accepted the proposal and sent it to the buyer for review.", +"When both buyer and seller has accepted the proposal", +"When either buyer or seller has cancelled the proposal" +], +"readOnly": true, +"type": "string" +}, +"termsAndConditions": { +"description": "Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the proposal was last revised.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"PublisherProfile": { +"description": "The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.", +"id": "PublisherProfile", +"properties": { +"audienceDescription": { +"description": "Description on the publisher's audience.", +"type": "string" +}, +"directDealsContact": { +"description": "Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.", +"type": "string" +}, +"displayName": { +"description": "Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.", +"type": "string" +}, +"domains": { +"description": "The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like \"photos.google.co.uk/123\", but will instead contain \"google.co.uk\". Can be used to filter the response of the publisherProfiles.list method.", +"items": { +"type": "string" +}, +"type": "array" +}, +"isParent": { +"description": "Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to \"is_parent: true\".", +"type": "boolean" +}, +"logoUrl": { +"description": "A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.", +"type": "string" +}, +"mediaKitUrl": { +"description": "URL to additional marketing and sales materials.", +"type": "string" +}, +"mobileApps": { +"description": "The list of apps represented in this publisher profile. Empty if this is a parent profile.", +"items": { +"$ref": "PublisherProfileMobileApplication" +}, +"type": "array" +}, +"name": { +"description": "Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`", +"type": "string" +}, +"overview": { +"description": "Overview of the publisher.", +"type": "string" +}, +"pitchStatement": { +"description": "Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.", +"type": "string" +}, +"programmaticDealsContact": { +"description": "Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.", +"type": "string" +}, +"publisherCode": { +"description": "A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.", +"type": "string" +}, +"samplePageUrl": { +"description": "URL to a sample content page.", +"type": "string" +}, +"topHeadlines": { +"description": "Up to three key metrics and rankings. For example, \"#1 Mobile News Site for 20 Straight Months\".", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"PublisherProfileMobileApplication": { +"description": "A mobile application that contains a external app ID, name, and app store.", +"id": "PublisherProfileMobileApplication", +"properties": { +"appStore": { +"description": "The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.", +"enum": [ +"APP_STORE_TYPE_UNSPECIFIED", +"APPLE_ITUNES", +"GOOGLE_PLAY", +"ROKU", +"AMAZON_FIRE_TV", +"PLAYSTATION", +"XBOX", +"SAMSUNG_TV", +"AMAZON", +"OPPO", +"SAMSUNG", +"VIVO", +"XIAOMI", +"LG_TV" +], +"enumDescriptions": [ +"A placeholder for an unknown app store.", +"Apple iTunes", +"Google Play", +"Roku", +"Amazon Fire TV", +"PlayStation", +"Xbox", +"Samsung TV", +"Amazon Appstore", +"OPPO App Market", +"Samsung Galaxy Store", +"VIVO App Store", +"Xiaomi GetApps", +"LG TV" +], +"type": "string" +}, +"externalAppId": { +"description": "The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.", +"type": "string" +}, +"name": { +"description": "The name of the app.", +"type": "string" +} +}, +"type": "object" +}, +"ResumeFinalizedDealRequest": { +"description": "Request message for resuming a finalized deal.", +"id": "ResumeFinalizedDealRequest", +"properties": {}, +"type": "object" +}, +"RtbMetrics": { +"description": "Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics)", +"id": "RtbMetrics", +"properties": { +"adImpressions7Days": { +"description": "Ad impressions in last 7 days.", +"format": "int64", +"type": "string" +}, +"bidRate7Days": { +"description": "Bid rate in last 7 days, calculated by (bids / bid requests).", +"format": "double", +"type": "number" +}, +"bidRequests7Days": { +"description": "Bid requests in last 7 days.", +"format": "int64", +"type": "string" +}, +"bids7Days": { +"description": "Bids in last 7 days.", +"format": "int64", +"type": "string" +}, +"filteredBidRate7Days": { +"description": "Filtered bid rate in last 7 days, calculated by (filtered bids / bids).", +"format": "double", +"type": "number" +}, +"mustBidRateCurrentMonth": { +"description": "Must bid rate for current month.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"SendRfpRequest": { +"description": "Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation.", +"id": "SendRfpRequest", +"properties": { +"buyerContacts": { +"description": "Contact information for the buyer.", +"items": { +"$ref": "Contact" +}, +"type": "array" +}, +"client": { +"description": "If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId}/clients/{clientAccountid}`.", +"type": "string" +}, +"displayName": { +"description": "Required. The display name of the proposal being created by this RFP.", +"type": "string" +}, +"estimatedGrossSpend": { +"$ref": "Money", +"description": "Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly." +}, +"flightEndTime": { +"description": "Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC \"Zulu\" format. Note that the specified value will be truncated to a granularity of one second.", +"format": "google-datetime", +"type": "string" +}, +"flightStartTime": { +"description": "Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC \"Zulu\" format. Note that the specified value will be truncated to a granularity of one second.", +"format": "google-datetime", +"type": "string" +}, +"geoTargeting": { +"$ref": "CriteriaTargeting", +"description": "Geo criteria IDs to be targeted. Refer to Geo tables." +}, +"inventorySizeTargeting": { +"$ref": "InventorySizeTargeting", +"description": "Inventory sizes to be targeted." +}, +"note": { +"description": "A message that is sent to the publisher. Maximum length is 1024 characters.", +"type": "string" +}, +"preferredDealTerms": { +"$ref": "PreferredDealTerms", +"description": "The terms for preferred deals." +}, +"programmaticGuaranteedTerms": { +"$ref": "ProgrammaticGuaranteedTerms", +"description": "The terms for programmatic guaranteed deals." +}, +"publisherProfile": { +"description": "Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.", +"type": "string" +} +}, +"type": "object" +}, +"SetReadyToServeRequest": { +"description": "Request message for setting ready to serve for a finalized deal.", +"id": "SetReadyToServeRequest", +"properties": {}, +"type": "object" +}, +"SubscribeAuctionPackageRequest": { +"description": "Request message for SubscribeAuctionPackage.", +"id": "SubscribeAuctionPackageRequest", +"properties": {}, +"type": "object" +}, +"SubscribeClientsRequest": { +"description": "Request message for SubscribeAuctionPackageClients.", +"id": "SubscribeClientsRequest", +"properties": { +"clients": { +"description": "Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"TechnologyTargeting": { +"description": "Represents targeting about various types of technology.", +"id": "TechnologyTargeting", +"properties": { +"deviceCapabilityTargeting": { +"$ref": "CriteriaTargeting", +"description": "IDs of device capabilities to be included/excluded." +}, +"deviceCategoryTargeting": { +"$ref": "CriteriaTargeting", +"description": "IDs of device categories to be included/excluded." +}, +"operatingSystemTargeting": { +"$ref": "OperatingSystemTargeting", +"description": "Operating system related targeting information." +} +}, +"type": "object" +}, +"TimeOfDay": { +"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", +"id": "TimeOfDay", +"properties": { +"hours": { +"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", +"format": "int32", +"type": "integer" +}, +"minutes": { +"description": "Minutes of hour of day. Must be from 0 to 59.", +"format": "int32", +"type": "integer" +}, +"nanos": { +"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", +"format": "int32", +"type": "integer" +}, +"seconds": { +"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"TimeZone": { +"description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", +"id": "TimeZone", +"properties": { +"id": { +"description": "IANA Time Zone Database time zone, e.g. \"America/New_York\".", +"type": "string" +}, +"version": { +"description": "Optional. IANA Time Zone Database version number, e.g. \"2019a\".", +"type": "string" +} +}, +"type": "object" +}, +"UnsubscribeAuctionPackageRequest": { +"description": "Request message for UnsubscribeAuctionPackage.", +"id": "UnsubscribeAuctionPackageRequest", +"properties": {}, +"type": "object" +}, +"UnsubscribeClientsRequest": { +"description": "Request message for UnsubscribeAuctionPackage.", +"id": "UnsubscribeClientsRequest", +"properties": { +"clients": { +"description": "Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"UpdateDealRequest": { +"description": "Request message for updating the deal at the given revision number.", +"id": "UpdateDealRequest", +"properties": { +"deal": { +"$ref": "Deal", +"description": "Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}" +}, +"updateMask": { +"description": "List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path \"*\" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, +"UriTargeting": { +"description": "Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply.", +"id": "UriTargeting", +"properties": { +"excludedUris": { +"description": "A list of URLs to be excluded.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetedUris": { +"description": "A list of URLs to be included.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"VideoTargeting": { +"description": "Represents targeting information about video.", +"id": "VideoTargeting", +"properties": { +"excludedPositionTypes": { +"description": "A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.", +"items": { +"enum": [ +"POSITION_TYPE_UNSPECIFIED", +"PREROLL", +"MIDROLL", +"POSTROLL" +], +"enumDescriptions": [ +"A placeholder for an undefined video position.", +"Ad is played before the video.", +"Ad is played during the video.", +"Ad is played after the video." +], +"type": "string" +}, +"type": "array" +}, +"targetedPositionTypes": { +"description": "A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.", +"items": { +"enum": [ +"POSITION_TYPE_UNSPECIFIED", +"PREROLL", +"MIDROLL", +"POSTROLL" +], +"enumDescriptions": [ +"A placeholder for an undefined video position.", +"Ad is played before the video.", +"Ad is played during the video.", +"Ad is played after the video." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Authorized Buyers Marketplace API", +"version": "v1alpha", +"version_module": true +} \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/backupdr.v1.json b/googleapiclient/discovery_cache/documents/backupdr.v1.json index 45821ea16fd..33855b01456 100644 --- a/googleapiclient/discovery_cache/documents/backupdr.v1.json +++ b/googleapiclient/discovery_cache/documents/backupdr.v1.json @@ -398,6 +398,11 @@ "name" ], "parameters": { +"force": { +"description": "Optional. If set to true, will not check plan duration against backup vault enforcement duration. Non-standard field.", +"location": "query", +"type": "boolean" +}, "name": { "description": "Output only. The resource name.", "location": "path", @@ -1256,7 +1261,7 @@ } } }, -"revision": "20240626", +"revision": "20240711", "rootUrl": "https://backupdr.googleapis.com/", "schemas": { "AbandonBackupRequest": { @@ -1418,6 +1423,11 @@ ], "type": "string" }, +"diskTypeUri": { +"description": "Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd", +"readOnly": true, +"type": "string" +}, "guestOsFeature": { "description": "Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.", "items": { @@ -2022,8 +2032,8 @@ }, "type": "array" }, -"sourceInstanceName": { -"description": "Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035.", +"sourceInstance": { +"description": "The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance", "type": "string" }, "tags": { diff --git a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json index e397153f393..49e4154b5e2 100644 --- a/googleapiclient/discovery_cache/documents/certificatemanager.v1.json +++ b/googleapiclient/discovery_cache/documents/certificatemanager.v1.json @@ -1280,7 +1280,7 @@ } } }, -"revision": "20240626", +"revision": "20240710", "rootUrl": "https://certificatemanager.googleapis.com/", "schemas": { "AllowlistedCertificate": { @@ -1658,7 +1658,7 @@ "type": "string" }, "type": { -"description": "Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD.", +"description": "Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.", "enum": [ "TYPE_UNSPECIFIED", "FIXED_RECORD", diff --git a/googleapiclient/discovery_cache/documents/classroom.v1.json b/googleapiclient/discovery_cache/documents/classroom.v1.json index e8fdd4b8fad..1a68e8e8396 100644 --- a/googleapiclient/discovery_cache/documents/classroom.v1.json +++ b/googleapiclient/discovery_cache/documents/classroom.v1.json @@ -564,7 +564,7 @@ "type": "string" }, "attachmentId": { -"description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", +"description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -1061,7 +1061,7 @@ "type": "string" }, "attachmentId": { -"description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", +"description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -2021,7 +2021,7 @@ "type": "string" }, "attachmentId": { -"description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", +"description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -2402,7 +2402,7 @@ "type": "string" }, "attachmentId": { -"description": "Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.", +"description": "Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).", "location": "query", "type": "string" }, @@ -3695,7 +3695,7 @@ } } }, -"revision": "20240701", +"revision": "20240713", "rootUrl": "https://classroom.googleapis.com/", "schemas": { "AddOnAttachment": { diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1.json index c7ce5e4c567..75025b54193 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1.json @@ -1095,7 +1095,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -2836,7 +2836,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -2865,7 +2865,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -3152,7 +3152,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json index 94b32728da7..d52821e86ff 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1beta1.json @@ -411,7 +411,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -1161,7 +1161,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -1190,7 +1190,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -1477,7 +1477,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json index 7f5415feaf7..f9b4acc88d0 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p1beta1.json @@ -207,7 +207,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -863,7 +863,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -892,7 +892,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -1179,7 +1179,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json index 9a6c03f94b8..4fadb3de712 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p5beta1.json @@ -177,7 +177,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -868,7 +868,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -897,7 +897,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -1184,7 +1184,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json index e96628409df..f72df1ee70c 100644 --- a/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudasset.v1p7beta1.json @@ -167,7 +167,7 @@ } } }, -"revision": "20240629", +"revision": "20240717", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -937,7 +937,7 @@ "type": "string" }, "sources": { -"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.", "items": { "$ref": "GoogleIdentityAccesscontextmanagerV1EgressSource" }, @@ -966,7 +966,7 @@ "id": "GoogleIdentityAccesscontextmanagerV1EgressSource", "properties": { "accessLevel": { -"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.", +"description": "An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.", "type": "string" } }, @@ -1253,7 +1253,7 @@ "properties": { "vpcSubnetwork": { "$ref": "GoogleIdentityAccesscontextmanagerV1VpcSubNetwork", -"description": "Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out." +"description": "Sub-segment ranges of a VPC network." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json index b97f33623b8..1e7cc8d260c 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1.json @@ -484,7 +484,7 @@ } } }, -"revision": "20240626", +"revision": "20240717", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -594,14 +594,17 @@ "properties": { "customerOnboardingState": { "$ref": "CustomerOnboardingState", -"description": "Container for customer onboarding steps" +"description": "Output only. Container for customer onboarding steps", +"readOnly": true }, "displayName": { -"description": "The customer organization's display name. E.g. \"google.com\".", +"description": "Output only. The customer organization's display name. E.g. \"google.com\".", +"readOnly": true, "type": "string" }, "isOnboarded": { -"description": "Indicates whether a customer is fully onboarded", +"description": "Output only. Indicates whether a customer is fully onboarded", +"readOnly": true, "type": "boolean" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json index 083e2781044..e528c59d16f 100644 --- a/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json +++ b/googleapiclient/discovery_cache/documents/cloudcontrolspartner.v1beta.json @@ -484,7 +484,7 @@ } } }, -"revision": "20240626", +"revision": "20240717", "rootUrl": "https://cloudcontrolspartner.googleapis.com/", "schemas": { "AccessApprovalRequest": { @@ -594,14 +594,17 @@ "properties": { "customerOnboardingState": { "$ref": "CustomerOnboardingState", -"description": "Container for customer onboarding steps" +"description": "Output only. Container for customer onboarding steps", +"readOnly": true }, "displayName": { -"description": "The customer organization's display name. E.g. \"google.com\".", +"description": "Output only. The customer organization's display name. E.g. \"google.com\".", +"readOnly": true, "type": "string" }, "isOnboarded": { -"description": "Indicates whether a customer is fully onboarded", +"description": "Output only. Indicates whether a customer is fully onboarded", +"readOnly": true, "type": "boolean" }, "name": { diff --git a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json index 92464a677bf..12aadba8b33 100644 --- a/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudfunctions.v1.json @@ -552,7 +552,7 @@ } } }, -"revision": "20240627", +"revision": "20240711", "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { "AuditConfig": { @@ -1942,7 +1942,7 @@ "type": "string" }, "url": { -"description": "The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory.", +"description": "The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json index fa73648ce0d..375ec179296 100644 --- a/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudtrace.v2beta1.json @@ -273,7 +273,7 @@ } } }, -"revision": "20240621", +"revision": "20240712", "rootUrl": "https://cloudtrace.googleapis.com/", "schemas": { "Empty": { @@ -305,7 +305,7 @@ "id": "OutputConfig", "properties": { "destination": { -"description": "The destination for writing trace data. Supported formats include: \"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"", +"description": "Required. The destination for writing trace data. Supported formats include: \"bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]\"", "type": "string" } }, @@ -316,7 +316,7 @@ "id": "TraceSink", "properties": { "name": { -"description": "Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `\"projects/12345/traceSinks/my-project-trace-sink\"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.", +"description": "Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `\"projects/12345/traceSinks/my-project-trace-sink\"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.", "type": "string" }, "outputConfig": { diff --git a/googleapiclient/discovery_cache/documents/composer.v1.json b/googleapiclient/discovery_cache/documents/composer.v1.json index 3785758992b..950c3465b3b 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1.json @@ -966,7 +966,7 @@ } } }, -"revision": "20240703", +"revision": "20240716", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1304,6 +1304,11 @@ "description": "The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/composer.v1beta1.json b/googleapiclient/discovery_cache/documents/composer.v1beta1.json index c8099d587d7..65b4fdfb791 100644 --- a/googleapiclient/discovery_cache/documents/composer.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/composer.v1beta1.json @@ -994,7 +994,7 @@ } } }, -"revision": "20240703", +"revision": "20240716", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { @@ -1339,6 +1339,11 @@ "description": "The resource name of the environment, in the form: \"projects/{projectId}/locations/{locationId}/environments/{environmentId}\" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Reserved for future use.", +"readOnly": true, +"type": "boolean" +}, "satisfiesPzs": { "description": "Output only. Reserved for future use.", "readOnly": true, diff --git a/googleapiclient/discovery_cache/documents/compute.alpha.json b/googleapiclient/discovery_cache/documents/compute.alpha.json index 0ce64289e33..2c7211ea865 100644 --- a/googleapiclient/discovery_cache/documents/compute.alpha.json +++ b/googleapiclient/discovery_cache/documents/compute.alpha.json @@ -14084,6 +14084,210 @@ } } }, +"instantSnapshotGroups": { +"methods": { +"delete": { +"description": "deletes a Zonal InstantSnapshotGroup resource", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", +"httpMethod": "DELETE", +"id": "compute.instantSnapshotGroups.delete", +"parameterOrder": [ +"project", +"zone", +"instantSnapshotGroup" +], +"parameters": { +"instantSnapshotGroup": { +"description": "Name of the InstantSnapshot resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "returns the specified InstantSnapshotGroup resource in the specified zone.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", +"httpMethod": "GET", +"id": "compute.instantSnapshotGroups.get", +"parameterOrder": [ +"project", +"zone", +"instantSnapshotGroup" +], +"parameters": { +"instantSnapshotGroup": { +"description": "Name of the instantSnapshotGroup resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups/{instantSnapshotGroup}", +"response": { +"$ref": "InstantSnapshotGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "inserts a Zonal InstantSnapshotGroup resource", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", +"httpMethod": "POST", +"id": "compute.instantSnapshotGroups.insert", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"sourceConsistencyGroup": { +"description": "begin_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +}, +"zone": { +"description": "Name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups", +"request": { +"$ref": "InstantSnapshotGroup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "retrieves the list of InstantSnapshotGroup resources contained within the specified zone.", +"flatPath": "projects/{project}/zones/{zone}/instantSnapshotGroups", +"httpMethod": "GET", +"id": "compute.instantSnapshotGroups.list", +"parameterOrder": [ +"project", +"zone" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +}, +"zone": { +"description": "The name of the zone for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/zones/{zone}/instantSnapshotGroups", +"response": { +"$ref": "ListInstantSnapshotGroups" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "instantSnapshots": { "methods": { "aggregatedList": { @@ -26304,6 +26508,106 @@ } } }, +"regionInstanceGroupManagerResizeRequests": { +"methods": { +"get": { +"description": "Returns all of the details about the specified resize request.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"httpMethod": "GET", +"id": "compute.regionInstanceGroupManagerResizeRequests.get", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager", +"resizeRequest" +], +"parameters": { +"instanceGroupManager": { +"description": "The name of the managed instance group. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region scoping this request. Name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"resizeRequest": { +"description": "The name of the resize request. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", +"response": { +"$ref": "InstanceGroupManagerResizeRequest" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "Creates a new Resize Request that starts provisioning VMs immediately or queues VM creation.", +"flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", +"httpMethod": "POST", +"id": "compute.regionInstanceGroupManagerResizeRequests.insert", +"parameterOrder": [ +"project", +"region", +"instanceGroupManager" +], +"parameters": { +"instanceGroupManager": { +"description": "Name of the managed instance group to which the resize request is scoped. Name should conform to RFC1035 or be a resource ID.", +"location": "path", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region scoping this request. Name should conform to RFC1035.", +"location": "path", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeRequests", +"request": { +"$ref": "InstanceGroupManagerResizeRequest" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +} +} +}, "regionInstanceGroupManagers": { "methods": { "abandonInstances": { @@ -28207,6 +28511,210 @@ } } }, +"regionInstantSnapshotGroups": { +"methods": { +"delete": { +"description": "deletes a Regional InstantSnapshotGroup resource", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", +"httpMethod": "DELETE", +"id": "compute.regionInstantSnapshotGroups.delete", +"parameterOrder": [ +"project", +"region", +"instantSnapshotGroup" +], +"parameters": { +"instantSnapshotGroup": { +"description": "Name of the InstantSnapshotGroup resource to delete.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshotGroup}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"get": { +"description": "returns the specified InstantSnapshotGroup resource in the specified region.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshot}", +"httpMethod": "GET", +"id": "compute.regionInstantSnapshotGroups.get", +"parameterOrder": [ +"project", +"region", +"instantSnapshot" +], +"parameters": { +"instantSnapshot": { +"description": "Name of the InstantSnapshotGroup resource to return.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", +"required": true, +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshotGroups/{instantSnapshot}", +"response": { +"$ref": "InstantSnapshotGroup" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +}, +"insert": { +"description": "creates a Regional InstantSnapshotGroup resource", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", +"httpMethod": "POST", +"id": "compute.regionInstantSnapshotGroups.insert", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "Name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"requestId": { +"description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"sourceConsistencyGroup": { +"description": "begin_interface: MixerMutationRequestBuilder", +"location": "query", +"type": "string" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshotGroups", +"request": { +"$ref": "InstantSnapshotGroup" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute" +] +}, +"list": { +"description": "retrieves the list of InstantSnapshotGroup resources contained within the specified region.", +"flatPath": "projects/{project}/regions/{region}/instantSnapshotGroups", +"httpMethod": "GET", +"id": "compute.regionInstantSnapshotGroups.list", +"parameterOrder": [ +"project", +"region" +], +"parameters": { +"filter": { +"description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", +"location": "query", +"type": "string" +}, +"maxResults": { +"default": "500", +"description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", +"format": "uint32", +"location": "query", +"minimum": "0", +"type": "integer" +}, +"orderBy": { +"description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", +"location": "query", +"type": "string" +}, +"pageToken": { +"description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", +"location": "query", +"type": "string" +}, +"project": { +"description": "Project ID for this request.", +"location": "path", +"pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", +"required": true, +"type": "string" +}, +"region": { +"description": "The name of the region for this request.", +"location": "path", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"required": true, +"type": "string" +}, +"returnPartialSuccess": { +"description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. For example, when partial success behavior is enabled, aggregatedList for a single zone scope either returns all resources in the zone or no resources, with an error code.", +"location": "query", +"type": "boolean" +} +}, +"path": "projects/{project}/regions/{region}/instantSnapshotGroups", +"response": { +"$ref": "ListInstantSnapshotGroups" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/compute", +"https://www.googleapis.com/auth/compute.readonly" +] +} +} +}, "regionInstantSnapshots": { "methods": { "delete": { @@ -44715,7 +45223,7 @@ } } }, -"revision": "20240702", +"revision": "20240707", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -59757,6 +60265,10 @@ false "description": "[Output Only] The URL of the region where the managed instance group resides (for regional resources).", "type": "string" }, +"resourcePolicies": { +"$ref": "InstanceGroupManagerResourcePolicies", +"description": "Resource policies for this managed instance group." +}, "satisfiesPzi": { "description": "[Output Only] Reserved for future use.", "type": "boolean" @@ -60799,6 +61311,16 @@ false }, "type": "object" }, +"InstanceGroupManagerResourcePolicies": { +"id": "InstanceGroupManagerResourcePolicies", +"properties": { +"workloadPolicy": { +"description": "The URL of the workload policy that is specified for this managed instance group. It can be a full or partial URL. For example, the following are all valid URLs to a workload policy: - https://www.googleapis.com/compute/v1/projects/project/regions/region /resourcePolicies/resourcePolicy - projects/project/regions/region/resourcePolicies/resourcePolicy - regions/region/resourcePolicies/resourcePolicy ", +"type": "string" +} +}, +"type": "object" +}, "InstanceGroupManagerStandbyPolicy": { "id": "InstanceGroupManagerStandbyPolicy", "properties": { @@ -63847,6 +64369,101 @@ false }, "type": "object" }, +"InstantSnapshotGroup": { +"id": "InstantSnapshotGroup", +"properties": { +"creationTimestamp": { +"description": "[Output Only] Creation timestamp in RFC3339 text format.", +"type": "string" +}, +"description": { +"description": "Optional. An optional description of this resource. Provide this property when you create the resource.", +"type": "string" +}, +"id": { +"description": "[Output Only] The unique identifier for the resource. This identifier is defined by the server.", +"format": "uint64", +"type": "string" +}, +"kind": { +"default": "compute#instantSnapshotGroup", +"description": "[Output Only] Type of the resource. Always compute#instantSnapshotGroup for InstantSnapshotGroup resources.", +"type": "string" +}, +"name": { +"description": "Identifier. Name of the resource; provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", +"pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", +"type": "string" +}, +"region": { +"description": "[Output Only] URL of the region where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", +"type": "string" +}, +"resourceStatus": { +"$ref": "InstantSnapshotGroupResourceStatus" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for the resource.", +"type": "string" +}, +"selfLinkWithId": { +"description": "[Output Only] Server-defined URL for this resource's resource id.", +"type": "string" +}, +"status": { +"description": "[Output Only]", +"enum": [ +"CREATING", +"DELETING", +"FAILED", +"INVALID", +"READY", +"UNKNOWN" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"" +], +"type": "string" +}, +"zone": { +"description": "[Output Only] URL of the zone where the instant snapshot group resides. You must specify this field as part of the HTTP request URL. It is not settable as a field in the request body.", +"type": "string" +} +}, +"type": "object" +}, +"InstantSnapshotGroupResourceStatus": { +"id": "InstantSnapshotGroupResourceStatus", +"properties": { +"consistencyMembershipResolutionTime": { +"description": "[Output Only]", +"format": "google-datetime", +"type": "string" +}, +"sourceInfo": { +"$ref": "InstantSnapshotGroupSourceInfo", +"description": "[Output Only]" +} +}, +"type": "object" +}, +"InstantSnapshotGroupSourceInfo": { +"id": "InstantSnapshotGroupSourceInfo", +"properties": { +"consistencyGroup": { +"type": "string" +}, +"consistencyGroupId": { +"type": "string" +} +}, +"type": "object" +}, "InstantSnapshotList": { "description": "Contains a list of InstantSnapshot resources.", "id": "InstantSnapshotList", @@ -64382,6 +64999,9 @@ false "bandwidthPercentagePolicy": { "$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" }, +"egressMinBandwidthPercentagePolicy": { +"$ref": "InterconnectApplicationAwareInterconnectBandwidthPercentagePolicy" +}, "profileDescription": { "description": "A description for the AAI profile on this interconnect.", "type": "string" @@ -67176,6 +67796,168 @@ false }, "type": "object" }, +"ListInstantSnapshotGroups": { +"description": "Contains a list of InstantSnapshotGroup resources.", +"id": "ListInstantSnapshotGroups", +"properties": { +"etag": { +"type": "string" +}, +"id": { +"description": "[Output Only] Unique identifier for the resource; defined by the server.", +"type": "string" +}, +"items": { +"description": "A list of InstantSnapshotGroup resources.", +"items": { +"$ref": "InstantSnapshotGroup" +}, +"type": "array" +}, +"kind": { +"default": "compute#instantSnapshotGroupsList", +"description": "Type of resource.", +"type": "string" +}, +"nextPageToken": { +"description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", +"type": "string" +}, +"selfLink": { +"description": "[Output Only] Server-defined URL for this resource.", +"type": "string" +}, +"unreachables": { +"description": "[Output Only] Unreachable resources. end_interface: MixerListResponseWithEtagBuilder", +"items": { +"type": "string" +}, +"type": "array" +}, +"warning": { +"description": "[Output Only] Informational warning message.", +"properties": { +"code": { +"description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", +"enum": [ +"CLEANUP_FAILED", +"DEPRECATED_RESOURCE_USED", +"DEPRECATED_TYPE_USED", +"DISK_SIZE_LARGER_THAN_IMAGE_SIZE", +"EXPERIMENTAL_TYPE_USED", +"EXTERNAL_API_WARNING", +"FIELD_VALUE_OVERRIDEN", +"INJECTED_KERNELS_DEPRECATED", +"INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", +"LARGE_DEPLOYMENT_WARNING", +"LIST_OVERHEAD_QUOTA_EXCEED", +"MISSING_TYPE_DEPENDENCY", +"NEXT_HOP_ADDRESS_NOT_ASSIGNED", +"NEXT_HOP_CANNOT_IP_FORWARD", +"NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", +"NEXT_HOP_INSTANCE_NOT_FOUND", +"NEXT_HOP_INSTANCE_NOT_ON_NETWORK", +"NEXT_HOP_NOT_RUNNING", +"NOT_CRITICAL_ERROR", +"NO_RESULTS_ON_PAGE", +"PARTIAL_SUCCESS", +"REQUIRED_TOS_AGREEMENT", +"RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", +"RESOURCE_NOT_DELETED", +"SCHEMA_VALIDATION_IGNORED", +"SINGLE_INSTANCE_PROPERTY_TEMPLATE", +"UNDECLARED_PROPERTIES", +"UNREACHABLE" +], +"enumDeprecated": [ +false, +false, +false, +false, +false, +false, +true, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false, +false +], +"enumDescriptions": [ +"Warning about failed cleanup of transient changes made by a failed operation.", +"A link to a deprecated resource was created.", +"When deploying and at least one of the resources has a type marked as deprecated", +"The user created a boot disk that is larger than image size.", +"When deploying and at least one of the resources has a type marked as experimental", +"Warning that is present in an external api call", +"Warning that value of a field has been overridden. Deprecated unused field.", +"The operation involved use of an injected kernel, which is deprecated.", +"A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", +"When deploying a deployment with a exceedingly large number of resources", +"Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", +"A resource depends on a missing type", +"The route's nextHopIp address is not assigned to an instance on the network.", +"The route's next hop instance cannot ip forward.", +"The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", +"The route's nextHopInstance URL refers to an instance that does not exist.", +"The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", +"The route's next hop instance does not have a status of RUNNING.", +"Error which is not critical. We decided to continue the process despite the mentioned error.", +"No results are present on a particular list page.", +"Success is reported, but some results may be missing due to errors", +"The user attempted to use a resource that requires a TOS they have not accepted.", +"Warning that a resource is in use.", +"One or more of the resources set to auto-delete could not be deleted because they were in use.", +"When a resource schema validation is ignored.", +"Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", +"When undeclared properties in the schema are present", +"A given scope cannot be reached." +], +"type": "string" +}, +"data": { +"description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", +"items": { +"properties": { +"key": { +"description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", +"type": "string" +}, +"value": { +"description": "[Output Only] A warning data value corresponding to the key.", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, +"message": { +"description": "[Output Only] A human-readable description of the warning code.", +"type": "string" +} +}, +"type": "object" +} +}, +"type": "object" +}, "LocalDisk": { "id": "LocalDisk", "properties": { @@ -68694,6 +69476,9 @@ false "selfLinkWithId": { "description": "[Output Only] Server-defined URL for this resource with the resource id.", "type": "string" +}, +"status": { +"$ref": "MultiMigStatus" } }, "type": "object" @@ -68746,6 +69531,18 @@ false }, "type": "object" }, +"MultiMigStatus": { +"id": "MultiMigStatus", +"properties": { +"memberInstanceGroupManagers": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "MultiMigsList": { "id": "MultiMigsList", "properties": { diff --git a/googleapiclient/discovery_cache/documents/config.v1.json b/googleapiclient/discovery_cache/documents/config.v1.json index 2838e46435a..22bb67a239a 100644 --- a/googleapiclient/discovery_cache/documents/config.v1.json +++ b/googleapiclient/discovery_cache/documents/config.v1.json @@ -1187,7 +1187,7 @@ } } }, -"revision": "20240626", +"revision": "20240710", "rootUrl": "https://config.googleapis.com/", "schemas": { "ApplyResults": { @@ -2545,12 +2545,12 @@ "id": "TerraformBlueprint", "properties": { "gcsSource": { -"description": "Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`", +"description": "URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`", "type": "string" }, "gitSource": { "$ref": "GitSource", -"description": "Required. URI of a public Git repo." +"description": "URI of a public Git repo." }, "inputValues": { "additionalProperties": { diff --git a/googleapiclient/discovery_cache/documents/connectors.v1.json b/googleapiclient/discovery_cache/documents/connectors.v1.json index bb83e86d4b9..8965e5ddb8f 100644 --- a/googleapiclient/discovery_cache/documents/connectors.v1.json +++ b/googleapiclient/discovery_cache/documents/connectors.v1.json @@ -2427,7 +2427,7 @@ } } }, -"revision": "20240708", +"revision": "20240715", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2826,6 +2826,10 @@ "description": "Connection represents an instance of connector.", "id": "Connection", "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": "AuthConfig", "description": "Optional. Configuration for establishing the connection's authentication with an external system." @@ -3252,6 +3256,10 @@ "format": "int64", "type": "string" }, +"migrateDeploymentModel": { +"description": "Indicate whether connector is being migrated to cloud run deployment model.", +"type": "boolean" +}, "ratelimitThreshold": { "description": "Max QPS supported by the connector version before throttling of requests.", "format": "int64", @@ -3448,6 +3456,23 @@ ], "type": "string" }, +"deploymentModelMigrationState": { +"description": "Output only. Status of the deployment model migration.", +"enum": [ +"DEPLOYMENT_MODEL_MIGRATION_STATE_UNSPECIFIED", +"IN_PROGRESS", +"COMPLETED", +"ROLLEDBACK" +], +"enumDescriptions": [ +"Deployment model migration state is not specified.", +"Deployment model migration is in progress.", +"Deployment model migration is completed.", +"Deployment model migration rolledback." +], +"readOnly": true, +"type": "string" +}, "hpaConfig": { "$ref": "HPAConfig", "description": "Output only. HPA autoscaling config.", diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index 8323b398c1d..9a247a5d31d 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2540,7 +2540,7 @@ } } }, -"revision": "20240619", +"revision": "20240708", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2610,7 +2610,7 @@ "id": "AdditionalPodRangesConfig", "properties": { "podRangeInfo": { -"description": "Output only. [Output only] Information for additional pod range.", +"description": "Output only. Information for additional pod range.", "items": { "$ref": "RangeInfo" }, @@ -2754,11 +2754,13 @@ "id": "AutoUpgradeOptions", "properties": { "autoUpgradeStartTime": { -"description": "[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "description": { -"description": "[Output only] This field is set when upgrades are about to commence with the description of the upgrade.", +"description": "Output only. This field is set when upgrades are about to commence with the description of the upgrade.", +"readOnly": true, "type": "string" } }, @@ -3161,22 +3163,26 @@ "description": "Configuration for the fine-grained cost management feature." }, "createTime": { -"description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "currentMasterVersion": { -"description": "[Output only] The current software version of the master endpoint.", +"description": "Output only. The current software version of the master endpoint.", +"readOnly": true, "type": "string" }, "currentNodeCount": { "deprecated": true, -"description": "[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", +"description": "Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", "format": "int32", +"readOnly": true, "type": "integer" }, "currentNodeVersion": { "deprecated": true, -"description": "[Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"description": "Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"readOnly": true, "type": "string" }, "databaseEncryption": { @@ -3204,7 +3210,8 @@ "type": "boolean" }, "endpoint": { -"description": "[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", +"description": "Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", +"readOnly": true, "type": "string" }, "enterpriseConfig": { @@ -3216,7 +3223,8 @@ "type": "string" }, "expireTime": { -"description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "fleet": { @@ -3244,10 +3252,11 @@ }, "instanceGroupUrls": { "deprecated": true, -"description": "Deprecated. Use node_pools.instance_group_urls.", +"description": "Output only. Deprecated. Use node_pools.instance_group_urls.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, "ipAllocationPolicy": { @@ -3263,7 +3272,8 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"readOnly": true, "type": "string" }, "locations": { @@ -3327,8 +3337,9 @@ "description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead." }, "nodeIpv4CidrSize": { -"description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", +"description": "Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", "format": "int32", +"readOnly": true, "type": "integer" }, "nodePoolAutoConfig": { @@ -3388,11 +3399,13 @@ "description": "Enable/Disable Security Posture API features for the cluster." }, "selfLink": { -"description": "[Output only] Server-defined URL for the resource.", +"description": "Output only. Server-defined URL for the resource.", +"readOnly": true, "type": "string" }, "servicesIpv4Cidr": { -"description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", +"description": "Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", +"readOnly": true, "type": "string" }, "shieldedNodes": { @@ -3400,7 +3413,7 @@ "description": "Shielded Nodes configuration." }, "status": { -"description": "[Output only] The current status of this cluster.", +"description": "Output only. The current status of this cluster.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -3419,11 +3432,13 @@ "The ERROR state indicates the cluster is unusable. It will be automatically deleted. Details can be found in the `statusMessage` field.", "The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the `statusMessage` field." ], +"readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, -"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", +"description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", +"readOnly": true, "type": "string" }, "subnetwork": { @@ -3431,7 +3446,8 @@ "type": "string" }, "tpuIpv4CidrBlock": { -"description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", +"description": "Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", +"readOnly": true, "type": "string" }, "verticalPodAutoscaling": { @@ -3444,7 +3460,8 @@ }, "zone": { "deprecated": true, -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"readOnly": true, "type": "string" } }, @@ -3984,7 +4001,8 @@ "id": "DailyMaintenanceWindow", "properties": { "duration": { -"description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"PTnHnMnS\".", +"description": "Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format \"PTnHnMnS\".", +"readOnly": true, "type": "string" }, "startTime": { @@ -4091,7 +4109,7 @@ "id": "EnterpriseConfig", "properties": { "clusterTier": { -"description": "Output only. [Output only] cluster_tier specifies the premium tier of the cluster.", +"description": "Output only. cluster_tier specifies the premium tier of the cluster.", "enum": [ "CLUSTER_TIER_UNSPECIFIED", "STANDARD", @@ -4162,11 +4180,13 @@ "id": "Fleet", "properties": { "membership": { -"description": "[Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", +"description": "Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", +"readOnly": true, "type": "string" }, "preRegistered": { -"description": "[Output only] Whether the cluster has been registered through the fleet API.", +"description": "Output only. Whether the cluster has been registered through the fleet API.", +"readOnly": true, "type": "boolean" }, "project": { @@ -4468,7 +4488,7 @@ false "properties": { "additionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", -"description": "Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", +"description": "Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", "readOnly": true }, "clusterIpv4Cidr": { @@ -4489,7 +4509,7 @@ false "type": "boolean" }, "defaultPodIpv4RangeUtilization": { -"description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", +"description": "Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -4531,7 +4551,7 @@ false "type": "string" }, "servicesIpv6CidrBlock": { -"description": "Output only. [Output only] The services IPv6 CIDR block for the cluster.", +"description": "Output only. The services IPv6 CIDR block for the cluster.", "readOnly": true, "type": "string" }, @@ -4554,7 +4574,7 @@ false "type": "string" }, "subnetIpv6CidrBlock": { -"description": "Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.", +"description": "Output only. The subnet's IPv6 CIDR block used by nodes and pods.", "readOnly": true, "type": "string" }, @@ -4932,7 +4952,8 @@ false "id": "MasterAuth", "properties": { "clientCertificate": { -"description": "[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"readOnly": true, "type": "string" }, "clientCertificateConfig": { @@ -4940,11 +4961,13 @@ false "description": "Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued." }, "clientKey": { -"description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.", +"readOnly": true, "type": "string" }, "clusterCaCertificate": { -"description": "[Output only] Base64-encoded public certificate that is the root of trust for the cluster.", +"description": "Output only. Base64-encoded public certificate that is the root of trust for the cluster.", +"readOnly": true, "type": "string" }, "password": { @@ -5161,6 +5184,7 @@ false }, "network": { "description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", +"readOnly": true, "type": "string" }, "networkPerformanceConfig": { @@ -5189,6 +5213,7 @@ false }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", +"readOnly": true, "type": "string" } }, @@ -5605,7 +5630,7 @@ false "type": "string" }, "podIpv4RangeUtilization": { -"description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", +"description": "Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -5650,10 +5675,11 @@ false "type": "integer" }, "instanceGroupUrls": { -"description": "[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", +"description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, "locations": { @@ -5684,8 +5710,9 @@ false "description": "Specifies the node placement policy." }, "podIpv4CidrSize": { -"description": "[Output only] The pod CIDR block size per node in this node pool.", +"description": "Output only. The pod CIDR block size per node in this node pool.", "format": "int32", +"readOnly": true, "type": "integer" }, "queuedProvisioning": { @@ -5693,11 +5720,12 @@ false "description": "Specifies the configuration of queued provisioning." }, "selfLink": { -"description": "[Output only] Server-defined URL for the resource.", +"description": "Output only. Server-defined URL for the resource.", +"readOnly": true, "type": "string" }, "status": { -"description": "[Output only] The status of the nodes in this pool instance.", +"description": "Output only. The status of the nodes in this pool instance.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -5716,16 +5744,18 @@ false "The STOPPING state indicates the node pool is being deleted.", "The ERROR state indicates the node pool may be unusable. Details can be found in the `statusMessage` field." ], +"readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, -"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", +"description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", +"readOnly": true, "type": "string" }, "updateInfo": { "$ref": "UpdateInfo", -"description": "Output only. [Output only] Update info contains relevant information during a node pool update.", +"description": "Output only. Update info contains relevant information during a node pool update.", "readOnly": true }, "upgradeSettings": { @@ -5898,11 +5928,13 @@ false "type": "array" }, "detail": { -"description": "Detailed operation progress, if available.", +"description": "Output only. Detailed operation progress, if available.", +"readOnly": true, "type": "string" }, "endTime": { -"description": "[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "error": { @@ -5910,11 +5942,13 @@ false "description": "The error result of the operation in case of failure." }, "location": { -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"readOnly": true, "type": "string" }, "name": { -"description": "The server-assigned ID for the operation.", +"description": "Output only. The server-assigned ID for the operation.", +"readOnly": true, "type": "string" }, "nodepoolConditions": { @@ -5926,7 +5960,7 @@ false "type": "array" }, "operationType": { -"description": "The operation type.", +"description": "Output only. The operation type.", "enum": [ "TYPE_UNSPECIFIED", "CREATE_CLUSTER", @@ -5990,23 +6024,26 @@ false "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], +"readOnly": true, "type": "string" }, "progress": { "$ref": "OperationProgress", -"description": "Output only. [Output only] Progress information for an operation.", +"description": "Output only. Progress information for an operation.", "readOnly": true }, "selfLink": { -"description": "Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", +"description": "Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", +"readOnly": true, "type": "string" }, "startTime": { -"description": "[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "status": { -"description": "The current status of the operation.", +"description": "Output only. The current status of the operation.", "enum": [ "STATUS_UNSPECIFIED", "PENDING", @@ -6021,6 +6058,7 @@ false "The operation is done, either cancelled or completed.", "The operation is aborting." ], +"readOnly": true, "type": "string" }, "statusMessage": { @@ -6030,12 +6068,14 @@ false "type": "string" }, "targetLink": { -"description": "Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", +"description": "Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", +"readOnly": true, "type": "string" }, "zone": { "deprecated": true, -"description": "The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"readOnly": true, "type": "string" } }, @@ -6182,10 +6222,12 @@ false }, "peeringName": { "description": "Output only. The peering name in the customer VPC used by this cluster.", +"readOnly": true, "type": "string" }, "privateEndpoint": { "description": "Output only. The internal IP address of this cluster's master endpoint.", +"readOnly": true, "type": "string" }, "privateEndpointSubnetwork": { @@ -6194,6 +6236,7 @@ false }, "publicEndpoint": { "description": "Output only. The external IP address of this cluster's master endpoint.", +"readOnly": true, "type": "string" } }, @@ -6263,12 +6306,12 @@ false "id": "RangeInfo", "properties": { "rangeName": { -"description": "Output only. [Output only] Name of a range.", +"description": "Output only. Name of a range.", "readOnly": true, "type": "string" }, "utilization": { -"description": "Output only. [Output only] The utilization of the range.", +"description": "Output only. The utilization of the range.", "format": "double", "readOnly": true, "type": "number" @@ -6342,13 +6385,15 @@ false "UNSPECIFIED", "RAPID", "REGULAR", -"STABLE" +"STABLE", +"EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", -"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." +"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", +"Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" } @@ -6365,13 +6410,15 @@ false "UNSPECIFIED", "RAPID", "REGULAR", -"STABLE" +"STABLE", +"EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", -"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." +"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", +"Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 7917e6d74c5..985166d095b 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2565,7 +2565,7 @@ } } }, -"revision": "20240619", +"revision": "20240708", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2641,7 +2641,7 @@ "id": "AdditionalPodRangesConfig", "properties": { "podRangeInfo": { -"description": "Output only. [Output only] Information for additional pod range.", +"description": "Output only. Information for additional pod range.", "items": { "$ref": "RangeInfo" }, @@ -2795,11 +2795,13 @@ "id": "AutoUpgradeOptions", "properties": { "autoUpgradeStartTime": { -"description": "[Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "description": { -"description": "[Output only] This field is set when upgrades are about to commence with the description of the upgrade.", +"description": "Output only. This field is set when upgrades are about to commence with the description of the upgrade.", +"readOnly": true, "type": "string" } }, @@ -3274,22 +3276,26 @@ "description": "Configuration for the fine-grained cost management feature." }, "createTime": { -"description": "[Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "currentMasterVersion": { -"description": "[Output only] The current software version of the master endpoint.", +"description": "Output only. The current software version of the master endpoint.", +"readOnly": true, "type": "string" }, "currentNodeCount": { "deprecated": true, -"description": "[Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", +"description": "Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.", "format": "int32", +"readOnly": true, "type": "integer" }, "currentNodeVersion": { "deprecated": true, -"description": "[Output only] Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"description": "Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.", +"readOnly": true, "type": "string" }, "databaseEncryption": { @@ -3317,7 +3323,8 @@ "type": "boolean" }, "endpoint": { -"description": "[Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", +"description": "Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.", +"readOnly": true, "type": "string" }, "enterpriseConfig": { @@ -3329,7 +3336,8 @@ "type": "string" }, "expireTime": { -"description": "[Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "fleet": { @@ -3357,10 +3365,11 @@ }, "instanceGroupUrls": { "deprecated": true, -"description": "Deprecated. Use node_pools.instance_group_urls.", +"description": "Output only. Deprecated. Use node_pools.instance_group_urls.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, "ipAllocationPolicy": { @@ -3376,7 +3385,8 @@ "description": "Configuration for the legacy ABAC authorization mode." }, "location": { -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"readOnly": true, "type": "string" }, "locations": { @@ -3449,8 +3459,9 @@ "description": "Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a \"node_pool\" object, since this configuration (along with the \"initial_node_count\") will be used to create a \"NodePool\" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see `node_pool.config`) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead." }, "nodeIpv4CidrSize": { -"description": "[Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", +"description": "Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.", "format": "int32", +"readOnly": true, "type": "integer" }, "nodePoolAutoConfig": { @@ -3528,11 +3539,13 @@ "description": "Enable/Disable Security Posture API features for the cluster." }, "selfLink": { -"description": "[Output only] Server-defined URL for the resource.", +"description": "Output only. Server-defined URL for the resource.", +"readOnly": true, "type": "string" }, "servicesIpv4Cidr": { -"description": "[Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", +"description": "Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.", +"readOnly": true, "type": "string" }, "shieldedNodes": { @@ -3540,7 +3553,7 @@ "description": "Shielded Nodes configuration." }, "status": { -"description": "[Output only] The current status of this cluster.", +"description": "Output only. The current status of this cluster.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -3559,11 +3572,13 @@ "The ERROR state indicates the cluster may be unusable. Details can be found in the `statusMessage` field.", "The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the `statusMessage` field." ], +"readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, -"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", +"description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.", +"readOnly": true, "type": "string" }, "subnetwork": { @@ -3575,7 +3590,8 @@ "description": "Configuration for Cloud TPU support;" }, "tpuIpv4CidrBlock": { -"description": "[Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", +"description": "Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).", +"readOnly": true, "type": "string" }, "verticalPodAutoscaling": { @@ -3596,7 +3612,8 @@ }, "zone": { "deprecated": true, -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.", +"readOnly": true, "type": "string" } }, @@ -4240,7 +4257,8 @@ "id": "DailyMaintenanceWindow", "properties": { "duration": { -"description": "[Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario.", +"description": "Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario.", +"readOnly": true, "type": "string" }, "startTime": { @@ -4369,7 +4387,7 @@ "id": "EnterpriseConfig", "properties": { "clusterTier": { -"description": "Output only. [Output only] cluster_tier specifies the premium tier of the cluster.", +"description": "Output only. cluster_tier specifies the premium tier of the cluster.", "enum": [ "CLUSTER_TIER_UNSPECIFIED", "STANDARD", @@ -4452,11 +4470,13 @@ "id": "Fleet", "properties": { "membership": { -"description": "[Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", +"description": "Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.", +"readOnly": true, "type": "string" }, "preRegistered": { -"description": "[Output only] Whether the cluster has been registered through the fleet API.", +"description": "Output only. Whether the cluster has been registered through the fleet API.", +"readOnly": true, "type": "boolean" }, "project": { @@ -4783,7 +4803,7 @@ false "properties": { "additionalPodRangesConfig": { "$ref": "AdditionalPodRangesConfig", -"description": "Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", +"description": "Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.", "readOnly": true }, "allowRouteOverlap": { @@ -4808,7 +4828,7 @@ false "type": "boolean" }, "defaultPodIpv4RangeUtilization": { -"description": "Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", +"description": "Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -4850,7 +4870,7 @@ false "type": "string" }, "servicesIpv6CidrBlock": { -"description": "Output only. [Output only] The services IPv6 CIDR block for the cluster.", +"description": "Output only. The services IPv6 CIDR block for the cluster.", "readOnly": true, "type": "string" }, @@ -4873,7 +4893,7 @@ false "type": "string" }, "subnetIpv6CidrBlock": { -"description": "Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.", +"description": "Output only. The subnet's IPv6 CIDR block used by nodes and pods.", "readOnly": true, "type": "string" }, @@ -5341,7 +5361,8 @@ false "id": "MasterAuth", "properties": { "clientCertificate": { -"description": "[Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.", +"readOnly": true, "type": "string" }, "clientCertificateConfig": { @@ -5349,10 +5370,13 @@ false "description": "Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued." }, "clientKey": { -"description": "[Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.", +"description": "Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.", +"readOnly": true, "type": "string" }, "clusterCaCertificate": { +"description": "Output only. Base64-encoded public certificate that is the root of trust for the cluster.", +"readOnly": true, "type": "string" }, "password": { @@ -5588,6 +5612,7 @@ false }, "network": { "description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", +"readOnly": true, "type": "string" }, "networkPerformanceConfig": { @@ -5616,6 +5641,7 @@ false }, "subnetwork": { "description": "Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet", +"readOnly": true, "type": "string" } }, @@ -6056,7 +6082,7 @@ false "type": "string" }, "podIpv4RangeUtilization": { -"description": "Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", +"description": "Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.", "format": "double", "readOnly": true, "type": "number" @@ -6101,10 +6127,11 @@ false "type": "integer" }, "instanceGroupUrls": { -"description": "[Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", +"description": "Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, "locations": { @@ -6135,8 +6162,9 @@ false "description": "Specifies the node placement policy." }, "podIpv4CidrSize": { -"description": "[Output only] The pod CIDR block size per node in this node pool.", +"description": "Output only. The pod CIDR block size per node in this node pool.", "format": "int32", +"readOnly": true, "type": "integer" }, "queuedProvisioning": { @@ -6144,11 +6172,12 @@ false "description": "Specifies the configuration of queued provisioning." }, "selfLink": { -"description": "[Output only] Server-defined URL for the resource.", +"description": "Output only. Server-defined URL for the resource.", +"readOnly": true, "type": "string" }, "status": { -"description": "[Output only] The status of the nodes in this pool instance.", +"description": "Output only. The status of the nodes in this pool instance.", "enum": [ "STATUS_UNSPECIFIED", "PROVISIONING", @@ -6167,16 +6196,18 @@ false "The STOPPING state indicates the node pool is being deleted.", "The ERROR state indicates the node pool may be unusable. Details can be found in the `statusMessage` field." ], +"readOnly": true, "type": "string" }, "statusMessage": { "deprecated": true, -"description": "[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", +"description": "Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.", +"readOnly": true, "type": "string" }, "updateInfo": { "$ref": "UpdateInfo", -"description": "Output only. [Output only] Update info contains relevant information during a node pool update.", +"description": "Output only. Update info contains relevant information during a node pool update.", "readOnly": true }, "upgradeSettings": { @@ -6349,11 +6380,13 @@ false "type": "array" }, "detail": { -"description": "Detailed operation progress, if available.", +"description": "Output only. Detailed operation progress, if available.", +"readOnly": true, "type": "string" }, "endTime": { -"description": "[Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "error": { @@ -6361,11 +6394,13 @@ false "description": "The error result of the operation in case of failure." }, "location": { -"description": "[Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.", +"readOnly": true, "type": "string" }, "name": { -"description": "The server-assigned ID for the operation.", +"description": "Output only. The server-assigned ID for the operation.", +"readOnly": true, "type": "string" }, "nodepoolConditions": { @@ -6377,7 +6412,7 @@ false "type": "array" }, "operationType": { -"description": "The operation type.", +"description": "Output only. The operation type.", "enum": [ "TYPE_UNSPECIFIED", "CREATE_CLUSTER", @@ -6441,23 +6476,26 @@ false "The control plane is being resized. This operation type is initiated by GKE. These operations are often performed preemptively to ensure that the control plane has sufficient resources and is not typically an indication of issues. For more details, see [documentation on resizes](https://cloud.google.com/kubernetes-engine/docs/concepts/maintenance-windows-and-exclusions#repairs).", "Fleet features of GKE Enterprise are being upgraded. The cluster should be assumed to be blocked for other upgrades until the operation finishes." ], +"readOnly": true, "type": "string" }, "progress": { "$ref": "OperationProgress", -"description": "Output only. [Output only] Progress information for an operation.", +"description": "Output only. Progress information for an operation.", "readOnly": true }, "selfLink": { -"description": "Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", +"description": "Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.", +"readOnly": true, "type": "string" }, "startTime": { -"description": "[Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"description": "Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", +"readOnly": true, "type": "string" }, "status": { -"description": "The current status of the operation.", +"description": "Output only. The current status of the operation.", "enum": [ "STATUS_UNSPECIFIED", "PENDING", @@ -6472,6 +6510,7 @@ false "The operation is done, either cancelled or completed.", "The operation is aborting." ], +"readOnly": true, "type": "string" }, "statusMessage": { @@ -6481,12 +6520,14 @@ false "type": "string" }, "targetLink": { -"description": "Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", +"description": "Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`", +"readOnly": true, "type": "string" }, "zone": { "deprecated": true, -"description": "The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"description": "Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.", +"readOnly": true, "type": "string" } }, @@ -6677,10 +6718,12 @@ false }, "peeringName": { "description": "Output only. The peering name in the customer VPC used by this cluster.", +"readOnly": true, "type": "string" }, "privateEndpoint": { "description": "Output only. The internal IP address of this cluster's master endpoint.", +"readOnly": true, "type": "string" }, "privateEndpointSubnetwork": { @@ -6689,6 +6732,7 @@ false }, "publicEndpoint": { "description": "Output only. The external IP address of this cluster's master endpoint.", +"readOnly": true, "type": "string" } }, @@ -6783,12 +6827,12 @@ false "id": "RangeInfo", "properties": { "rangeName": { -"description": "Output only. [Output only] Name of a range.", +"description": "Output only. Name of a range.", "readOnly": true, "type": "string" }, "utilization": { -"description": "Output only. [Output only] The utilization of the range.", +"description": "Output only. The utilization of the range.", "format": "double", "readOnly": true, "type": "number" @@ -6862,13 +6906,15 @@ false "UNSPECIFIED", "RAPID", "REGULAR", -"STABLE" +"STABLE", +"EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", -"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." +"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", +"Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" } @@ -6893,13 +6939,15 @@ false "UNSPECIFIED", "RAPID", "REGULAR", -"STABLE" +"STABLE", +"EXTENDED" ], "enumDescriptions": [ "No channel specified.", "RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs.", "Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features.", -"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production." +"Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production.", +"Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/content.v2.1.json b/googleapiclient/discovery_cache/documents/content.v2.1.json index b4279a8319c..b742c78e08a 100644 --- a/googleapiclient/discovery_cache/documents/content.v2.1.json +++ b/googleapiclient/discovery_cache/documents/content.v2.1.json @@ -6219,7 +6219,7 @@ } } }, -"revision": "20240614", +"revision": "20240723", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { @@ -10806,6 +10806,10 @@ false "format": "int64", "type": "string" }, +"memberPriceEffectiveDate": { +"description": "Optional. A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash.", +"type": "string" +}, "price": { "$ref": "Price", "description": "Optional. The price for members of the given tier (instant discount price). Must be smaller or equal to the regular price." @@ -14496,7 +14500,7 @@ false "type": "array" }, "source": { -"description": "The source of the offer, that is, how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", +"description": "Output only. The source of the offer, that is, how the offer was created. Acceptable values are: - \"`api`\" - \"`crawl`\" - \"`feed`\" ", "type": "string" }, "structuredDescription": { diff --git a/googleapiclient/discovery_cache/documents/css.v1.json b/googleapiclient/discovery_cache/documents/css.v1.json index 94e5ccbf865..4330d0100cf 100644 --- a/googleapiclient/discovery_cache/documents/css.v1.json +++ b/googleapiclient/discovery_cache/documents/css.v1.json @@ -472,7 +472,7 @@ } } }, -"revision": "20240614", +"revision": "20240719", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -820,19 +820,19 @@ "type": "object" }, "Certification": { -"description": "The certification for the product.", +"description": "The certification for the product. Use the this attribute to describe certifications, such as energy efficiency ratings, associated with a product.", "id": "Certification", "properties": { "authority": { -"description": "Name of the certification body.", +"description": "The authority or certification body responsible for issuing the certification. At this time, the most common value is \"EC\" or \u201cEuropean_Commission\u201d for energy labels in the EU.", "type": "string" }, "code": { -"description": "A unique code to identify the certification.", +"description": "The code of the certification. For example, for the EPREL certificate with the link https://eprel.ec.europa.eu/screen/product/dishwashers2019/123456 the code is 123456. The code is required for European Energy Labels.", "type": "string" }, "name": { -"description": "Name of the certification.", +"description": "The name of the certification. At this time, the most common value is \"EPREL\", which represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 3d334b12234..4dd38b02dbe 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8082,7 +8082,7 @@ } } }, -"revision": "20240704", +"revision": "20240716", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -15708,7 +15708,7 @@ true "id": "GoogleCloudDialogflowV2beta1AudioInput", "properties": { "audio": { -"description": "Required. The natural language speech audio to be processed. A single request can contain up to 1 minute of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions.", +"description": "Required. The natural language speech audio to be processed. A single request can contain up to 2 minutes of speech audio data. The transcribed text cannot contain more than 256 bytes for virtual agent interactions.", "format": "byte", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json index 333411ed03b..a8cc9cb0323 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1.json @@ -5428,6 +5428,80 @@ } } }, +"identity_mapping_stores": { +"resources": { +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "operations": { "methods": { "get": { @@ -5711,7 +5785,7 @@ } } }, -"revision": "20240704", +"revision": "20240715", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -6252,7 +6326,7 @@ "type": "string" }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -6403,7 +6477,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1Answer", -"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +"description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -6667,7 +6741,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" }, "title": { @@ -9753,7 +9827,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -11263,7 +11337,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" }, "title": { @@ -11582,6 +11656,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", @@ -11616,6 +11696,17 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { +"description": "Defines custom fine tuning spec.", +"id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"properties": { +"enableSearchAdaptor": { +"description": "Whether or not to enable and include custom fine tuned search adaptor model.", +"type": "boolean" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { "description": "Metadata that describes a custom tuned model.", "id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", @@ -12322,6 +12413,96 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", @@ -12505,6 +12686,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaIdpConfig": { "description": "Identity Provider Config.", "id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", @@ -12647,6 +12846,56 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", @@ -12743,6 +12992,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1alphaInterval", +"properties": { +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" +}, +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaLanguageInfo": { "description": "Language info for DataStore.", "id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", @@ -13049,6 +13325,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", @@ -13203,561 +13533,732 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaSession": { -"description": "External session proto definition.", -"id": "GoogleCloudDiscoveryengineV1alphaSession", +"GoogleCloudDiscoveryengineV1alphaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { -"endTime": { -"description": "Output only. The time the session finished.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" }, -"name": { -"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, -"startTime": { -"description": "Output only. The time the session started.", -"format": "google-datetime", -"readOnly": true, +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" }, -"state": { -"description": "The state of the session.", -"enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS" -], -"enumDescriptions": [ -"State is unspecified.", -"The session is currently open." -], -"type": "string" +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." }, -"turns": { -"description": "Turns.", +"customFineTuningSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." +}, +"dataStoreSpecs": { +"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" }, -"userPseudoId": { -"description": "A unique identifier for tracking users.", +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", "type": "string" -} }, -"type": "object" +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", +"description": "Raw image query." }, -"GoogleCloudDiscoveryengineV1alphaSessionTurn": { -"description": "Represents a turn, including a query from the user and a answer from service.", -"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", -"properties": { -"answer": { -"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", "type": "string" }, -"query": { -"$ref": "GoogleCloudDiscoveryengineV1alphaQuery", -"description": "The user query." -} +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." }, -"type": "object" +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" }, -"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { -"description": "Verification information for target sites in advanced site search.", -"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", -"properties": { -"siteVerificationState": { -"description": "Site verification state indicating the ownership and validity.", -"enum": [ -"SITE_VERIFICATION_STATE_UNSPECIFIED", -"VERIFIED", -"UNVERIFIED", -"EXEMPTED" -], -"enumDescriptions": [ -"Defaults to VERIFIED.", -"Site ownership verified.", -"Site ownership pending verification or verification failed.", -"Site exempt from verification, e.g., a public website that opens to all." -], +"orderBy": { +"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, -"verifyTime": { -"description": "Latest site verification time.", -"format": "google-datetime", +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" -} }, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSite": { -"description": "A target site for the SiteSearchEngine.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSite", -"properties": { -"exactMatch": { -"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", -"type": "boolean" +"query": { +"description": "Raw search query.", +"type": "string" }, -"failureReason": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", -"description": "Output only. Failure reason.", -"readOnly": true +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, -"generatedUriPattern": { -"description": "Output only. This is system-generated based on the provided_uri_pattern.", -"readOnly": true, +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, -"indexingStatus": { -"description": "Output only. Indexing status.", +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", +"type": "string" +}, +"relevanceThreshold": { +"description": "The relevance threshold of the search results. Default to Google defined threshold, leveraging a balance of precision and recall to deliver both highly accurate results and comprehensive coverage of relevant information.", "enum": [ -"INDEXING_STATUS_UNSPECIFIED", -"PENDING", -"FAILED", -"SUCCEEDED", -"DELETING" +"RELEVANCE_THRESHOLD_UNSPECIFIED", +"LOWEST", +"LOW", +"MEDIUM", +"HIGH" ], "enumDescriptions": [ -"Defaults to SUCCEEDED.", -"The target site is in the update queue and will be picked up by indexing pipeline.", -"The target site fails to be indexed.", -"The target site has been indexed.", -"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." +"Default value. In this case, server behavior defaults to Google defined threshold.", +"Lowest relevance threshold.", +"Low relevance threshold.", +"Medium relevance threshold.", +"High relevance threshold." ], -"readOnly": true, "type": "string" }, -"name": { -"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", -"readOnly": true, -"type": "string" +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" }, -"providedUriPattern": { -"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." +}, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, -"rootDomainUri": { -"description": "Output only. Root domain of the provided_uri_pattern.", -"readOnly": true, +"session": { +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" }, -"siteVerificationInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", -"description": "Output only. Site ownership and validity verification status.", -"readOnly": true +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." }, -"type": { -"description": "The type of the target site, e.g., whether the site is to be included or excluded.", -"enum": [ -"TYPE_UNSPECIFIED", -"INCLUDE", -"EXCLUDE" -], -"enumDescriptions": [ -"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", -"Include the target site.", -"Exclude the target site." -], -"type": "string" +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, -"updateTime": { -"description": "Output only. The target site's last updated time.", -"format": "google-datetime", -"readOnly": true, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." +}, +"userLabels": { +"additionalProperties": { "type": "string" -} }, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { -"description": "Site search indexing failure reasons.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", -"properties": { -"quotaFailure": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", -"description": "Failed due to insufficient quota." +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { -"description": "Failed due to insufficient quota.", -"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { -"totalRequiredQuota": { -"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", -"format": "int64", -"type": "string" +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { -"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." +}, +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { -"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the data.", +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, "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.", +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", "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.", +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { -"description": "Metadata associated with a tune operation.", -"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { -"engine": { -"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" -} }, -"type": "object" +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} }, -"GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { -"description": "Response associated with a tune operation.", -"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { -"description": "Metadata for UpdateSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], "type": "string" +}, +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", +"properties": { +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" +}, +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" +}, +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" +}, +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", +"properties": { +"maxSnippetCount": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", +"format": "int32", +"type": "integer" +}, +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" +}, +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", +"properties": { +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" +}, +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" +}, +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" +}, +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"properties": { +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "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", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" +} }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { +"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { -"targetSites": { -"description": "TargetSites created.", +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCondition": { -"description": "Defines circumstances to be checked before allowing a behavior", -"id": "GoogleCloudDiscoveryengineV1betaCondition", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { -"activeTimeRange": { -"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" -}, -"type": "array" +"fieldPath": { +"description": "Embedding field path in schema.", +"type": "string" }, -"queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"vector": { +"description": "Query embedding vector.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" +"format": "float", +"type": "number" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { -"description": "Matcher for search request query", -"id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { -"fullMatch": { -"description": "Whether the search query needs to exactly match the query term.", +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", "type": "boolean" }, -"value": { -"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" -} }, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1betaConditionTimeRange": { -"description": "Used for time-dependent conditions.", -"id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", -"properties": { -"endTime": { -"description": "End of time range. Range is inclusive. Must be in the future.", -"format": "google-datetime", -"type": "string" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"startTime": { -"description": "Start of time range. Range is inclusive.", -"format": "google-datetime", -"type": "string" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControl": { -"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", -"id": "GoogleCloudDiscoveryengineV1betaControl", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { -"associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" +}, +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, -"readOnly": true, "type": "array" }, -"boostAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", -"description": "Defines a boost-type control" -}, -"conditions": { -"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaCondition" +"$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, "type": "array" }, -"displayName": { -"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, -"filterAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", -"description": "Defines a filter-type control Currently not supported by Recommendation" +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", +"type": "string" }, -"name": { -"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"redirectAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", -"description": "Defines a redirect-type control." +"type": "array" }, -"solutionType": { -"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"synonymsAction": { -"$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", -"description": "Treats a group of terms as synonyms of one another." +"type": "array" +} }, -"useCases": { -"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", -"items": { +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", +"properties": { +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"properties": { +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", "enum": [ -"SEARCH_USE_CASE_UNSPECIFIED", -"SEARCH_USE_CASE_SEARCH", -"SEARCH_USE_CASE_BROWSE" +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" ], "enumDescriptions": [ -"Value used when unset. Will not occur in CSS.", -"Search use case. Expects the traffic has a non-empty query.", -"Browse use case. Expects the traffic has an empty query." +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." ], "type": "string" }, +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", +"items": { +"type": "string" +}, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlBoostAction": { -"description": "Adjusts order of products in returned list.", -"id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { -"boost": { -"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", -"format": "float", -"type": "number" -}, -"dataStore": { -"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], "type": "string" }, -"filter": { -"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", -"type": "string" +"pinUnexpandedResults": { +"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlFilterAction": { -"description": "Specified which products may be included in results. Uses same filter as boost.", -"id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "properties": { -"dataStore": { -"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", -"type": "string" -}, -"filter": { -"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlRedirectAction": { -"description": "Redirects a shopper to the provided URI.", -"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { +"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", "properties": { -"redirectUri": { -"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"queryId": { +"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" +}, +"searchResultPersistenceCount": { +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { -"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", -"id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", +"GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", "properties": { -"synonyms": { -"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", +"GoogleCloudDiscoveryengineV1alphaSession": { +"description": "External session proto definition.", +"id": "GoogleCloudDiscoveryengineV1alphaSession", "properties": { -"createTime": { -"description": "Operation create time.", +"endTime": { +"description": "Output only. The time the session finished.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"name": { +"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`", +"type": "string" +}, +"startTime": { +"description": "Output only. The time the session started.", "format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "The state of the session.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS" +], +"enumDescriptions": [ +"State is unspecified.", +"The session is currently open." +], +"type": "string" +}, +"turns": { +"description": "Turns.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSessionTurn" +}, +"type": "array" +}, +"userPseudoId": { +"description": "A unique identifier for tracking users.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaSessionTurn": { +"description": "Represents a turn, including a query from the user and a answer from service.", +"id": "GoogleCloudDiscoveryengineV1alphaSessionTurn", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"answer": { +"description": "The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"query": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQuery", +"description": "The user query." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13772,178 +14273,145 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { +"description": "Verification information for target sites in advanced site search.", +"id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"siteVerificationState": { +"description": "Site verification state indicating the ownership and validity.", +"enum": [ +"SITE_VERIFICATION_STATE_UNSPECIFIED", +"VERIFIED", +"UNVERIFIED", +"EXEMPTED" +], +"enumDescriptions": [ +"Defaults to VERIFIED.", +"Site ownership verified.", +"Site ownership pending verification or verification failed.", +"Site exempt from verification, e.g., a public website that opens to all." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"verifyTime": { +"description": "Latest site verification time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaCustomTuningModel": { -"description": "Metadata that describes a custom tuned model.", -"id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", +"GoogleCloudDiscoveryengineV1alphaTargetSite": { +"description": "A target site for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSite", "properties": { -"createTime": { -"deprecated": true, -"description": "Timestamp the Model was created at.", -"format": "google-datetime", -"type": "string" +"exactMatch": { +"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", +"type": "boolean" }, -"displayName": { -"description": "The display name of the model.", -"type": "string" +"failureReason": { +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", +"description": "Output only. Failure reason.", +"readOnly": true }, -"metrics": { -"additionalProperties": { -"format": "double", -"type": "number" -}, -"description": "The metrics of the trained model.", -"type": "object" +"generatedUriPattern": { +"description": "Output only. This is system-generated based on the provided_uri_pattern.", +"readOnly": true, +"type": "string" }, -"modelState": { -"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", +"indexingStatus": { +"description": "Output only. Indexing status.", "enum": [ -"MODEL_STATE_UNSPECIFIED", -"TRAINING_PAUSED", -"TRAINING", -"TRAINING_COMPLETE", -"READY_FOR_SERVING", -"TRAINING_FAILED", -"NO_IMPROVEMENT" +"INDEXING_STATUS_UNSPECIFIED", +"PENDING", +"FAILED", +"SUCCEEDED", +"DELETING" ], "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." +"Defaults to SUCCEEDED.", +"The target site is in the update queue and will be picked up by indexing pipeline.", +"The target site fails to be indexed.", +"The target site has been indexed.", +"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." ], +"readOnly": true, "type": "string" }, -"modelVersion": { -"description": "The version of the model.", -"format": "int64", +"name": { +"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", +"readOnly": true, "type": "string" }, -"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.", +"providedUriPattern": { +"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", "type": "string" }, -"trainingStartTime": { -"description": "Timestamp the model training was initiated.", -"format": "google-datetime", +"rootDomainUri": { +"description": "Output only. Root domain of the provided_uri_pattern.", +"readOnly": true, "type": "string" -} }, -"type": "object" +"siteVerificationInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", +"description": "Output only. Site ownership and validity verification status.", +"readOnly": true }, -"GoogleCloudDiscoveryengineV1betaDataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1betaDataStore", -"properties": { -"contentConfig": { -"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"type": { +"description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"TYPE_UNSPECIFIED", +"INCLUDE", +"EXCLUDE" ], "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." +"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", +"Include the target site.", +"Exclude the target site." ], "type": "string" }, -"createTime": { -"description": "Output only. Timestamp the DataStore was created at.", +"updateTime": { +"description": "Output only. The target site's last updated time.", "format": "google-datetime", "readOnly": true, "type": "string" +} }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", -"readOnly": true, -"type": "string" -}, -"displayName": { -"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", -"type": "string" -}, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." -}, -"industryVertical": { -"description": "Immutable. The industry vertical that the data store registers.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], -"type": "string" +"type": "object" }, -"languageInfo": { -"$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", -"description": "Language info for DataStore." +"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason": { +"description": "Site search indexing failure reasons.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReason", +"properties": { +"quotaFailure": { +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", +"description": "Failed due to insufficient quota." +} }, -"name": { -"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", -"type": "string" +"type": "object" }, -"solutionTypes": { -"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", -"items": { -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], +"GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure": { +"description": "Failed due to insufficient quota.", +"id": "GoogleCloudDiscoveryengineV1alphaTargetSiteFailureReasonQuotaFailure", +"properties": { +"totalRequiredQuota": { +"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", +"format": "int64", "type": "string" -}, -"type": "array" -}, -"startingSchema": { -"$ref": "GoogleCloudDiscoveryengineV1betaSchema", -"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", +"GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata": { +"description": "Metadata related to the progress of the TrainCustomModel operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13958,26 +14426,60 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse": { +"description": "Response of the TrainCustomModelRequest. This message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaTrainCustomModelResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the data.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"metrics": { +"additionalProperties": { +"format": "double", +"type": "number" +}, +"description": "The metrics of the trained model.", +"type": "object" +}, +"modelName": { +"description": "Fully qualified name of the CustomTuningModel.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"modelStatus": { +"description": "The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata": { +"description": "Metadata associated with a tune operation.", +"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineMetadata", +"properties": { +"engine": { +"description": "Required. The resource name of the engine that this tune applies to. Format: `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaTuneEngineResponse": { +"description": "Response associated with a tune operation.", +"id": "GoogleCloudDiscoveryengineV1alphaTuneEngineResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata": { +"description": "Metadata for UpdateSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -13992,9 +14494,9 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaUpdateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14009,9 +14511,24 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1alphaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -14026,198 +14543,114 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { -"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1betaBatchCreateTargetSitesResponse", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." -}, -"defaultParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", -"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." -}, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", -"type": "string" -}, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" +"targetSites": { +"description": "TargetSites created.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaTargetSite" }, -"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", -"type": "object" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1betaCondition": { +"description": "Defines circumstances to be checked before allowing a behavior", +"id": "GoogleCloudDiscoveryengineV1betaCondition", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." -} +"activeTimeRange": { +"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaConditionTimeRange" }, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" +"queryTerms": { +"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm" }, -"includeAncestorHeadings": { -"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", -"type": "boolean" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"GoogleCloudDiscoveryengineV1betaConditionQueryTerm": { +"description": "Matcher for search request query", +"id": "GoogleCloudDiscoveryengineV1betaConditionQueryTerm", "properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." -}, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." -}, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, -"type": "object" +"fullMatch": { +"description": "Whether the search query needs to exactly match the query term.", +"type": "boolean" }, -"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"properties": { -"enhancedDocumentElements": { -"deprecated": true, -"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", -"items": { +"value": { +"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" -}, -"type": "array" -}, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1betaConditionTimeRange": { +"description": "Used for time-dependent conditions.", +"id": "GoogleCloudDiscoveryengineV1betaConditionTimeRange", "properties": { -"createTime": { -"description": "Operation create time.", +"endTime": { +"description": "End of time range. Range is inclusive. Must be in the future.", "format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"startTime": { +"description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaEngine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngine", +"GoogleCloudDiscoveryengineV1betaControl": { +"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", +"id": "GoogleCloudDiscoveryengineV1betaControl", "properties": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." -}, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true -}, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"associatedServingConfigIds": { +"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"items": { +"type": "string" }, -"createTime": { -"description": "Output only. Timestamp the Recommendation Engine was created at.", -"format": "google-datetime", "readOnly": true, -"type": "string" +"type": "array" }, -"dataStoreIds": { -"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", +"boostAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlBoostAction", +"description": "Defines a boost-type control" +}, +"conditions": { +"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { -"type": "string" +"$ref": "GoogleCloudDiscoveryengineV1betaCondition" }, "type": "array" }, "displayName": { -"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, -"industryVertical": { -"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], -"type": "string" +"filterAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlFilterAction", +"description": "Defines a filter-type control Currently not supported by Recommendation" }, "name": { -"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, -"searchEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", -"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +"redirectAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", +"description": "Defines a redirect-type control." }, "solutionType": { -"description": "Required. The solutions of the engine.", +"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -14234,475 +14667,1915 @@ ], "type": "string" }, -"updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", -"format": "google-datetime", -"readOnly": true, +"synonymsAction": { +"$ref": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", +"description": "Treats a group of terms as synonyms of one another." +}, +"useCases": { +"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", +"items": { +"enum": [ +"SEARCH_USE_CASE_UNSPECIFIED", +"SEARCH_USE_CASE_SEARCH", +"SEARCH_USE_CASE_BROWSE" +], +"enumDescriptions": [ +"Value used when unset. Will not occur in CSS.", +"Search use case. Expects the traffic has a non-empty query.", +"Browse use case. Expects the traffic has an empty query." +], "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", +"GoogleCloudDiscoveryengineV1betaControlBoostAction": { +"description": "Adjusts order of products in returned list.", +"id": "GoogleCloudDiscoveryengineV1betaControlBoostAction", "properties": { -"agentCreationConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", -"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." +"boost": { +"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", +"format": "float", +"type": "number" }, -"dialogflowAgentToLink": { -"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", +"dataStore": { +"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"type": "string" +}, +"filter": { +"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { -"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", -"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", +"GoogleCloudDiscoveryengineV1betaControlFilterAction": { +"description": "Specified which products may be included in results. Uses same filter as boost.", +"id": "GoogleCloudDiscoveryengineV1betaControlFilterAction", "properties": { -"business": { -"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"dataStore": { +"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"defaultLanguageCode": { -"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"filter": { +"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" +} }, -"location": { -"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaControlRedirectAction": { +"description": "Redirects a shopper to the provided URI.", +"id": "GoogleCloudDiscoveryengineV1betaControlRedirectAction", +"properties": { +"redirectUri": { +"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" +} }, -"timeZone": { -"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaControlSynonymsAction": { +"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", +"id": "GoogleCloudDiscoveryengineV1betaControlSynonymsAction", +"properties": { +"synonyms": { +"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", +"GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaCreateDataStoreMetadata", "properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"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" }, -"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"GoogleCloudDiscoveryengineV1betaCreateEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEngineMetadata", "properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", "properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", -"items": { -"enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." -], +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"type": "array" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaCreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaCustomTuningModel": { +"description": "Metadata that describes a custom tuned model.", +"id": "GoogleCloudDiscoveryengineV1betaCustomTuningModel", +"properties": { +"createTime": { +"deprecated": true, +"description": "Timestamp the Model was created at.", +"format": "google-datetime", +"type": "string" +}, +"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": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" +"MODEL_STATE_UNSPECIFIED", +"TRAINING_PAUSED", +"TRAINING", +"TRAINING_COMPLETE", +"READY_FOR_SERVING", +"TRAINING_FAILED", +"NO_IMPROVEMENT" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." +"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" }, -"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1betaDataStore": { +"description": "DataStore captures global settings and configs at the DataStore level.", +"id": "GoogleCloudDiscoveryengineV1betaDataStore", "properties": { +"contentConfig": { +"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"enum": [ +"CONTENT_CONFIG_UNSPECIFIED", +"NO_CONTENT", +"CONTENT_REQUIRED", +"PUBLIC_WEBSITE" +], +"enumDescriptions": [ +"Default value.", +"Only contains documents without any Document.content.", +"Only contains documents with Document.content.", +"The data store is used for public website search." +], +"type": "string" +}, "createTime": { -"description": "Operation create time.", +"description": "Output only. Timestamp the DataStore was created at.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", -"format": "int64", +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", +"readOnly": true, "type": "string" }, -"successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", +"displayName": { +"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, +"industryVertical": { +"description": "Immutable. The industry vertical that the data store registers.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"languageInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaLanguageInfo", +"description": "Language info for DataStore." +}, +"name": { +"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"solutionTypes": { +"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", +"items": { +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], "type": "string" +}, +"type": "array" +}, +"startingSchema": { +"$ref": "GoogleCloudDiscoveryengineV1betaSchema", +"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { +"GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteEngineMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"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" +}, +"GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteSchemaMetadata", +"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" +}, +"GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDeleteTargetSiteMetadata", +"properties": { +"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" +}, +"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"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" +}, +"GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1betaDisableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfig", +"properties": { +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." +}, +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +}, +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"type": "string" +}, +"parsingConfigOverrides": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig" +}, +"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"properties": { +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig", +"properties": { +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." +}, +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." +}, +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"properties": { +"enhancedDocumentElements": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"items": { +"type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1betaEnableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngine": { +"description": "Metadata that describes the training and serving parameters of an Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngine", +"properties": { +"chatEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", +"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +}, +"chatEngineMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", +"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", +"readOnly": true +}, +"commonConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"description": "Common config spec that specifies the metadata of the engine." +}, +"createTime": { +"description": "Output only. Timestamp the Recommendation Engine was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataStoreIds": { +"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", +"items": { +"type": "string" +}, +"type": "array" +}, +"displayName": { +"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"type": "string" +}, +"industryVertical": { +"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"name": { +"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"type": "string" +}, +"searchEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +}, +"solutionType": { +"description": "Required. The solutions of the engine.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" +}, +"updateTime": { +"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig": { +"description": "Configurations for a Chat Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig", +"properties": { +"agentCreationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", +"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." +}, +"dialogflowAgentToLink": { +"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig": { +"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", +"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineConfigAgentCreationConfig", +"properties": { +"business": { +"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"type": "string" +}, +"defaultLanguageCode": { +"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"type": "string" +}, +"location": { +"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "string" +}, +"timeZone": { +"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata", +"properties": { +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"properties": { +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"properties": { +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { +"enum": [ +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." +], +"type": "string" +}, +"type": "array" +}, +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"enum": [ +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of CompletionSuggestions successfully imported.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse": { "description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", "id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsResponse", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", -"description": "The desired location of errors incurred during the Import." +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { +"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of entries that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { +"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportErrorConfig": { +"description": "Configuration of destination for Import related errors.", +"id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"properties": { +"gcsPrefix": { +"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"failedEntriesCount": { +"description": "Count of deny list entries that failed to be imported.", +"format": "int64", +"type": "string" +}, +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { +"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { +"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "Echoes the destination for the complete errors if this field was set in the request." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"joinedEventsCount": { +"description": "Count of user events imported with complete existing Documents.", +"format": "int64", +"type": "string" +}, +"unjoinedEventsCount": { +"description": "Count of user events imported, but with Document information not found in the existing Branch.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1betaInterval", +"properties": { +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" +}, +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaLanguageInfo": { +"description": "Language info for DataStore.", +"id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", +"properties": { +"language": { +"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", +"readOnly": true, +"type": "string" +}, +"languageCode": { +"description": "The language code for the DataStore.", +"type": "string" +}, +"normalizedLanguageCode": { +"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", +"readOnly": true, +"type": "string" +}, +"region": { +"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { +"description": "Response message for SearchTuningService.ListCustomModels method.", +"id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", +"properties": { +"models": { +"description": "List of custom tuning models.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProject": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1betaProject", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this project is created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"properties": { +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", +"type": "string" +}, +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", +"format": "google-datetime", +"type": "string" +}, +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", +"type": "string" +}, +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"enum": [ +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" +], +"enumDescriptions": [ +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." +], +"type": "string" +}, +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"properties": { +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", +"format": "int64", +"type": "string" +}, +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1betaSchema", +"properties": { +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured representation of the schema.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"properties": { +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" +}, +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", +"type": "string" +}, +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", +"type": "string" +}, +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." +}, +"dataStoreSpecs": { +"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" +}, +"type": "array" +}, +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", +"type": "string" +}, +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"description": "Raw image query." +}, +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", +"type": "string" +}, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"orderBy": { +"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +}, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", +"type": "object" +}, +"query": { +"description": "Raw search query.", +"type": "string" +}, +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." +}, +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", +"type": "string" +}, +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", +"type": "string" +}, +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" +}, +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." +}, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, +"session": { +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"type": "string" +}, +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." +}, +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." +}, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." +}, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"properties": { +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", +"properties": { +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." }, -"type": "array" +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata": { -"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"type": "array" }, -"totalCount": { -"description": "Total count of entries that were processed.", -"format": "int64", +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportDocumentsResponse": { -"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1betaImportDocumentsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" }, -"type": "array" +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", "properties": { -"gcsPrefix": { -"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], "type": "string" +}, +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" }, -"type": "array" +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", -"type": "string" +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", -"type": "string" +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"maxSnippetCount": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", +"format": "int32", +"type": "integer" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportUserEventsResponse": { -"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1betaImportUserEventsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", -"description": "Echoes the destination for the complete errors if this field was set in the request." +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" }, -"type": "array" +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" }, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", -"type": "string" +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaLanguageInfo": { -"description": "Language info for DataStore.", -"id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { -"language": { -"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", -"readOnly": true, +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" +} }, -"languageCode": { -"description": "The language code for the DataStore.", -"type": "string" +"type": "object" }, -"normalizedLanguageCode": { -"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", -"readOnly": true, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"properties": { +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" +} }, -"region": { -"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", -"readOnly": true, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { +"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaListCustomModelsResponse": { -"description": "Response message for SearchTuningService.ListCustomModels method.", -"id": "GoogleCloudDiscoveryengineV1betaListCustomModelsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", "properties": { -"models": { -"description": "List of custom tuning models.", +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProject": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1betaProject", +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, -"type": "string" -}, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, +"fieldPath": { +"description": "Embedding field path in schema.", "type": "string" }, -"serviceTermsMap": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +"vector": { +"description": "Query embedding vector.", +"items": { +"format": "float", +"type": "number" }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, -"type": "object" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", -"type": "string" +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", +"type": "boolean" }, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" }, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"type": "array" }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", -"enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" -], -"enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." -], -"type": "string" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", -"type": "string" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" +}, +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"type": "array" +}, +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaInterval" +}, +"type": "array" +}, +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "array" +}, +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"properties": { +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." +], "type": "string" }, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -14711,61 +16584,85 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"pinUnexpandedResults": { +"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1betaSchema", +"GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { +"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { -"jsonSchema": { -"description": "The JSON representation of the schema.", -"type": "string" -}, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"queryId": { +"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchResultPersistenceCount": { +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"format": "int32", +"type": "integer" +} }, -"description": "The structured representation of the schema.", "type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"properties": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], +"type": "string" } }, "type": "object" @@ -15002,6 +16899,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1betaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json index 3f6b0851113..ac0803f1935 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1alpha.json @@ -2428,6 +2428,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getUriPatternDocumentData": { +"description": "Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:getUriPatternDocumentData", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.getUriPatternDocumentData", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+siteSearchEngine}:getUriPatternDocumentData", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "recrawlUris": { "description": "Request on-demand recrawl for a list of URIs.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", @@ -2455,6 +2480,34 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setUriPatternDocumentData": { +"description": "Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:setUriPatternDocumentData", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.setUriPatternDocumentData", +"parameterOrder": [ +"siteSearchEngine" +], +"parameters": { +"siteSearchEngine": { +"description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+siteSearchEngine}:setUriPatternDocumentData", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } }, "resources": { @@ -6377,6 +6430,133 @@ } }, "evaluations": { +"methods": { +"create": { +"description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.evaluations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/evaluations", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a Evaluation.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Gets a list of Evaluations.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+parent}/evaluations", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"listResults": { +"description": "Gets a list of results for a given a Evaluation.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.listResults", +"parameterOrder": [ +"evaluation" +], +"parameters": { +"evaluation": { +"description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+evaluation}:listResults", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -6441,6 +6621,80 @@ } } }, +"identity_mapping_stores": { +"resources": { +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/identity_mapping_stores/{identity_mapping_storesId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.identity_mapping_stores.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/identity_mapping_stores/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, "operations": { "methods": { "get": { @@ -6576,125 +6830,169 @@ } }, "sampleQuerySets": { -"resources": { -"operations": { "methods": { -"get": { -"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", +"create": { +"description": "Creates a SampleQuerySet", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"name": { -"description": "The name of the operation resource.", +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +}, +"sampleQuerySetId": { +"description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" } }, -"path": "v1alpha/{+name}", +"path": "v1alpha/{+parent}/sampleQuerySets", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" +}, "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"userEvents": { -"methods": { -"collect": { -"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", -"httpMethod": "GET", -"id": "discoveryengine.projects.locations.userEvents.collect", +"delete": { +"description": "Deletes a SampleQuerySet.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.delete", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"ets": { -"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", -"format": "int64", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"name": { +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" +} }, -"uri": { -"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", -"location": "query", -"type": "string" +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" }, -"userEvent": { -"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", -"location": "query", +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a SampleQuerySet.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, "type": "string" } }, -"path": "v1alpha/{+parent}/userEvents:collect", +"path": "v1alpha/{+name}", "response": { -"$ref": "GoogleApiHttpBody" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"write": { -"description": "Writes a single user event.", -"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.userEvents.write", +"list": { +"description": "Gets a list of SampleQuerySets.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.list", "parameterOrder": [ "parent" ], "parameters": { +"pageSize": { +"description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, "parent": { -"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" +} }, -"writeAsync": { -"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"path": "v1alpha/{+parent}/sampleQuerySets", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a SampleQuerySet.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1alpha/{+parent}/userEvents:write", +"path": "v1alpha/{+name}", "request": { -"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "response": { -"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} -} -} }, +"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}/operations/{operationsId}", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.operations.get", +"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", "parameterOrder": [ "name" ], @@ -6702,7 +7000,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6714,85 +7012,381 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1alpha/projects/{projectsId}/operations", -"httpMethod": "GET", -"id": "discoveryengine.projects.operations.list", +"sampleQueries": { +"methods": { +"create": { +"description": "Creates a SampleQuery", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"filter": { -"description": "The standard list filter.", +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +}, +"sampleQueryId": { +"description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" +} +}, +"path": "v1alpha/{+parent}/sampleQueries", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, +"delete": { +"description": "Deletes a SampleQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", +"parameterOrder": [ +"name" +], +"parameters": { "name": { -"description": "The name of the operation's parent resource.", +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", "location": "path", -"pattern": "^projects/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a SampleQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"import": { +"description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" +} +}, +"path": "v1alpha/{+parent}/sampleQueries:import", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] }, +"list": { +"description": "Gets a list of SampleQuerys.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", +"parameterOrder": [ +"parent" +], +"parameters": { "pageSize": { -"description": "The standard list page size.", +"description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "The standard list page token.", +"description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" +}, +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" } }, -"path": "v1alpha/{+name}/operations", +"path": "v1alpha/{+parent}/sampleQueries", "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"patch": { +"description": "Updates a SampleQuery.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } +}, +"path": "v1alpha/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } } }, -"revision": "20240704", -"rootUrl": "https://discoveryengine.googleapis.com/", -"schemas": { -"GoogleApiDistribution": { -"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", -"id": "GoogleApiDistribution", -"properties": { -"bucketCounts": { -"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", -"items": { +"userEvents": { +"methods": { +"collect": { +"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userEvents.collect", +"parameterOrder": [ +"parent" +], +"parameters": { +"ets": { +"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", "format": "int64", +"location": "query", "type": "string" }, -"type": "array" -}, -"bucketOptions": { -"$ref": "GoogleApiDistributionBucketOptions", -"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." +"parent": { +"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" }, -"count": { -"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", -"format": "int64", +"uri": { +"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", +"location": "query", "type": "string" }, -"exemplars": { -"description": "Must be in increasing order of `value` field.", -"items": { -"$ref": "GoogleApiDistributionExemplar" +"userEvent": { +"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", +"location": "query", +"type": "string" +} }, -"type": "array" +"path": "v1alpha/{+parent}/userEvents:collect", +"response": { +"$ref": "GoogleApiHttpBody" }, -"mean": { +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"write": { +"description": "Writes a single user event.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userEvents.write", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"writeAsync": { +"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1alpha/{+parent}/userEvents:write", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1alpha/projects/{projectsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1alpha/projects/{projectsId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1alpha/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +}, +"revision": "20240715", +"rootUrl": "https://discoveryengine.googleapis.com/", +"schemas": { +"GoogleApiDistribution": { +"description": "`Distribution` contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets. The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths. Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the `mean` and `sum_of_squared_deviation` fields meaningless.", +"id": "GoogleApiDistribution", +"properties": { +"bucketCounts": { +"description": "The number of values in each bucket of the histogram, as described in `bucket_options`. If the distribution does not have a histogram, then omit this field. If there is a histogram, then the sum of the values in `bucket_counts` must equal the value in the `count` field of the distribution. If present, `bucket_counts` should contain N values, where N is the number of buckets specified in `bucket_options`. If you supply fewer than N values, the remaining values are assumed to be 0. The order of the values in `bucket_counts` follows the bucket numbering schemes described for the three bucket types. The first value must be the count for the underflow bucket (number 0). The next N-2 values are the counts for the finite buckets (number 1 through N-2). The N'th value in `bucket_counts` is the count for the overflow bucket (number N-1).", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +}, +"bucketOptions": { +"$ref": "GoogleApiDistributionBucketOptions", +"description": "Defines the histogram bucket boundaries. If the distribution does not contain a histogram, then omit this field." +}, +"count": { +"description": "The number of values in the population. Must be non-negative. This value must equal the sum of the values in `bucket_counts` if a histogram is provided.", +"format": "int64", +"type": "string" +}, +"exemplars": { +"description": "Must be in increasing order of `value` field.", +"items": { +"$ref": "GoogleApiDistributionExemplar" +}, +"type": "array" +}, +"mean": { "description": "The arithmetic mean of the values in the population. If `count` is zero then this field must be zero.", "format": "double", "type": "number" @@ -8875,7 +9469,7 @@ "type": "string" }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -9026,7 +9620,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1alphaAnswer", -"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +"description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -9290,7 +9884,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" }, "title": { @@ -10390,6 +10984,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", @@ -11416,6 +12016,96 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { "description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", @@ -11705,6 +12395,24 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaGroundingFact": { "description": "Grounding Fact.", "id": "GoogleCloudDiscoveryengineV1alphaGroundingFact", @@ -12010,55 +12718,142 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { "createTime": { -"description": "Operation create time.", +"description": "ImportSampleQueries operation create time.", "format": "google-datetime", "type": "string" }, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, "updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { -"description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest": { +"description": "Request message for SampleQueryService.ImportSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequest", "properties": { +"bigquerySource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaBigQuerySource", +"description": "BigQuery input source." +}, +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, "gcsSource": { "$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", -"description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line." +"description": "Cloud Storage location for the input content." }, "inlineSource": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", -"description": "The Inline source for the input content for suggestion deny list entries." +"$ref": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", +"description": "The Inline source for sample query entries." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { -"description": "The inline source for SuggestionDenyListEntry.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource": { +"description": "The inline source for SampleQuerys.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesRequestInlineSource", "properties": { -"entries": { -"description": "Required. A list of all denylist entries to import. Max of 1000 items.", +"sampleQueries": { +"description": "Required. A list of SampleQuerys to import. Max of 1000 items.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest": { +"description": "Request message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequest", +"properties": { +"gcsSource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaGcsSource", +"description": "Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line." +}, +"inlineSource": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", +"description": "The Inline source for the input content for suggestion deny list entries." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource": { +"description": "The inline source for SuggestionDenyListEntry.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesRequestInlineSource", +"properties": { +"entries": { +"description": "Required. A list of all denylist entries to import. Max of 1000 items.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSuggestionDenyListEntry" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "properties": { "errorSamples": { "description": "A sample of errors encountered while processing the request.", @@ -12347,6 +13142,95 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse": { +"description": "Response message for EvaluationService.ListEvaluationResults method.", +"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponse", +"properties": { +"evaluationResults": { +"description": "The EvaluationResults.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult": { +"description": "Represents the results of an evaluation for a single SampleQuery.", +"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationResultsResponseEvaluationResult", +"properties": { +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", +"readOnly": true +}, +"sampleQuery": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery", +"description": "Output only. The SampleQuery that was evaluated.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse": { +"description": "Response message for EvaluationService.ListEvaluations method.", +"id": "GoogleCloudDiscoveryengineV1alphaListEvaluationsResponse", +"properties": { +"evaluations": { +"description": "The Evaluations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse": { +"description": "Response message for SampleQueryService.ListSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1alphaListSampleQueriesResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQueries": { +"description": "The SampleQuerys.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuery" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse": { +"description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", +"id": "GoogleCloudDiscoveryengineV1alphaListSampleQuerySetsResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQuerySets": { +"description": "The SampleQuerySets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaListSchemasResponse": { "description": "Response message for SchemaService.ListSchemas method.", "id": "GoogleCloudDiscoveryengineV1alphaListSchemasResponse", @@ -12867,6 +13751,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1alphaQuery", @@ -13367,6 +14305,94 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSampleQuery": { +"description": "Sample Query captures metadata to be used for evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQuery", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuery was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"queryEntry": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", +"description": "The query entry." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry": { +"description": "Query Entry captures metadata to be used for search evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntry", +"properties": { +"query": { +"description": "Required. The query.", +"type": "string" +}, +"targets": { +"description": "List of targets for the query.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget": { +"description": "Defines the parameters of the query's expected outcome.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQueryQueryEntryTarget", +"properties": { +"pageNumbers": { +"description": "Expected page numbers of the target. Each page number must be non negative.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"score": { +"description": "Relevance score of the target.", +"format": "double", +"type": "number" +}, +"uri": { +"description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSampleQuerySet": { +"description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", +"id": "GoogleCloudDiscoveryengineV1alphaSampleQuerySet", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuerySet was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "The description of the SampleQuerySet.", +"type": "string" +}, +"displayName": { +"description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1alphaSchema", @@ -13543,6 +14569,10 @@ "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, "session": { "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" @@ -13680,7 +14710,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -13984,7 +15014,7 @@ "type": "string" }, "geoSearchQueryDetectionFieldNames": { -"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names.", +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -14868,6 +15898,59 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest": { +"description": "Request message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataRequest", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { \"type\": \"object\", \"properties\": { \"Categories\": { \"type\": \"array\", \"items\": { \"retrievable\": true, \"type\": \"string\" } } } document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" +}, +"emptyDocumentDataMap": { +"description": "If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.", +"type": "boolean" +}, +"schema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine": { "description": "SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.", "id": "GoogleCloudDiscoveryengineV1alphaSiteSearchEngine", @@ -15639,6 +16722,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", @@ -16223,19 +17312,109 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1betaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluation", "properties": { "createTime": { -"description": "Operation create time.", +"description": "Output only. Timestamp the Evaluation was created at.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", -"format": "int64", -"type": "string" +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." +}, +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportCompletionSuggestionsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", +"type": "string" }, "successCount": { "description": "Count of CompletionSuggestions successfully imported.", @@ -16329,6 +17508,56 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", @@ -16425,6 +17654,33 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1betaInterval", +"properties": { +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" +}, +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaLanguageInfo": { "description": "Language info for DataStore.", "id": "GoogleCloudDiscoveryengineV1betaLanguageInfo", @@ -16458,135 +17714,805 @@ "models": { "description": "List of custom tuning models.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +"$ref": "GoogleCloudDiscoveryengineV1betaCustomTuningModel" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProject": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1betaProject", +"properties": { +"createTime": { +"description": "Output only. The timestamp when this project is created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"properties": { +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", +"type": "string" +}, +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", +"format": "google-datetime", +"type": "string" +}, +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", +"type": "string" +}, +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"enum": [ +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" +], +"enumDescriptions": [ +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." +], +"type": "string" +}, +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"properties": { +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", +"format": "int64", +"type": "string" +}, +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1betaSchema", +"properties": { +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured representation of the schema.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"properties": { +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" +}, +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", +"type": "string" +}, +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", +"type": "string" +}, +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." +}, +"dataStoreSpecs": { +"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" +}, +"type": "array" +}, +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", +"type": "string" +}, +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"description": "Raw image query." +}, +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", +"type": "string" +}, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"orderBy": { +"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", +"type": "string" +}, +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +}, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", +"type": "object" +}, +"query": { +"description": "Raw search query.", +"type": "string" +}, +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." +}, +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", +"type": "string" +}, +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", +"type": "string" +}, +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" +}, +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." +}, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, +"session": { +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"type": "string" +}, +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." +}, +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." +}, +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." +}, +"userLabels": { +"additionalProperties": { +"type": "string" +}, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpec", +"properties": { +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpec", +"properties": { +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" +}, +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." +}, +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"properties": { +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], +"type": "string" +}, +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" +}, +"type": "array" +}, +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", +"type": "string" +}, +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", +"properties": { +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", +"type": "string" +}, +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec", +"properties": { +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", +"enum": [ +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" +], +"enumDescriptions": [ +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." +], +"type": "string" +}, +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecChunkSpec", +"properties": { +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec", +"properties": { +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" +}, +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" +}, +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" +}, +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSnippetSpec", +"properties": { +"maxSnippetCount": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", +"format": "int32", +"type": "integer" +}, +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" +}, +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec", +"properties": { +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" +}, +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" +}, +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" +}, +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", +"type": "string" +}, +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"properties": { +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpecModelSpec", +"properties": { +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec": { +"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpec", +"properties": { +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestEmbeddingSpecEmbeddingVector", +"properties": { +"fieldPath": { +"description": "Embedding field path in schema.", +"type": "string" +}, +"vector": { +"description": "Query embedding vector.", +"items": { +"format": "float", +"type": "number" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProject": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1betaProject", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpec", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", +"type": "boolean" }, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" }, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"type": "array" }, -"serviceTermsMap": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, -"type": "object" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1betaProjectServiceTerms", +"GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestFacetSpecFacetKey", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", -"type": "string" -}, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", -"type": "string" -}, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", -"enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" -], -"enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." -], +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", -"type": "string" -} +"type": "array" }, -"type": "object" +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaInterval" }, -"GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1betaProvisionProjectMetadata", -"properties": {}, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", "type": "string" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"type": "array" +}, +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", +"items": { "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery", +"properties": { +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." +], "type": "string" }, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, @@ -16595,61 +18521,85 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestQueryExpansionSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"pinUnexpandedResults": { +"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1betaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1betaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1betaSchema", +"GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec": { +"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec", "properties": { -"jsonSchema": { -"description": "The JSON representation of the schema.", -"type": "string" -}, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"queryId": { +"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchResultPersistenceCount": { +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"format": "int32", +"type": "integer" +} }, -"description": "The structured representation of the schema.", "type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1betaSearchRequestSpellCorrectionSpec", +"properties": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], +"type": "string" } }, "type": "object" @@ -16886,6 +18836,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1betaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "GoogleLongrunningCancelOperationRequest", diff --git a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json index 3a7a3ab31b8..bcf237ddb17 100644 --- a/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/discoveryengine.v1beta.json @@ -5823,6 +5823,133 @@ } }, "evaluations": { +"methods": { +"create": { +"description": "Creates a Evaluation. Upon creation, the evaluation will be automatically triggered and begin execution.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.evaluations.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/evaluations", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a Evaluation.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of Evaluation, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to access the Evaluation, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Evaluation does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Gets a list of Evaluations.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of Evaluations to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationsResponse.next_page_token, received from a previous EvaluationService.ListEvaluations call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluations must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list Evaluations under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/evaluations", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"listResults": { +"description": "Gets a list of results for a given a Evaluation.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/evaluations/{evaluationsId}:listResults", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.evaluations.listResults", +"parameterOrder": [ +"evaluation" +], +"parameters": { +"evaluation": { +"description": "Required. The evaluation resource name, such as `projects/{project}/locations/{location}/evaluations/{evaluation}`. If the caller does not have permission to list EvaluationResult under this evaluation, regardless of whether or not this evaluation set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/evaluations/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "Maximum number of EvaluationResult to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListEvaluationResultsResponse.next_page_token, received from a previous EvaluationService.ListEvaluationResults call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to EvaluationService.ListEvaluationResults must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+evaluation}:listResults", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, "resources": { "operations": { "methods": { @@ -5990,125 +6117,169 @@ } }, "sampleQuerySets": { -"resources": { -"operations": { "methods": { +"create": { +"description": "Creates a SampleQuerySet", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"sampleQuerySetId": { +"description": "Required. The ID to use for the SampleQuerySet, which will become the final component of the SampleQuerySet.name. If the caller does not have permission to create the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerySets with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/sampleQuerySets", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a SampleQuerySet.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to delete the SampleQuerySet, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuerySet to delete does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"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": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", +"description": "Gets a SampleQuerySet.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", +"id": "discoveryengine.projects.locations.sampleQuerySets.get", "parameterOrder": [ "name" ], "parameters": { "name": { -"description": "The name of the operation resource.", +"description": "Required. Full resource name of SampleQuerySet, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to access the SampleQuerySet, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuerySet does not exist, a NOT_FOUND error is returned.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta/{+name}", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} }, -"userEvents": { -"methods": { -"collect": { -"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"list": { +"description": "Gets a list of SampleQuerySets.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets", "httpMethod": "GET", -"id": "discoveryengine.projects.locations.userEvents.collect", +"id": "discoveryengine.projects.locations.sampleQuerySets.list", "parameterOrder": [ "parent" ], "parameters": { -"ets": { -"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", -"format": "int64", +"pageSize": { +"description": "Maximum number of SampleQuerySets to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListSampleQuerySetsResponse.next_page_token, received from a previous SampleQuerySetService.ListSampleQuerySets call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQuerySetService.ListSampleQuerySets must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" }, "parent": { -"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"description": "Required. The parent location resource name, such as `projects/{project}/locations/{location}`. If the caller does not have permission to list SampleQuerySets under this location, regardless of whether or not this location exists, a `PERMISSION_DENIED` error is returned.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "type": "string" -}, -"uri": { -"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", -"location": "query", -"type": "string" -}, -"userEvent": { -"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", -"location": "query", -"type": "string" } }, -"path": "v1beta/{+parent}/userEvents:collect", +"path": "v1beta/{+parent}/sampleQuerySets", "response": { -"$ref": "GoogleApiHttpBody" +"$ref": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, -"write": { -"description": "Writes a single user event.", -"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", -"httpMethod": "POST", -"id": "discoveryengine.projects.locations.userEvents.write", +"patch": { +"description": "Updates a SampleQuerySet.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.patch", "parameterOrder": [ -"parent" +"name" ], "parameters": { -"parent": { -"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" }, -"writeAsync": { -"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"updateMask": { +"description": "Indicates which fields in the provided imported 'sample query set' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", "location": "query", -"type": "boolean" +"type": "string" } }, -"path": "v1beta/{+parent}/userEvents:write", +"path": "v1beta/{+name}", "request": { -"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "response": { -"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } -} -} -} }, +"resources": { "operations": { "methods": { "get": { "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", -"flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}", "httpMethod": "GET", -"id": "discoveryengine.projects.operations.get", +"id": "discoveryengine.projects.locations.sampleQuerySets.operations.get", "parameterOrder": [ "name" ], @@ -6116,7 +6287,7 @@ "name": { "description": "The name of the operation resource.", "location": "path", -"pattern": "^projects/[^/]+/operations/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$", "required": true, "type": "string" } @@ -6128,205 +6299,1075 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +} +} }, -"list": { -"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", -"flatPath": "v1beta/projects/{projectsId}/operations", -"httpMethod": "GET", -"id": "discoveryengine.projects.operations.list", +"sampleQueries": { +"methods": { +"create": { +"description": "Creates a SampleQuery", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.create", "parameterOrder": [ -"name" +"parent" ], "parameters": { -"filter": { -"description": "The standard list filter.", -"location": "query", -"type": "string" -}, -"name": { -"description": "The name of the operation's parent resource.", +"parent": { +"description": "Required. The parent resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "location": "path", -"pattern": "^projects/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", "required": true, "type": "string" }, -"pageSize": { -"description": "The standard list page size.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The standard list page token.", +"sampleQueryId": { +"description": "Required. The ID to use for the SampleQuery, which will become the final component of the SampleQuery.name. If the caller does not have permission to create the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all SampleQuerys with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "location": "query", "type": "string" } }, -"path": "v1beta/{+name}/operations", +"path": "v1beta/{+parent}/sampleQueries", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, "response": { -"$ref": "GoogleLongrunningListOperationsResponse" +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] -} -} -} -} -} }, -"revision": "20240704", -"rootUrl": "https://discoveryengine.googleapis.com/", -"schemas": { -"GoogleApiHttpBody": { -"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", -"id": "GoogleApiHttpBody", +"delete": { +"description": "Deletes a SampleQuery.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "DELETE", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to delete the SampleQuery, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the SampleQuery to delete does not exist, a `NOT_FOUND` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a SampleQuery.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Full resource name of SampleQuery, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. If the caller does not have permission to access the SampleQuery, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested SampleQuery does not exist, a NOT_FOUND error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"import": { +"description": "Bulk import of multiple SampleQuerys. Sample queries that already exist may be deleted. Note: It is possible for a subset of the SampleQuerys to be successfully imported.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries:import", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.import", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sampleQueries:import", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Gets a list of SampleQuerys.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Maximum number of SampleQuerys to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token ListSampleQueriesResponse.next_page_token, received from a previous SampleQueryService.ListSampleQueries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SampleQueryService.ListSampleQueries must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent sample query set resource name, such as `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. If the caller does not have permission to list SampleQuerys under this sample query set, regardless of whether or not this sample query set exists, a `PERMISSION_DENIED` error is returned.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+parent}/sampleQueries", +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates a SampleQuery.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/sampleQueries/{sampleQueriesId}", +"httpMethod": "PATCH", +"id": "discoveryengine.projects.locations.sampleQuerySets.sampleQueries.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/sampleQueries/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Indicates which fields in the provided imported 'simple query' to update. If not set, will by default update all fields.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"userEvents": { +"methods": { +"collect": { +"description": "Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a third-party domain. This method is used only by the Discovery Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:collect", +"httpMethod": "GET", +"id": "discoveryengine.projects.locations.userEvents.collect", +"parameterOrder": [ +"parent" +], +"parameters": { +"ets": { +"description": "The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.", +"format": "int64", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"uri": { +"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.", +"location": "query", +"type": "string" +}, +"userEvent": { +"description": "Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+parent}/userEvents:collect", +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"write": { +"description": "Writes a single user event.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/userEvents:write", +"httpMethod": "POST", +"id": "discoveryengine.projects.locations.userEvents.write", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"writeAsync": { +"description": "If set to true, the user event is written asynchronously after validation, and the API responds without waiting for the write.", +"location": "query", +"type": "boolean" +} +}, +"path": "v1beta/{+parent}/userEvents:write", +"request": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +}, +"response": { +"$ref": "GoogleCloudDiscoveryengineV1betaUserEvent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +}, +"operations": { +"methods": { +"get": { +"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", +"flatPath": "v1beta/projects/{projectsId}/operations/{operationsId}", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "The name of the operation resource.", +"location": "path", +"pattern": "^projects/[^/]+/operations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}", +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", +"flatPath": "v1beta/projects/{projectsId}/operations", +"httpMethod": "GET", +"id": "discoveryengine.projects.operations.list", +"parameterOrder": [ +"name" +], +"parameters": { +"filter": { +"description": "The standard list filter.", +"location": "query", +"type": "string" +}, +"name": { +"description": "The name of the operation's parent resource.", +"location": "path", +"pattern": "^projects/[^/]+$", +"required": true, +"type": "string" +}, +"pageSize": { +"description": "The standard list page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "The standard list page token.", +"location": "query", +"type": "string" +} +}, +"path": "v1beta/{+name}/operations", +"response": { +"$ref": "GoogleLongrunningListOperationsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +}, +"revision": "20240715", +"rootUrl": "https://discoveryengine.googleapis.com/", +"schemas": { +"GoogleApiHttpBody": { +"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", +"id": "GoogleApiHttpBody", +"properties": { +"contentType": { +"description": "The HTTP Content-Type header value specifying the content type of the body.", +"type": "string" +}, +"data": { +"description": "The HTTP request/response body as raw binary.", +"format": "byte", +"type": "string" +}, +"extensions": { +"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingErrorContext": { +"description": "A description of the context in which an error occurred.", +"id": "GoogleCloudDiscoveryengineLoggingErrorContext", +"properties": { +"httpRequest": { +"$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", +"description": "The HTTP request which was processed when the error was triggered." +}, +"reportLocation": { +"$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", +"description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingErrorLog": { +"description": "An error log which is reported to the Error Reporting system.", +"id": "GoogleCloudDiscoveryengineLoggingErrorLog", +"properties": { +"context": { +"$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", +"description": "A description of the context in which the error occurred." +}, +"importPayload": { +"$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", +"description": "The error payload that is populated on LRO import APIs." +}, +"message": { +"description": "A message describing the error.", +"type": "string" +}, +"requestPayload": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The API request payload, represented as a protocol buffer. Most API request types are supported\u2014for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", +"type": "object" +}, +"responsePayload": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", +"type": "object" +}, +"serviceContext": { +"$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", +"description": "The service context in which this error has occurred." +}, +"status": { +"$ref": "GoogleRpcStatus", +"description": "The RPC status associated with the error log." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingHttpRequestContext": { +"description": "HTTP request data that is related to a reported error.", +"id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", +"properties": { +"responseStatusCode": { +"description": "The HTTP response status code for the request.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingImportErrorContext": { +"description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", +"id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", +"properties": { +"document": { +"description": "The detailed content which caused the error on importing a document.", +"type": "string" +}, +"gcsPath": { +"description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", +"type": "string" +}, +"lineNumber": { +"description": "Line number of the content in file. Should be empty for permission or batch operation error.", +"type": "string" +}, +"operation": { +"description": "The operation resource name of the LRO.", +"type": "string" +}, +"userEvent": { +"description": "The detailed content which caused the error on importing a user event.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingServiceContext": { +"description": "Describes a running service that sends errors.", +"id": "GoogleCloudDiscoveryengineLoggingServiceContext", +"properties": { +"service": { +"description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineLoggingSourceLocation": { +"description": "Indicates a location in the source code of the service for which errors are reported.", +"id": "GoogleCloudDiscoveryengineLoggingSourceLocation", +"properties": { +"functionName": { +"description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", +"properties": { +"targetSites": { +"description": "TargetSites created.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSite" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1Condition": { +"description": "Defines circumstances to be checked before allowing a behavior", +"id": "GoogleCloudDiscoveryengineV1Condition", +"properties": { +"activeTimeRange": { +"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" +}, +"type": "array" +}, +"queryTerms": { +"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ConditionQueryTerm": { +"description": "Matcher for search request query", +"id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", +"properties": { +"fullMatch": { +"description": "Whether the search query needs to exactly match the query term.", +"type": "boolean" +}, +"value": { +"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ConditionTimeRange": { +"description": "Used for time-dependent conditions.", +"id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", +"properties": { +"endTime": { +"description": "End of time range. Range is inclusive. Must be in the future.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "Start of time range. Range is inclusive.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1Control": { +"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", +"id": "GoogleCloudDiscoveryengineV1Control", +"properties": { +"associatedServingConfigIds": { +"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"boostAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", +"description": "Defines a boost-type control" +}, +"conditions": { +"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1Condition" +}, +"type": "array" +}, +"displayName": { +"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +}, +"filterAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", +"description": "Defines a filter-type control Currently not supported by Recommendation" +}, +"name": { +"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"type": "string" +}, +"redirectAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", +"description": "Defines a redirect-type control." +}, +"solutionType": { +"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" +}, +"synonymsAction": { +"$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", +"description": "Treats a group of terms as synonyms of one another." +}, +"useCases": { +"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", +"items": { +"enum": [ +"SEARCH_USE_CASE_UNSPECIFIED", +"SEARCH_USE_CASE_SEARCH", +"SEARCH_USE_CASE_BROWSE" +], +"enumDescriptions": [ +"Value used when unset. Will not occur in CSS.", +"Search use case. Expects the traffic has a non-empty query.", +"Browse use case. Expects the traffic has an empty query." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlBoostAction": { +"description": "Adjusts order of products in returned list.", +"id": "GoogleCloudDiscoveryengineV1ControlBoostAction", "properties": { -"contentType": { -"description": "The HTTP Content-Type header value specifying the content type of the body.", +"boost": { +"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", +"format": "float", +"type": "number" +}, +"dataStore": { +"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"data": { -"description": "The HTTP request/response body as raw binary.", -"format": "byte", +"filter": { +"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlFilterAction": { +"description": "Specified which products may be included in results. Uses same filter as boost.", +"id": "GoogleCloudDiscoveryengineV1ControlFilterAction", +"properties": { +"dataStore": { +"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"type": "string" +}, +"filter": { +"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlRedirectAction": { +"description": "Redirects a shopper to the provided URI.", +"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", +"properties": { +"redirectUri": { +"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ControlSynonymsAction": { +"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", +"id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", +"properties": { +"synonyms": { +"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DataStore": { +"description": "DataStore captures global settings and configs at the DataStore level.", +"id": "GoogleCloudDiscoveryengineV1DataStore", +"properties": { +"contentConfig": { +"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"enum": [ +"CONTENT_CONFIG_UNSPECIFIED", +"NO_CONTENT", +"CONTENT_REQUIRED", +"PUBLIC_WEBSITE" +], +"enumDescriptions": [ +"Default value.", +"Only contains documents without any Document.content.", +"Only contains documents with Document.content.", +"The data store is used for public website search." +], +"type": "string" +}, +"createTime": { +"description": "Output only. Timestamp the DataStore was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", +"readOnly": true, +"type": "string" +}, +"displayName": { +"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"type": "string" +}, +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." +}, +"industryVertical": { +"description": "Immutable. The industry vertical that the data store registers.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"solutionTypes": { +"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", +"items": { +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" +}, +"type": "array" +}, +"startingSchema": { +"$ref": "GoogleCloudDiscoveryengineV1Schema", +"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"extensions": { -"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", -"items": { -"additionalProperties": { -"description": "Properties of the object. Contains field @type with type URL.", -"type": "any" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, "type": "object" }, -"type": "array" +"GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingErrorContext": { -"description": "A description of the context in which an error occurred.", -"id": "GoogleCloudDiscoveryengineLoggingErrorContext", +"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", "properties": { -"httpRequest": { -"$ref": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", -"description": "The HTTP request which was processed when the error was triggered." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"reportLocation": { -"$ref": "GoogleCloudDiscoveryengineLoggingSourceLocation", -"description": "The location in the source code where the decision was made to report the error, usually the place where it was logged." +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingErrorLog": { -"description": "An error log which is reported to the Error Reporting system.", -"id": "GoogleCloudDiscoveryengineLoggingErrorLog", +"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", "properties": { -"context": { -"$ref": "GoogleCloudDiscoveryengineLoggingErrorContext", -"description": "A description of the context in which the error occurred." +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." }, -"importPayload": { -"$ref": "GoogleCloudDiscoveryengineLoggingImportErrorContext", -"description": "The error payload that is populated on LRO import APIs." +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." }, -"message": { -"description": "A message describing the error.", +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, -"requestPayload": { +"parsingConfigOverrides": { "additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" }, -"description": "The API request payload, represented as a protocol buffer. Most API request types are supported\u2014for example: * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest` * `type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest`", +"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", "type": "object" +} }, -"responsePayload": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The API response payload, represented as a protocol buffer. This is used to log some \"soft errors\", where the response is valid but we consider there are some quality issues like unjoined events. The following API responses are supported, and no PII is included: * `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend` * `google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent` * `google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent`", "type": "object" }, -"serviceContext": { -"$ref": "GoogleCloudDiscoveryengineLoggingServiceContext", -"description": "The service context in which this error has occurred." -}, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The RPC status associated with the error log." +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingHttpRequestContext": { -"description": "HTTP request data that is related to a reported error.", -"id": "GoogleCloudDiscoveryengineLoggingHttpRequestContext", +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { -"responseStatusCode": { -"description": "The HTTP response status code for the request.", +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", "format": "int32", "type": "integer" +}, +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingImportErrorContext": { -"description": "The error payload that is populated on LRO import APIs, including the following: * `google.cloud.discoveryengine.v1alpha.DocumentService.ImportDocuments` * `google.cloud.discoveryengine.v1alpha.UserEventService.ImportUserEvents`", -"id": "GoogleCloudDiscoveryengineLoggingImportErrorContext", +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", "properties": { -"document": { -"description": "The detailed content which caused the error on importing a document.", -"type": "string" -}, -"gcsPath": { -"description": "Google Cloud Storage file path of the import source. Can be set for batch operation error.", -"type": "string" -}, -"lineNumber": { -"description": "Line number of the content in file. Should be empty for permission or batch operation error.", -"type": "string" +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." }, -"operation": { -"description": "The operation resource name of the LRO.", -"type": "string" +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." }, -"userEvent": { -"description": "The detailed content which caused the error on importing a user event.", -"type": "string" +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." } }, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingServiceContext": { -"description": "Describes a running service that sends errors.", -"id": "GoogleCloudDiscoveryengineLoggingServiceContext", -"properties": { -"service": { -"description": "An identifier of the service\u2014for example, `discoveryengine.googleapis.com`.", -"type": "string" -} +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", +"properties": {}, +"type": "object" }, +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineLoggingSourceLocation": { -"description": "Indicates a location in the source code of the service for which errors are reported.", -"id": "GoogleCloudDiscoveryengineLoggingSourceLocation", +"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { -"functionName": { -"description": "Human-readable name of a function or method\u2014for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`.", +"enhancedDocumentElements": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"items": { "type": "string" +}, +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6341,114 +7382,72 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1BatchCreateTargetSitesResponse", -"properties": { -"targetSites": { -"description": "TargetSites created.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSite" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1Condition": { -"description": "Defines circumstances to be checked before allowing a behavior", -"id": "GoogleCloudDiscoveryengineV1Condition", -"properties": { -"activeTimeRange": { -"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1ConditionTimeRange" -}, -"type": "array" -}, -"queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1ConditionQueryTerm" -}, -"type": "array" -} -}, +"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", +"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1ConditionQueryTerm": { -"description": "Matcher for search request query", -"id": "GoogleCloudDiscoveryengineV1ConditionQueryTerm", +"GoogleCloudDiscoveryengineV1Engine": { +"description": "Metadata that describes the training and serving parameters of an Engine.", +"id": "GoogleCloudDiscoveryengineV1Engine", "properties": { -"fullMatch": { -"description": "Whether the search query needs to exactly match the query term.", -"type": "boolean" -}, -"value": { -"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", -"type": "string" -} +"chatEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", +"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." }, -"type": "object" +"chatEngineMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", +"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", +"readOnly": true }, -"GoogleCloudDiscoveryengineV1ConditionTimeRange": { -"description": "Used for time-dependent conditions.", -"id": "GoogleCloudDiscoveryengineV1ConditionTimeRange", -"properties": { -"endTime": { -"description": "End of time range. Range is inclusive. Must be in the future.", -"format": "google-datetime", -"type": "string" +"commonConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", +"description": "Common config spec that specifies the metadata of the engine." }, -"startTime": { -"description": "Start of time range. Range is inclusive.", +"createTime": { +"description": "Output only. Timestamp the Recommendation Engine was created at.", "format": "google-datetime", +"readOnly": true, "type": "string" -} }, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1Control": { -"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", -"id": "GoogleCloudDiscoveryengineV1Control", -"properties": { -"associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"dataStoreIds": { +"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { "type": "string" }, -"readOnly": true, -"type": "array" -}, -"boostAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlBoostAction", -"description": "Defines a boost-type control" -}, -"conditions": { -"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1Condition" -}, "type": "array" }, "displayName": { -"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, -"filterAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlFilterAction", -"description": "Defines a filter-type control Currently not supported by Recommendation" +"industryVertical": { +"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" }, "name": { -"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, -"redirectAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlRedirectAction", -"description": "Defines a redirect-type control." +"searchEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", +"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, "solutionType": { -"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"description": "Required. The solutions of the engine.", "enum": [ "SOLUTION_TYPE_UNSPECIFIED", "SOLUTION_TYPE_RECOMMENDATION", @@ -6465,131 +7464,128 @@ ], "type": "string" }, -"synonymsAction": { -"$ref": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", -"description": "Treats a group of terms as synonyms of one another." -}, -"useCases": { -"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", -"items": { -"enum": [ -"SEARCH_USE_CASE_UNSPECIFIED", -"SEARCH_USE_CASE_SEARCH", -"SEARCH_USE_CASE_BROWSE" -], -"enumDescriptions": [ -"Value used when unset. Will not occur in CSS.", -"Search use case. Expects the traffic has a non-empty query.", -"Browse use case. Expects the traffic has an empty query." -], +"updateTime": { +"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlBoostAction": { -"description": "Adjusts order of products in returned list.", -"id": "GoogleCloudDiscoveryengineV1ControlBoostAction", +"GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { +"description": "Configurations for a Chat Engine.", +"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", "properties": { -"boost": { -"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", -"format": "float", -"type": "number" -}, -"dataStore": { -"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", -"type": "string" +"agentCreationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", +"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, -"filter": { -"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"dialogflowAgentToLink": { +"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlFilterAction": { -"description": "Specified which products may be included in results. Uses same filter as boost.", -"id": "GoogleCloudDiscoveryengineV1ControlFilterAction", +"GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { +"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", +"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", "properties": { -"dataStore": { -"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"business": { +"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, -"filter": { -"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"defaultLanguageCode": { +"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"type": "string" +}, +"location": { +"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "string" +}, +"timeZone": { +"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlRedirectAction": { -"description": "Redirects a shopper to the provided URI.", -"id": "GoogleCloudDiscoveryengineV1ControlRedirectAction", +"GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", "properties": { -"redirectUri": { -"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ControlSynonymsAction": { -"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", -"id": "GoogleCloudDiscoveryengineV1ControlSynonymsAction", +"GoogleCloudDiscoveryengineV1EngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", "properties": { -"synonyms": { -"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1CreateDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1CreateDataStoreMetadata", +"GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { +"enum": [ +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "array" +}, +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"enum": [ +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." +], "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1CreateEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1CreateEngineMetadata", +"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", "type": "string" -} -}, -"type": "object" }, -"GoogleCloudDiscoveryengineV1CreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1CreateSchemaMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"successCount": { +"description": "Count of CompletionSuggestions successfully imported.", +"format": "int64", "type": "string" }, "updateTime": { @@ -6600,113 +7596,88 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1CreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { +"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "The desired location of errors incurred during the Import." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1DataStore", -"properties": { -"contentConfig": { -"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", -"enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" -], -"enumDescriptions": [ -"Default value.", -"Only contains documents without any Document.content.", -"Only contains documents with Document.content.", -"The data store is used for public website search." -], -"type": "string" -}, +"GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { +"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", +"properties": { "createTime": { -"description": "Output only. Timestamp the DataStore was created at.", +"description": "Operation create time.", "format": "google-datetime", -"readOnly": true, "type": "string" }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", -"readOnly": true, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" }, -"displayName": { -"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", "type": "string" }, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." -}, -"industryVertical": { -"description": "Immutable. The industry vertical that the data store registers.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], +"totalCount": { +"description": "Total count of entries that were processed.", +"format": "int64", "type": "string" }, -"name": { -"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"solutionTypes": { -"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { +"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", "items": { -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], -"type": "string" +"$ref": "GoogleRpcStatus" }, "type": "array" +} }, -"startingSchema": { -"$ref": "GoogleCloudDiscoveryengineV1Schema", -"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." +"type": "object" +}, +"GoogleCloudDiscoveryengineV1ImportErrorConfig": { +"description": "Configuration of destination for Import related errors.", +"id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"properties": { +"gcsPrefix": { +"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DeleteDataStoreMetadata", +"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6721,32 +7692,49 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DeleteEngineMetadata", +"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"failedEntriesCount": { +"description": "Count of deny list entries that failed to be imported.", +"format": "int64", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1DeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { +"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" +}, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -6755,152 +7743,202 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DeleteTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { +"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", +"description": "Echoes the destination for the complete errors if this field was set in the request." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"joinedEventsCount": { +"description": "Count of user events imported with complete existing Documents.", +"format": "int64", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"unjoinedEventsCount": { +"description": "Count of user events imported, but with Document information not found in the existing Branch.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1Project": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1Project", "properties": { "createTime": { -"description": "Operation create time.", +"description": "Output only. The timestamp when this project is created.", "format": "google-datetime", +"readOnly": true, "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", "format": "google-datetime", +"readOnly": true, "type": "string" -} }, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, "type": "object" +} }, -"GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1DisableAdvancedSiteSearchResponse", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfig": { -"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfig", +"GoogleCloudDiscoveryengineV1ProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", +"type": "string" }, -"defaultParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", -"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", +"format": "google-datetime", +"type": "string" }, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", "type": "string" }, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig" +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"enum": [ +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" +], +"enumDescriptions": [ +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." +], +"type": "string" }, -"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", -"type": "object" +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { +"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", "properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"includeAncestorHeadings": { -"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "array" +}, +"purgeSucceeded": { +"description": "Whether the completion suggestions were successfully purged.", "type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig", +"GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", "properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" }, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." -} +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" }, -"type": "object" +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"type": "object" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigOcrParsingConfig", +"GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", "properties": { -"enhancedDocumentElements": { -"deprecated": true, -"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", +"format": "int64", +"type": "string" +}, +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", "items": { "type": "string" }, "type": "array" -}, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -6915,90 +7953,148 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1EnableAdvancedSiteSearchResponse", -"properties": {}, +"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" +} +}, "type": "object" }, -"GoogleCloudDiscoveryengineV1Engine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1Engine", +"GoogleCloudDiscoveryengineV1Schema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1Schema", "properties": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" }, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" }, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"createTime": { -"description": "Output only. Timestamp the Recommendation Engine was created at.", -"format": "google-datetime", -"readOnly": true, +"description": "The structured representation of the schema.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1SiteVerificationInfo": { +"description": "Verification information for target sites in advanced site search.", +"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", +"properties": { +"siteVerificationState": { +"description": "Site verification state indicating the ownership and validity.", +"enum": [ +"SITE_VERIFICATION_STATE_UNSPECIFIED", +"VERIFIED", +"UNVERIFIED", +"EXEMPTED" +], +"enumDescriptions": [ +"Defaults to VERIFIED.", +"Site ownership verified.", +"Site ownership pending verification or verification failed.", +"Site exempt from verification, e.g., a public website that opens to all." +], "type": "string" }, -"dataStoreIds": { -"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", -"items": { +"verifyTime": { +"description": "Latest site verification time.", +"format": "google-datetime", "type": "string" +} }, -"type": "array" +"type": "object" }, -"displayName": { -"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"GoogleCloudDiscoveryengineV1TargetSite": { +"description": "A target site for the SiteSearchEngine.", +"id": "GoogleCloudDiscoveryengineV1TargetSite", +"properties": { +"exactMatch": { +"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", +"type": "boolean" +}, +"failureReason": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", +"description": "Output only. Failure reason.", +"readOnly": true +}, +"generatedUriPattern": { +"description": "Output only. This is system-generated based on the provided_uri_pattern.", +"readOnly": true, "type": "string" }, -"industryVertical": { -"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"indexingStatus": { +"description": "Output only. Indexing status.", "enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" +"INDEXING_STATUS_UNSPECIFIED", +"PENDING", +"FAILED", +"SUCCEEDED", +"DELETING" ], "enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." +"Defaults to SUCCEEDED.", +"The target site is in the update queue and will be picked up by indexing pipeline.", +"The target site fails to be indexed.", +"The target site has been indexed.", +"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." ], +"readOnly": true, "type": "string" }, "name": { -"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", +"readOnly": true, "type": "string" }, -"searchEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", -"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +"providedUriPattern": { +"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"type": "string" }, -"solutionType": { -"description": "Required. The solutions of the engine.", +"rootDomainUri": { +"description": "Output only. Root domain of the provided_uri_pattern.", +"readOnly": true, +"type": "string" +}, +"siteVerificationInfo": { +"$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", +"description": "Output only. Site ownership and validity verification status.", +"readOnly": true +}, +"type": { +"description": "The type of the target site, e.g., whether the site is to be included or excluded.", "enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" +"TYPE_UNSPECIFIED", +"INCLUDE", +"EXCLUDE" ], "enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", +"Include the target site.", +"Exclude the target site." ], "type": "string" }, "updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"description": "Output only. The target site's last updated time.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -7006,386 +8102,525 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfig", +"GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { +"description": "Site search indexing failure reasons.", +"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", "properties": { -"agentCreationConfig": { -"$ref": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", -"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." -}, -"dialogflowAgentToLink": { -"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", -"type": "string" +"quotaFailure": { +"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", +"description": "Failed due to insufficient quota." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig": { -"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", -"id": "GoogleCloudDiscoveryengineV1EngineChatEngineConfigAgentCreationConfig", +"GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { +"description": "Failed due to insufficient quota.", +"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", "properties": { -"business": { -"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"totalRequiredQuota": { +"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", +"format": "int64", "type": "string" +} }, -"defaultLanguageCode": { -"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", -"type": "string" +"type": "object" }, -"location": { -"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { +"description": "Metadata for UpdateSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"timeZone": { -"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1EngineChatEngineMetadata", +"GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", "properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", +"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" }, -"GoogleCloudDiscoveryengineV1EngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1EngineCommonConfig", +"GoogleCloudDiscoveryengineV1alphaAclConfig": { +"description": "Access Control Configuration.", +"id": "GoogleCloudDiscoveryengineV1alphaAclConfig", "properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Identity provider config." +}, +"name": { +"description": "Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1EngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1EngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1alphaAnswer": { +"description": "Defines an answer.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswer", "properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", +"answerSkippedReasons": { +"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", "items": { "enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" +"ANSWER_SKIPPED_REASON_UNSPECIFIED", +"ADVERSARIAL_QUERY_IGNORED", +"NON_ANSWER_SEEKING_QUERY_IGNORED", +"OUT_OF_DOMAIN_QUERY_IGNORED", +"POTENTIAL_POLICY_VIOLATION", +"NO_RELEVANT_CONTENT" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." +"Default value. The answer skipped reason is not specified.", +"The adversarial query ignored case.", +"The non-answer seeking query ignored case.", +"The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", +"The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", +"The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." ], "type": "string" }, "type": "array" }, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"answerText": { +"description": "The textual answer.", +"type": "string" +}, +"citations": { +"description": "Citations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" +}, +"type": "array" +}, +"completeTime": { +"description": "Output only. Answer completed timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"createTime": { +"description": "Output only. Answer creation timestamp.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", +"type": "string" +}, +"queryUnderstandingInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", +"description": "Query understanding information." +}, +"references": { +"description": "References.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" +}, +"type": "array" +}, +"relatedQuestions": { +"description": "Suggested related questions.", +"items": { +"type": "string" +}, +"type": "array" +}, +"state": { +"description": "The state of the answer generation.", "enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." +"Unknown.", +"Answer generation is currently in progress.", +"Answer generation currently failed.", +"Answer generation has succeeded." ], "type": "string" +}, +"steps": { +"description": "Answer generation steps.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerCitation": { +"description": "Citation info for a segment.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"endIndex": { +"description": "End of the attributed segment, exclusive.", +"format": "int64", "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", +"sources": { +"description": "Citation sources for the attributed segment.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" +}, +"type": "array" +}, +"startIndex": { +"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", "format": "int64", "type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { +"description": "Citation source.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", +"properties": { +"referenceId": { +"description": "ID of the citation source.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { +"description": "Query understanding information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", +"properties": { +"queryClassificationInfo": { +"description": "Query classification information.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { +"description": "Query classification information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", +"properties": { +"positive": { +"description": "Classification output.", +"type": "boolean" +}, +"type": { +"description": "Query classification type.", +"enum": [ +"TYPE_UNSPECIFIED", +"ADVERSARIAL_QUERY", +"NON_ANSWER_SEEKING_QUERY" +], +"enumDescriptions": [ +"Unspecified query classification type.", +"Adversarial query classification type.", +"Non-answer-seeking query classification type." +], +"type": "string" +} }, -"successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", -"type": "string" +"type": "object" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaAnswerReference": { +"description": "Reference.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", +"properties": { +"chunkInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"description": "Chunk information." +}, +"unstructuredDocumentInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", +"description": "Unstructured document information." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse": { -"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", -"id": "GoogleCloudDiscoveryengineV1ImportCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"description": "The desired location of errors incurred during the Import." +"chunk": { +"description": "Chunk resource name.", +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"content": { +"description": "Chunk textual content.", +"type": "string" }, -"type": "array" +"documentMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"description": "Document metadata." +}, +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportDocumentsMetadata": { -"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { +"description": "Document metadata.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"document": { +"description": "Document resource name.", "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"pageIdentifier": { +"description": "Page identifier.", "type": "string" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" }, -"totalCount": { -"description": "Total count of entries that were processed.", -"format": "int64", +"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", +"type": "object" +}, +"title": { +"description": "Title.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"uri": { +"description": "URI for the document.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportDocumentsResponse": { -"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1ImportDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { +"description": "Unstructured document information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"chunkContents": { +"description": "List of cited chunk contents derived from document content.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" }, "type": "array" -} }, +"document": { +"description": "Document resource name.", +"type": "string" +}, +"structData": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"properties": { -"gcsPrefix": { -"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { +"description": "Chunk content.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"content": { +"description": "Chunk textual content.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"pageIdentifier": { +"description": "Page identifier.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1ImportSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerStep": { +"description": "Step information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"actions": { +"description": "Actions.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" }, "type": "array" }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", +"description": { +"description": "The description of the step.", "type": "string" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", +"state": { +"description": "The state of the step.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROGRESS", +"FAILED", +"SUCCEEDED" +], +"enumDescriptions": [ +"Unknown.", +"Step is currently in progress.", +"Step currently failed.", +"Step has succeeded." +], +"type": "string" +}, +"thought": { +"description": "The thought of the step.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1ImportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { +"description": "Action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" -}, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", -"type": "string" +"observation": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", +"description": "Observation." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"searchAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", +"description": "Search action." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ImportUserEventsResponse": { -"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1ImportUserEventsResponse", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { +"description": "Observation.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1ImportErrorConfig", -"description": "Echoes the destination for the complete errors if this field was set in the request." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"searchResults": { +"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" }, "type": "array" -}, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", -"type": "string" -}, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1Project": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1Project", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"chunkInfo": { +"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" }, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, +"type": "array" +}, +"document": { +"description": "Document resource name.", "type": "string" }, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"snippetInfo": { +"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" }, -"serviceTermsMap": { +"type": "array" +}, +"structData": { "additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1ProjectServiceTerms" +"description": "Properties of the object.", +"type": "any" }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" +}, +"title": { +"description": "Title.", +"type": "string" +}, +"uri": { +"description": "URI for the document.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1ProjectServiceTerms", +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { +"description": "Chunk information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", +"chunk": { +"description": "Chunk resource name.", "type": "string" }, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", +"content": { +"description": "Chunk textual content.", "type": "string" }, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"relevanceScore": { +"description": "Relevance score.", +"format": "float", +"type": "number" +} }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", -"enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" -], -"enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." -], +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { +"description": "Snippet information.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", +"properties": { +"snippet": { +"description": "Snippet content.", "type": "string" }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", +"snippetStatus": { +"description": "Status of the snippet defined by the search team.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1ProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1ProvisionProjectMetadata", -"properties": {}, +"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { +"description": "Search action.", +"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", +"properties": { +"query": { +"description": "The query to search.", +"type": "string" +} +}, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7400,267 +8635,257 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", -"id": "GoogleCloudDiscoveryengineV1PurgeCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { +"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", +"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"targetSites": { +"description": "TargetSites created.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" }, "type": "array" +} }, -"purgeSucceeded": { -"description": "Whether the completion suggestions were successfully purged.", -"type": "boolean" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCondition": { +"description": "Defines circumstances to be checked before allowing a behavior", +"id": "GoogleCloudDiscoveryengineV1alphaCondition", +"properties": { +"activeTimeRange": { +"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" +}, +"type": "array" +}, +"queryTerms": { +"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { +"description": "Matcher for search request query", +"id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"fullMatch": { +"description": "Whether the search query needs to exactly match the query term.", +"type": "boolean" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"value": { +"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", "type": "string" +} }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", -"type": "string" +"type": "object" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { +"description": "Used for time-dependent conditions.", +"id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", +"properties": { +"endTime": { +"description": "End of time range. Range is inclusive. Must be in the future.", +"format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", +"startTime": { +"description": "Start of time range. Range is inclusive.", "format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1PurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1PurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaControl": { +"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", +"id": "GoogleCloudDiscoveryengineV1alphaControl", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", +"associatedServingConfigIds": { +"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", +"items": { "type": "string" }, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"readOnly": true, +"type": "array" +}, +"boostAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", +"description": "Defines a boost-type control" +}, +"conditions": { +"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", "items": { -"type": "string" +"$ref": "GoogleCloudDiscoveryengineV1alphaCondition" }, "type": "array" -} }, -"type": "object" +"displayName": { +"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"filterAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", +"description": "Defines a filter-type control Currently not supported by Recommendation" +}, +"name": { +"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"redirectAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", +"description": "Defines a redirect-type control." +}, +"solutionType": { +"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], "type": "string" -} }, -"type": "object" +"synonymsAction": { +"$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", +"description": "Treats a group of terms as synonyms of one another." }, -"GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesResponse", -"properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"useCases": { +"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", "items": { -"$ref": "GoogleRpcStatus" +"enum": [ +"SEARCH_USE_CASE_UNSPECIFIED", +"SEARCH_USE_CASE_SEARCH", +"SEARCH_USE_CASE_BROWSE" +], +"enumDescriptions": [ +"Value used when unset. Will not occur in CSS.", +"Search use case. Expects the traffic has a non-empty query.", +"Browse use case. Expects the traffic has an empty query." +], +"type": "string" }, "type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1Schema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1Schema", +"GoogleCloudDiscoveryengineV1alphaControlBoostAction": { +"description": "Adjusts order of products in returned list.", +"id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", "properties": { -"jsonSchema": { -"description": "The JSON representation of the schema.", -"type": "string" +"boost": { +"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", +"format": "float", +"type": "number" }, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"dataStore": { +"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The structured representation of the schema.", -"type": "object" +"filter": { +"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1SiteVerificationInfo": { -"description": "Verification information for target sites in advanced site search.", -"id": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", +"GoogleCloudDiscoveryengineV1alphaControlFilterAction": { +"description": "Specified which products may be included in results. Uses same filter as boost.", +"id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", "properties": { -"siteVerificationState": { -"description": "Site verification state indicating the ownership and validity.", -"enum": [ -"SITE_VERIFICATION_STATE_UNSPECIFIED", -"VERIFIED", -"UNVERIFIED", -"EXEMPTED" -], -"enumDescriptions": [ -"Defaults to VERIFIED.", -"Site ownership verified.", -"Site ownership pending verification or verification failed.", -"Site exempt from verification, e.g., a public website that opens to all." -], +"dataStore": { +"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", "type": "string" }, -"verifyTime": { -"description": "Latest site verification time.", -"format": "google-datetime", +"filter": { +"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1TargetSite": { -"description": "A target site for the SiteSearchEngine.", -"id": "GoogleCloudDiscoveryengineV1TargetSite", +"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { +"description": "Redirects a shopper to the provided URI.", +"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", "properties": { -"exactMatch": { -"description": "Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.", -"type": "boolean" -}, -"failureReason": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", -"description": "Output only. Failure reason.", -"readOnly": true -}, -"generatedUriPattern": { -"description": "Output only. This is system-generated based on the provided_uri_pattern.", -"readOnly": true, -"type": "string" -}, -"indexingStatus": { -"description": "Output only. Indexing status.", -"enum": [ -"INDEXING_STATUS_UNSPECIFIED", -"PENDING", -"FAILED", -"SUCCEEDED", -"DELETING" -], -"enumDescriptions": [ -"Defaults to SUCCEEDED.", -"The target site is in the update queue and will be picked up by indexing pipeline.", -"The target site fails to be indexed.", -"The target site has been indexed.", -"The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails." -], -"readOnly": true, +"redirectUri": { +"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" +} }, -"name": { -"description": "Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.", -"readOnly": true, -"type": "string" +"type": "object" }, -"providedUriPattern": { -"description": "Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.", +"GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { +"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", +"id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", +"properties": { +"synonyms": { +"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"items": { "type": "string" }, -"rootDomainUri": { -"description": "Output only. Root domain of the provided_uri_pattern.", -"readOnly": true, -"type": "string" +"type": "array" +} }, -"siteVerificationInfo": { -"$ref": "GoogleCloudDiscoveryengineV1SiteVerificationInfo", -"description": "Output only. Site ownership and validity verification status.", -"readOnly": true +"type": "object" }, -"type": { -"description": "The type of the target site, e.g., whether the site is to be included or excluded.", -"enum": [ -"TYPE_UNSPECIFIED", -"INCLUDE", -"EXCLUDE" -], -"enumDescriptions": [ -"This value is unused. In this case, server behavior defaults to Type.INCLUDE.", -"Include the target site.", -"Exclude the target site." -], +"GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, "updateTime": { -"description": "Output only. The target site's last updated time.", +"description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", -"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1TargetSiteFailureReason": { -"description": "Site search indexing failure reasons.", -"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReason", +"GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", "properties": { -"quotaFailure": { -"$ref": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", -"description": "Failed due to insufficient quota." -} -}, -"type": "object" +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure": { -"description": "Failed due to insufficient quota.", -"id": "GoogleCloudDiscoveryengineV1TargetSiteFailureReasonQuotaFailure", -"properties": { -"totalRequiredQuota": { -"description": "This number is an estimation on how much total quota this project needs to successfully complete indexing.", -"format": "int64", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1UpdateSchemaMetadata": { -"description": "Metadata for UpdateSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1UpdateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { +"description": "Metadata for Create Schema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7675,9 +8900,9 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1UpdateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -7692,744 +8917,816 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAclConfig": { -"description": "Access Control Configuration.", -"id": "GoogleCloudDiscoveryengineV1alphaAclConfig", +"GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec": { +"description": "Defines custom fine tuning spec.", +"id": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", "properties": { -"idpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"description": "Identity provider config." +"enableSearchAdaptor": { +"description": "Whether or not to enable and include custom fine tuned search adaptor model.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { +"description": "Metadata that describes a custom tuned model.", +"id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", +"properties": { +"createTime": { +"deprecated": true, +"description": "Timestamp the Model was created at.", +"format": "google-datetime", +"type": "string" +}, +"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": "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.", +"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" }, -"GoogleCloudDiscoveryengineV1alphaAnswer": { -"description": "Defines an answer.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswer", +"GoogleCloudDiscoveryengineV1alphaDataStore": { +"description": "DataStore captures global settings and configs at the DataStore level.", +"id": "GoogleCloudDiscoveryengineV1alphaDataStore", "properties": { -"answerSkippedReasons": { -"description": "Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.", -"items": { +"aclEnabled": { +"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", +"type": "boolean" +}, +"contentConfig": { +"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", "enum": [ -"ANSWER_SKIPPED_REASON_UNSPECIFIED", -"ADVERSARIAL_QUERY_IGNORED", -"NON_ANSWER_SEEKING_QUERY_IGNORED", -"OUT_OF_DOMAIN_QUERY_IGNORED", -"POTENTIAL_POLICY_VIOLATION", -"NO_RELEVANT_CONTENT" +"CONTENT_CONFIG_UNSPECIFIED", +"NO_CONTENT", +"CONTENT_REQUIRED", +"PUBLIC_WEBSITE" ], "enumDescriptions": [ -"Default value. The answer skipped reason is not specified.", -"The adversarial query ignored case.", -"The non-answer seeking query ignored case.", -"The out-of-domain query ignored case. Google skips the answer if there are no high-relevance search results.", -"The potential policy violation case. Google skips the answer if there is a potential policy violation detected. This includes content that may be violent or toxic.", -"The no relevant content case. Google skips the answer if there is no relevant content in the retrieved search results." +"Default value.", +"Only contains documents without any Document.content.", +"Only contains documents with Document.content.", +"The data store is used for public website search." ], "type": "string" }, -"type": "array" -}, -"answerText": { -"description": "The textual answer.", -"type": "string" -}, -"citations": { -"description": "Citations.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitation" -}, -"type": "array" -}, -"completeTime": { -"description": "Output only. Answer completed timestamp.", +"createTime": { +"description": "Output only. Timestamp the DataStore was created at.", "format": "google-datetime", "readOnly": true, "type": "string" }, -"createTime": { -"description": "Output only. Answer creation timestamp.", -"format": "google-datetime", +"defaultSchemaId": { +"description": "Output only. The id of the default Schema asscociated to this data store.", "readOnly": true, "type": "string" }, -"name": { -"description": "Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*`", +"displayName": { +"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", "type": "string" }, -"queryUnderstandingInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", -"description": "Query understanding information." -}, -"references": { -"description": "References.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReference" -}, -"type": "array" -}, -"relatedQuestions": { -"description": "Suggested related questions.", -"items": { -"type": "string" +"documentProcessingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", +"description": "Configuration for Document understanding and enrichment." }, -"type": "array" +"idpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", +"description": "Output only. Data store level identity provider config.", +"readOnly": true }, -"state": { -"description": "The state of the answer generation.", +"industryVertical": { +"description": "Immutable. The industry vertical that the data store registers.", "enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS", -"FAILED", -"SUCCEEDED" +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" ], "enumDescriptions": [ -"Unknown.", -"Answer generation is currently in progress.", -"Answer generation currently failed.", -"Answer generation has succeeded." +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." ], "type": "string" }, -"steps": { -"description": "Answer generation steps.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStep" -}, -"type": "array" -} -}, -"type": "object" +"languageInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", +"description": "Language info for DataStore." }, -"GoogleCloudDiscoveryengineV1alphaAnswerCitation": { -"description": "Citation info for a segment.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitation", -"properties": { -"endIndex": { -"description": "End of the attributed segment, exclusive.", -"format": "int64", +"name": { +"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, -"sources": { -"description": "Citation sources for the attributed segment.", +"solutionTypes": { +"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource" +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], +"type": "string" }, "type": "array" }, -"startIndex": { -"description": "Index indicates the start of the segment, measured in bytes (UTF-8 unicode).", -"format": "int64", -"type": "string" +"startingSchema": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSchema", +"description": "The start schema to use for this DataStore when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by CreateDataStore API, and will be ignored if used in other APIs. This field will be omitted from all API responses including CreateDataStore API. To retrieve a schema of a DataStore, use SchemaService.GetSchema API instead. The provided schema will be validated against certain rules on schema. Learn more from [this doc](https://cloud.google.com/generative-ai-app-builder/docs/provide-schema)." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerCitationSource": { -"description": "Citation source.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerCitationSource", +"GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { +"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", "properties": { -"referenceId": { -"description": "ID of the citation source.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo": { -"description": "Query understanding information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfo", -"properties": { -"queryClassificationInfo": { -"description": "Query classification information.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo": { -"description": "Query classification information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerQueryUnderstandingInfoQueryClassificationInfo", -"properties": { -"positive": { -"description": "Classification output.", -"type": "boolean" }, -"type": { -"description": "Query classification type.", -"enum": [ -"TYPE_UNSPECIFIED", -"ADVERSARIAL_QUERY", -"NON_ANSWER_SEEKING_QUERY" -], -"enumDescriptions": [ -"Unspecified query classification type.", -"Adversarial query classification type.", -"Non-answer-seeking query classification type." -], +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReference": { -"description": "Reference.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReference", +"GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { +"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", "properties": { -"chunkInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", -"description": "Chunk information." +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"unstructuredDocumentInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", -"description": "Unstructured document information." +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo": { -"description": "Chunk information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo", +"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { +"description": "Metadata for DeleteSchema LRO.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", "properties": { -"chunk": { -"description": "Chunk resource name.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"content": { -"description": "Chunk textual content.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" -}, -"documentMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", -"description": "Document metadata." -}, -"relevanceScore": { -"description": "Relevance score.", -"format": "float", -"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata": { -"description": "Document metadata.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata", +"GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", "properties": { -"document": { -"description": "Document resource name.", +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"pageIdentifier": { -"description": "Page identifier.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"structData": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", "type": "object" }, -"title": { -"description": "Title.", +"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"uri": { -"description": "URI for the document.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo": { -"description": "Unstructured document information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo", +"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { +"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", "properties": { -"chunkContents": { -"description": "List of cited chunk contents derived from document content.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent" +"chunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"description": "Whether chunking mode is enabled." }, -"type": "array" +"defaultParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", +"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." }, -"document": { -"description": "Document resource name.", +"name": { +"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", "type": "string" }, -"structData": { +"parsingConfigOverrides": { "additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" }, -"description": "The structured JSON metadata for the document. It is populated from the struct data from the Chunk in search result.", +"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", "type": "object" +} }, -"title": { -"description": "Title.", -"type": "string" +"type": "object" }, -"uri": { -"description": "URI for the document.", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { +"description": "Configuration for chunking config.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"properties": { +"layoutBasedChunkingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"description": "Configuration for the layout based chunking." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent": { -"description": "Chunk content.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent", +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { +"description": "Configuration for the layout based chunking.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", "properties": { -"content": { -"description": "Chunk textual content.", -"type": "string" +"chunkSize": { +"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", +"format": "int32", +"type": "integer" }, -"pageIdentifier": { -"description": "Page identifier.", -"type": "string" +"includeAncestorHeadings": { +"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStep": { -"description": "Step information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStep", +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { +"description": "Related configurations applied to a specific type of document parser.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", "properties": { -"actions": { -"description": "Actions.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction" +"digitalParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"description": "Configurations applied to digital parser." }, -"type": "array" +"layoutParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"description": "Configurations applied to layout parser." }, -"description": { -"description": "The description of the step.", -"type": "string" +"ocrParsingConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +} }, -"state": { -"description": "The state of the step.", -"enum": [ -"STATE_UNSPECIFIED", -"IN_PROGRESS", -"FAILED", -"SUCCEEDED" -], -"enumDescriptions": [ -"Unknown.", -"Step is currently in progress.", -"Step currently failed.", -"Step has succeeded." -], -"type": "string" +"type": "object" }, -"thought": { -"description": "The thought of the step.", -"type": "string" -} +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { +"description": "The digital parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", +"properties": {}, +"type": "object" }, +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { +"description": "The layout parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", +"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepAction": { -"description": "Action.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepAction", +"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { +"description": "The OCR parsing configurations for documents.", +"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", "properties": { -"observation": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", -"description": "Observation." +"enhancedDocumentElements": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"items": { +"type": "string" }, -"searchAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", -"description": "Search action." +"type": "array" +}, +"useNativeText": { +"description": "If true, will use native text instead of OCR text on pages containing native text.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation": { -"description": "Observation.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservation", +"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", "properties": { -"searchResults": { -"description": "Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult" +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" }, -"type": "array" +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult": { -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResult", +"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { +"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", +"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaEngine": { +"description": "Metadata that describes the training and serving parameters of an Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngine", "properties": { -"chunkInfo": { -"description": "If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.", +"chatEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", +"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." +}, +"chatEngineMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", +"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", +"readOnly": true +}, +"commonConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", +"description": "Common config spec that specifies the metadata of the engine." +}, +"createTime": { +"description": "Output only. Timestamp the Recommendation Engine was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"dataStoreIds": { +"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo" +"type": "string" }, "type": "array" }, -"document": { -"description": "Document resource name.", +"displayName": { +"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", "type": "string" }, -"snippetInfo": { -"description": "If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo" +"industryVertical": { +"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", +"enum": [ +"INDUSTRY_VERTICAL_UNSPECIFIED", +"GENERIC", +"MEDIA", +"HEALTHCARE_FHIR" +], +"enumDescriptions": [ +"Value used when unset.", +"The generic vertical for documents that are not specific to any industry vertical.", +"The media industry vertical.", +"The healthcare FHIR vertical." +], +"type": "string" +}, +"mediaRecommendationEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", +"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." +}, +"name": { +"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"type": "string" }, -"type": "array" +"recommendationMetadata": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", +"description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", +"readOnly": true }, -"structData": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchEngineConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", -"type": "object" +"similarDocumentsConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", +"description": "Additional config specs for a `similar-items` engine." }, -"title": { -"description": "Title.", +"solutionType": { +"description": "Required. The solutions of the engine.", +"enum": [ +"SOLUTION_TYPE_UNSPECIFIED", +"SOLUTION_TYPE_RECOMMENDATION", +"SOLUTION_TYPE_SEARCH", +"SOLUTION_TYPE_CHAT", +"SOLUTION_TYPE_GENERATIVE_CHAT" +], +"enumDescriptions": [ +"Default value.", +"Used for Recommendations AI.", +"Used for Discovery Search.", +"Used for use cases related to the Generative AI agent.", +"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +], "type": "string" }, -"uri": { -"description": "URI for the document.", +"updateTime": { +"description": "Output only. Timestamp the Recommendation Engine was last updated.", +"format": "google-datetime", +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo": { -"description": "Chunk information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultChunkInfo", +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { +"description": "Configurations for a Chat Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", "properties": { -"chunk": { -"description": "Chunk resource name.", -"type": "string" +"agentCreationConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", +"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." }, -"content": { -"description": "Chunk textual content.", +"dialogflowAgentToLink": { +"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", "type": "string" -}, -"relevanceScore": { -"description": "Relevance score.", -"format": "float", -"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo": { -"description": "Snippet information.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo", +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { +"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", "properties": { -"snippet": { -"description": "Snippet content.", +"business": { +"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", "type": "string" }, -"snippetStatus": { -"description": "Status of the snippet defined by the search team.", +"defaultLanguageCode": { +"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", "type": "string" -} }, -"type": "object" +"location": { +"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction": { -"description": "Search action.", -"id": "GoogleCloudDiscoveryengineV1alphaAnswerStepActionSearchAction", -"properties": { -"query": { -"description": "The query to search.", +"timeZone": { +"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.BatchCreateTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { +"description": "Additional information of a Chat Engine. Fields in this message are output only.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"dialogflowAgent": { +"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse": { -"description": "Response message for SiteSearchEngineService.BatchCreateTargetSites method.", -"id": "GoogleCloudDiscoveryengineV1alphaBatchCreateTargetSitesResponse", +"GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", "properties": { -"targetSites": { -"description": "TargetSites created.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaTargetSite" -}, -"type": "array" +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCondition": { -"description": "Defines circumstances to be checked before allowing a behavior", -"id": "GoogleCloudDiscoveryengineV1alphaCondition", +"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { +"description": "Additional config specs for a Media Recommendation engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", "properties": { -"activeTimeRange": { -"description": "Range of time(s) specifying when condition is active. Maximum of 10 time ranges.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange" -}, -"type": "array" -}, -"queryTerms": { -"description": "Search only A list of terms to match the query on. Maximum of 10 query terms.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm" -}, -"type": "array" -} +"optimizationObjective": { +"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", +"type": "string" }, -"type": "object" +"optimizationObjectiveConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", +"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." }, -"GoogleCloudDiscoveryengineV1alphaConditionQueryTerm": { -"description": "Matcher for search request query", -"id": "GoogleCloudDiscoveryengineV1alphaConditionQueryTerm", -"properties": { -"fullMatch": { -"description": "Whether the search query needs to exactly match the query term.", -"type": "boolean" +"trainingState": { +"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", +"enum": [ +"TRAINING_STATE_UNSPECIFIED", +"PAUSED", +"TRAINING" +], +"enumDescriptions": [ +"Unspecified training state.", +"The engine training is paused.", +"The engine is training." +], +"type": "string" }, -"value": { -"description": "The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters.", +"type": { +"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaConditionTimeRange": { -"description": "Used for time-dependent conditions.", -"id": "GoogleCloudDiscoveryengineV1alphaConditionTimeRange", +"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { +"description": "Custom threshold for `cvr` optimization_objective.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", "properties": { -"endTime": { -"description": "End of time range. Range is inclusive. Must be in the future.", -"format": "google-datetime", +"targetField": { +"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", "type": "string" }, -"startTime": { -"description": "Start of time range. Range is inclusive.", -"format": "google-datetime", -"type": "string" +"targetFieldValueFloat": { +"description": "Required. The threshold to be applied to the target (e.g., 0.5).", +"format": "float", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControl": { -"description": "Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`.", -"id": "GoogleCloudDiscoveryengineV1alphaControl", +"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { +"description": "Additional information of a recommendation engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", "properties": { -"associatedServingConfigIds": { -"description": "Output only. List of all ServingConfig ids this control is attached to. May take up to 10 minutes to update after changes.", -"items": { +"dataState": { +"description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", +"enum": [ +"DATA_STATE_UNSPECIFIED", +"DATA_OK", +"DATA_ERROR" +], +"enumDescriptions": [ +"Unspecified default value, should never be explicitly set.", +"The engine has sufficient training data.", +"The engine does not have sufficient training data. Error messages can be queried via Stackdriver." +], +"readOnly": true, "type": "string" }, +"lastTuneTime": { +"description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", +"format": "google-datetime", "readOnly": true, -"type": "array" -}, -"boostAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", -"description": "Defines a boost-type control" -}, -"conditions": { -"description": "Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaCondition" -}, -"type": "array" -}, -"displayName": { -"description": "Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown.", "type": "string" }, -"filterAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", -"description": "Defines a filter-type control Currently not supported by Recommendation" +"servingState": { +"description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", +"enum": [ +"SERVING_STATE_UNSPECIFIED", +"INACTIVE", +"ACTIVE", +"TUNED" +], +"enumDescriptions": [ +"Unspecified serving state.", +"The engine is not serving.", +"The engine is serving and can be queried.", +"The engine is trained on tuned hyperparameters and can be queried." +], +"readOnly": true, +"type": "string" }, -"name": { -"description": "Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*`", +"tuningOperation": { +"description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", +"readOnly": true, "type": "string" +} }, -"redirectAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", -"description": "Defines a redirect-type control." +"type": "object" }, -"solutionType": { -"description": "Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown.", +"GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"properties": { +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { "enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" ], "enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." ], "type": "string" }, -"synonymsAction": { -"$ref": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", -"description": "Treats a group of terms as synonyms of one another." +"type": "array" }, -"useCases": { -"description": "Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH.", -"items": { +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", "enum": [ -"SEARCH_USE_CASE_UNSPECIFIED", -"SEARCH_USE_CASE_SEARCH", -"SEARCH_USE_CASE_BROWSE" +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" ], "enumDescriptions": [ -"Value used when unset. Will not occur in CSS.", -"Search use case. Expects the traffic has a non-empty query.", -"Browse use case. Expects the traffic has an empty query." +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." ], "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControlBoostAction": { -"description": "Adjusts order of products in returned list.", -"id": "GoogleCloudDiscoveryengineV1alphaControlBoostAction", -"properties": { -"boost": { -"description": "Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op).", -"format": "float", -"type": "number" -}, -"dataStore": { -"description": "Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", -"type": "string" +"GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { +"description": "Additional config specs for a `similar-items` engine.", +"id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", +"properties": {}, +"type": "object" }, -"filter": { -"description": "Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { +"description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControlFilterAction": { -"description": "Specified which products may be included in results. Uses same filter as boost.", -"id": "GoogleCloudDiscoveryengineV1alphaControlFilterAction", +"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { +"description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", "properties": { -"dataStore": { -"description": "Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store", +"dataSizeBytes": { +"description": "Data size in terms of bytes.", +"format": "int64", "type": "string" }, -"filter": { -"description": "Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"documentCount": { +"description": "Total number of documents.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaControlRedirectAction": { -"description": "Redirects a shopper to the provided URI.", -"id": "GoogleCloudDiscoveryengineV1alphaControlRedirectAction", +"GoogleCloudDiscoveryengineV1alphaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluation", "properties": { -"redirectUri": { -"description": "Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown.", +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, "type": "string" -} }, -"type": "object" +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaControlSynonymsAction": { -"description": "Creates a set of terms that will act as synonyms of one another. Example: \"happy\" will also be considered as \"glad\", \"glad\" will also be considered as \"happy\".", -"id": "GoogleCloudDiscoveryengineV1alphaControlSynonymsAction", -"properties": { -"synonyms": { -"description": "Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown.", +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", "items": { -"type": "string" +"$ref": "GoogleRpcStatus" }, +"readOnly": true, "type": "array" -} }, -"type": "object" +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." }, -"GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateDataStoreMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true +}, +"state": { +"description": "Output only. The state of the evaluation.", +"enum": [ +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" +], +"enumDescriptions": [ +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." +], +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata": { -"description": "Metadata for Create Schema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpecQuerySetSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaCreateTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { +"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8444,193 +9741,245 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaCustomTuningModel": { -"description": "Metadata that describes a custom tuned model.", -"id": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel", +"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { +"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", "properties": { -"createTime": { -"deprecated": true, -"description": "Timestamp the Model was created at.", -"format": "google-datetime", -"type": "string" +"outputResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"description": "Output result indicating where the data were exported to." }, -"displayName": { -"description": "The display name of the model.", +"status": { +"$ref": "GoogleRpcStatus", +"description": "The status of the export operation." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaFieldConfig": { +"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", +"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", +"properties": { +"advancedSiteSearchDataSources": { +"description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", +"items": { +"enum": [ +"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", +"METATAGS", +"PAGEMAP", +"SCHEMA_ORG" +], +"enumDescriptions": [ +"Value used when unset.", +"Retrieve value from meta tag.", +"Retrieve value from page map.", +"Retrieve value from schema.org data." +], "type": "string" }, -"metrics": { -"additionalProperties": { -"format": "double", -"type": "number" +"type": "array" }, -"description": "The metrics of the trained model.", -"type": "object" +"completableOption": { +"description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", +"enum": [ +"COMPLETABLE_OPTION_UNSPECIFIED", +"COMPLETABLE_ENABLED", +"COMPLETABLE_DISABLED" +], +"enumDescriptions": [ +"Value used when unset.", +"Completable option enabled for a schema field.", +"Completable option disabled for a schema field." +], +"type": "string" }, -"modelState": { -"description": "The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).", +"dynamicFacetableOption": { +"description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ -"MODEL_STATE_UNSPECIFIED", -"TRAINING_PAUSED", -"TRAINING", -"TRAINING_COMPLETE", -"READY_FOR_SERVING", -"TRAINING_FAILED", -"NO_IMPROVEMENT" +"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", +"DYNAMIC_FACETABLE_ENABLED", +"DYNAMIC_FACETABLE_DISABLED" ], "enumDescriptions": [ -"Default value.", -"The model is in a paused training state.", -"The model is currently training.", -"The model has successfully completed training.", -"The model is ready for serving.", -"The model training failed.", -"The model training finished successfully but metrics did not improve." +"Value used when unset.", +"Dynamic facetable option enabled for a schema field.", +"Dynamic facetable option disabled for a schema field." ], "type": "string" }, -"modelVersion": { -"description": "The version of the model.", -"format": "int64", -"type": "string" -}, -"name": { -"description": "Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters.", -"type": "string" -}, -"trainingStartTime": { -"description": "Timestamp the model training was initiated.", -"format": "google-datetime", +"fieldPath": { +"description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", "type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDataStore": { -"description": "DataStore captures global settings and configs at the DataStore level.", -"id": "GoogleCloudDiscoveryengineV1alphaDataStore", -"properties": { -"aclEnabled": { -"description": "Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config.", -"type": "boolean" }, -"contentConfig": { -"description": "Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT.", +"fieldType": { +"description": "Output only. Raw type of the field.", "enum": [ -"CONTENT_CONFIG_UNSPECIFIED", -"NO_CONTENT", -"CONTENT_REQUIRED", -"PUBLIC_WEBSITE" +"FIELD_TYPE_UNSPECIFIED", +"OBJECT", +"STRING", +"NUMBER", +"INTEGER", +"BOOLEAN", +"GEOLOCATION", +"DATETIME" ], "enumDescriptions": [ -"Default value.", -"Only contains documents without any Document.content.", -"Only contains documents with Document.content.", -"The data store is used for public website search." +"Field type is unspecified.", +"Field value type is Object.", +"Field value type is String.", +"Field value type is Number.", +"Field value type is Integer.", +"Field value type is Boolean.", +"Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", +"Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" ], +"readOnly": true, "type": "string" }, -"createTime": { -"description": "Output only. Timestamp the DataStore was created at.", -"format": "google-datetime", -"readOnly": true, +"indexableOption": { +"description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", +"enum": [ +"INDEXABLE_OPTION_UNSPECIFIED", +"INDEXABLE_ENABLED", +"INDEXABLE_DISABLED" +], +"enumDescriptions": [ +"Value used when unset.", +"Indexable option enabled for a schema field.", +"Indexable option disabled for a schema field." +], "type": "string" }, -"defaultSchemaId": { -"description": "Output only. The id of the default Schema asscociated to this data store.", +"keyPropertyType": { +"description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", "readOnly": true, "type": "string" }, -"displayName": { -"description": "Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.", +"recsFilterableOption": { +"description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", +"enum": [ +"FILTERABLE_OPTION_UNSPECIFIED", +"FILTERABLE_ENABLED", +"FILTERABLE_DISABLED" +], +"enumDescriptions": [ +"Value used when unset.", +"Filterable option enabled for a schema field.", +"Filterable option disabled for a schema field." +], "type": "string" }, -"documentProcessingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", -"description": "Configuration for Document understanding and enrichment." -}, -"idpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"description": "Output only. Data store level identity provider config.", -"readOnly": true -}, -"industryVertical": { -"description": "Immutable. The industry vertical that the data store registers.", +"retrievableOption": { +"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" +"RETRIEVABLE_OPTION_UNSPECIFIED", +"RETRIEVABLE_ENABLED", +"RETRIEVABLE_DISABLED" ], "enumDescriptions": [ "Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." +"Retrievable option enabled for a schema field.", +"Retrievable option disabled for a schema field." ], "type": "string" }, -"languageInfo": { -"$ref": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", -"description": "Language info for DataStore." -}, -"name": { -"description": "Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"schemaOrgPaths": { +"description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", +"items": { "type": "string" }, -"solutionTypes": { -"description": "The solutions that the data store enrolls. Available solutions for each industry_vertical: * `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. * `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.", -"items": { +"type": "array" +}, +"searchableOption": { +"description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", "enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" +"SEARCHABLE_OPTION_UNSPECIFIED", +"SEARCHABLE_ENABLED", +"SEARCHABLE_DISABLED" ], "enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." +"Value used when unset.", +"Searchable option enabled for a schema field.", +"Searchable option disabled for a schema field." ], "type": "string" +} }, -"type": "array" +"type": "object" }, -"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)." +"GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.GetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaGetUriPatternDocumentDataResponse", +"properties": { +"documentDataMap": { +"additionalProperties": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"description": "Document data keyed by URI pattern. For example: document_data_map = { \"www.url1.com/*\": { \"Categories\": [\"category1\", \"category2\"] }, \"www.url2.com/*\": { \"Categories\": [\"category3\"] } }", +"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata": { -"description": "Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteDataStoreMetadata", +"GoogleCloudDiscoveryengineV1alphaIdpConfig": { +"description": "Identity Provider Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"externalIdpConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"description": "External Identity provider config." +}, +"idpType": { +"description": "Identity provider type configured.", +"enum": [ +"IDP_TYPE_UNSPECIFIED", +"GSUITE", +"THIRD_PARTY" +], +"enumDescriptions": [ +"Default value. ACL search not enabled.", +"Google 1P provider.", +"Third party provider." +], "type": "string" +} }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { +"description": "Third party IDP Config.", +"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"properties": { +"workforcePoolName": { +"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata": { -"description": "Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, +"failureCount": { +"description": "Count of CompletionSuggestions that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of CompletionSuggestions successfully imported.", +"format": "int64", +"type": "string" +}, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", @@ -8639,47 +9988,46 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata": { -"description": "Metadata for DeleteSchema LRO.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteSchemaMetadata", +"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { +"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDeleteTargetSiteMetadata", +"GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { +"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" -} }, -"type": "object" +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"totalCount": { +"description": "Total count of entries that were processed.", +"format": "int64", "type": "string" }, "updateTime": { @@ -8690,118 +10038,88 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1alphaDisableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig": { -"description": "A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to DataStoreService.UpdateDocumentProcessingConfig method will initialize the config.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig", +"GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { +"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", "properties": { -"chunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", -"description": "Whether chunking mode is enabled." -}, -"defaultParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", -"description": "Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing." -}, -"name": { -"description": "The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`.", -"type": "string" +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "Echoes the destination for the complete errors in the request if set." }, -"parsingConfigOverrides": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig" +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"description": "Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.", -"type": "object" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig": { -"description": "Configuration for chunking config.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfig", +"GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { +"description": "Configuration of destination for Import related errors.", +"id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", "properties": { -"layoutBasedChunkingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", -"description": "Configuration for the layout based chunking." +"gcsPrefix": { +"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig": { -"description": "Configuration for the layout based chunking.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigChunkingConfigLayoutBasedChunkingConfig", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesMetadata", "properties": { -"chunkSize": { -"description": "The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500.", -"format": "int32", -"type": "integer" -}, -"includeAncestorHeadings": { -"description": "Whether to include appending different levels of headings to chunks from the middle of the document to prevent context loss. Default value: False.", -"type": "boolean" -} +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" }, -"type": "object" +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig": { -"description": "Related configurations applied to a specific type of document parser.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig", -"properties": { -"digitalParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"description": "Configurations applied to digital parser." +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" }, -"layoutParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"description": "Configurations applied to layout parser." +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" }, -"ocrParsingConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", -"description": "Configurations applied to OCR parser. Currently it only applies to PDFs." +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig": { -"description": "The digital parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig": { -"description": "The layout parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig": { -"description": "The OCR parsing configurations for documents.", -"id": "GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigOcrParsingConfig", +"GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSampleQueriesResponse", "properties": { -"enhancedDocumentElements": { -"deprecated": true, -"description": "[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to `layout_parsing_config`.", +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", "items": { -"type": "string" +"$ref": "GoogleRpcStatus" }, "type": "array" -}, -"useNativeText": { -"description": "If true, will use native text instead of OCR text on pages containing native text.", -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchMetadata", +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -8816,343 +10134,346 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse": { -"description": "Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.", -"id": "GoogleCloudDiscoveryengineV1alphaEnableAdvancedSiteSearchResponse", -"properties": {}, -"type": "object" -}, -"GoogleCloudDiscoveryengineV1alphaEngine": { -"description": "Metadata that describes the training and serving parameters of an Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngine", +"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", "properties": { -"chatEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", -"description": "Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT." -}, -"chatEngineMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", -"description": "Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.", -"readOnly": true +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"commonConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", -"description": "Common config spec that specifies the metadata of the engine." +"type": "array" }, -"createTime": { -"description": "Output only. Timestamp the Recommendation Engine was created at.", -"format": "google-datetime", -"readOnly": true, +"failedEntriesCount": { +"description": "Count of deny list entries that failed to be imported.", +"format": "int64", "type": "string" }, -"dataStoreIds": { -"description": "The data stores associated with this engine. For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store. If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same Collection can be associated here. Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.", -"items": { +"importedEntriesCount": { +"description": "Count of deny list entries successfully imported.", +"format": "int64", "type": "string" +} }, -"type": "array" +"type": "object" }, -"displayName": { -"description": "Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.", +"GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { +"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"industryVertical": { -"description": "The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine.", -"enum": [ -"INDUSTRY_VERTICAL_UNSPECIFIED", -"GENERIC", -"MEDIA", -"HEALTHCARE_FHIR" -], -"enumDescriptions": [ -"Value used when unset.", -"The generic vertical for documents that are not specific to any industry vertical.", -"The media industry vertical.", -"The healthcare FHIR vertical." -], +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" }, -"mediaRecommendationEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", -"description": "Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical." +"successCount": { +"description": "Count of entries that were processed successfully.", +"format": "int64", +"type": "string" }, -"name": { -"description": "Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"recommendationMetadata": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", -"description": "Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.", -"readOnly": true +"type": "object" }, -"searchEngineConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", -"description": "Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH." +"GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { +"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", +"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", +"description": "Echoes the destination for the complete errors if this field was set in the request." }, -"similarDocumentsConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", -"description": "Additional config specs for a `similar-items` engine." +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"solutionType": { -"description": "Required. The solutions of the engine.", -"enum": [ -"SOLUTION_TYPE_UNSPECIFIED", -"SOLUTION_TYPE_RECOMMENDATION", -"SOLUTION_TYPE_SEARCH", -"SOLUTION_TYPE_CHAT", -"SOLUTION_TYPE_GENERATIVE_CHAT" -], -"enumDescriptions": [ -"Default value.", -"Used for Recommendations AI.", -"Used for Discovery Search.", -"Used for use cases related to the Generative AI agent.", -"Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution." -], +"type": "array" +}, +"joinedEventsCount": { +"description": "Count of user events imported with complete existing Documents.", +"format": "int64", "type": "string" }, -"updateTime": { -"description": "Output only. Timestamp the Recommendation Engine was last updated.", -"format": "google-datetime", -"readOnly": true, +"unjoinedEventsCount": { +"description": "Count of user events imported, but with Document information not found in the existing Branch.", +"format": "int64", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig": { -"description": "Configurations for a Chat Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig", +"GoogleCloudDiscoveryengineV1alphaInterval": { +"description": "A floating point interval.", +"id": "GoogleCloudDiscoveryengineV1alphaInterval", "properties": { -"agentCreationConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", -"description": "The configurationt generate the Dialogflow agent that is associated to this Engine. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation." +"exclusiveMaximum": { +"description": "Exclusive upper bound.", +"format": "double", +"type": "number" }, -"dialogflowAgentToLink": { -"description": "The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide `agent_creation_config` to create agent or provide an agent name that links the agent with the Chat engine. Format: `projects//locations//agents/`. Note that the `dialogflow_agent_to_link` are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.", -"type": "string" +"exclusiveMinimum": { +"description": "Exclusive lower bound.", +"format": "double", +"type": "number" +}, +"maximum": { +"description": "Inclusive upper bound.", +"format": "double", +"type": "number" +}, +"minimum": { +"description": "Inclusive lower bound.", +"format": "double", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig": { -"description": "Configurations for generating a Dialogflow agent. Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfigAgentCreationConfig", +"GoogleCloudDiscoveryengineV1alphaLanguageInfo": { +"description": "Language info for DataStore.", +"id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", "properties": { -"business": { -"description": "Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.", +"language": { +"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", +"readOnly": true, "type": "string" }, -"defaultLanguageCode": { -"description": "Required. The default language of the agent as a language tag. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes.", +"languageCode": { +"description": "The language code for the DataStore.", "type": "string" }, -"location": { -"description": "Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.", +"normalizedLanguageCode": { +"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", +"readOnly": true, "type": "string" }, -"timeZone": { -"description": "Required. The time zone of the agent from the [time zone database](https://www.iana.org/time-zones), e.g., America/New_York, Europe/Paris.", +"region": { +"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", +"readOnly": true, "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata": { -"description": "Additional information of a Chat Engine. Fields in this message are output only.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata", +"GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { +"description": "Response message for SearchTuningService.ListCustomModels method.", +"id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", "properties": { -"dialogflowAgent": { -"description": "The resource name of a Dialogflow agent, that this Chat Engine refers to. Format: `projects//locations//agents/`.", -"type": "string" +"models": { +"description": "List of custom tuning models.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineCommonConfig", +"GoogleCloudDiscoveryengineV1alphaOutputResult": { +"description": "Output result that stores the information about where the exported data is stored.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", "properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", -"type": "string" +"bigqueryResult": { +"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", +"description": "The BigQuery location where the result is stored." } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig": { -"description": "Additional config specs for a Media Recommendation engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig", +"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { +"description": "A BigQuery output result.", +"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", "properties": { -"optimizationObjective": { -"description": "The optimization objective. e.g., `cvr`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `ctr`, `cvr`. If not specified, we choose default based on engine type. Default depends on type of recommendation: `recommended-for-you` => `ctr` `others-you-may-like` => `ctr`", -"type": "string" -}, -"optimizationObjectiveConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", -"description": "Name and value of the custom threshold for cvr optimization_objective. For target_field `watch-time`, target_field_value must be an integer value indicating the media progress time in seconds between (0, 86400] (excludes 0, includes 86400) (e.g., 90). For target_field `watch-percentage`, the target_field_value must be a valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g., 0.5)." -}, -"trainingState": { -"description": "The training state that the engine is in (e.g. `TRAINING` or `PAUSED`). Since part of the cost of running the service is frequency of training - this can be used to determine when to train engine in order to control cost. If not specified: the default value for `CreateEngine` method is `TRAINING`. The default value for `UpdateEngine` method is to keep the state the same as before.", -"enum": [ -"TRAINING_STATE_UNSPECIFIED", -"PAUSED", -"TRAINING" -], -"enumDescriptions": [ -"Unspecified training state.", -"The engine training is paused.", -"The engine is training." -], +"datasetId": { +"description": "The ID of a BigQuery Dataset.", "type": "string" }, -"type": { -"description": "Required. The type of engine. e.g., `recommended-for-you`. This field together with optimization_objective describe engine metadata to use to control engine training and serving. Currently supported values: `recommended-for-you`, `others-you-may-like`, `more-like-this`, `most-popular-items`.", +"tableId": { +"description": "The ID of a BigQuery Table.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig": { -"description": "Custom threshold for `cvr` optimization_objective.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfigOptimizationObjectiveConfig", +"GoogleCloudDiscoveryengineV1alphaProject": { +"description": "Metadata and configurations for a Google Cloud project in the service.", +"id": "GoogleCloudDiscoveryengineV1alphaProject", "properties": { -"targetField": { -"description": "Required. The name of the field to target. Currently supported values: `watch-percentage`, `watch-time`.", +"createTime": { +"description": "Output only. The timestamp when this project is created.", +"format": "google-datetime", +"readOnly": true, "type": "string" }, -"targetFieldValueFloat": { -"description": "Required. The threshold to be applied to the target (e.g., 0.5).", -"format": "float", -"type": "number" +"name": { +"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", +"readOnly": true, +"type": "string" +}, +"provisionCompletionTime": { +"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"serviceTermsMap": { +"additionalProperties": { +"$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" +}, +"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", +"readOnly": true, +"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata": { -"description": "Additional information of a recommendation engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata", +"GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { +"description": "Metadata about the terms of service.", +"id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", "properties": { -"dataState": { -"description": "Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.", -"enum": [ -"DATA_STATE_UNSPECIFIED", -"DATA_OK", -"DATA_ERROR" -], -"enumDescriptions": [ -"Unspecified default value, should never be explicitly set.", -"The engine has sufficient training data.", -"The engine does not have sufficient training data. Error messages can be queried via Stackdriver." -], -"readOnly": true, +"acceptTime": { +"description": "The last time when the project agreed to the terms of service.", +"format": "google-datetime", "type": "string" }, -"lastTuneTime": { -"description": "Output only. The timestamp when the latest successful tune finished. Only applicable on Media Recommendation engines.", +"declineTime": { +"description": "The last time when the project declined or revoked the agreement to terms of service.", "format": "google-datetime", -"readOnly": true, "type": "string" }, -"servingState": { -"description": "Output only. The serving state of the engine: `ACTIVE`, `NOT_ACTIVE`.", +"id": { +"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", +"type": "string" +}, +"state": { +"description": "Whether the project has accepted/rejected the service terms or it is still pending.", "enum": [ -"SERVING_STATE_UNSPECIFIED", -"INACTIVE", -"ACTIVE", -"TUNED" +"STATE_UNSPECIFIED", +"TERMS_ACCEPTED", +"TERMS_PENDING", +"TERMS_DECLINED" ], "enumDescriptions": [ -"Unspecified serving state.", -"The engine is not serving.", -"The engine is serving and can be queried.", -"The engine is trained on tuned hyperparameters and can be queried." +"The default value of the enum. This value is not actually used.", +"The project has given consent to the terms of service.", +"The project is pending to review and accept the terms of service.", +"The project has declined or revoked the agreement to terms of service." ], -"readOnly": true, "type": "string" }, -"tuningOperation": { -"description": "Output only. The latest tune operation id associated with the engine. Only applicable on Media Recommendation engines. If present, this operation id can be used to determine if there is an ongoing tune for this engine. To check the operation status, send the GetOperation request with this operation id in the engine resource format. If no tuning has happened for this engine, the string is empty.", -"readOnly": true, +"version": { +"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig", +"GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { +"description": "Metadata associated with a project provision operation.", +"id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", +"properties": {}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { +"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", "properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", -"items": { -"enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." -], +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"type": "array" -}, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", -"enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." -], +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig": { -"description": "Additional config specs for a `similar-items` engine.", -"id": "GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig", -"properties": {}, +"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { +"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", +"properties": { +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"purgeSucceeded": { +"description": "Whether the completion suggestions were successfully purged.", +"type": "boolean" +} +}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata": { -"description": "Metadata related to the progress of the EstimateDataSize operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeMetadata", +"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { +"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" +}, +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", +"type": "string" +}, +"ignoredCount": { +"description": "Count of entries that were ignored as entries were not found.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse": { -"description": "Response of the EstimateDataSize request. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1alphaEstimateDataSizeResponse", +"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { +"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", "properties": { -"dataSizeBytes": { -"description": "Data size in terms of bytes.", +"purgeCount": { +"description": "The total count of documents purged as a result of the operation.", "format": "int64", "type": "string" }, -"documentCount": { -"description": "Total number of documents.", -"format": "int64", +"purgeSample": { +"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata": { -"description": "Metadata related to the progress of the Export operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata", +"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { +"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", "properties": { "createTime": { "description": "Operation create time.", @@ -9167,866 +10488,930 @@ }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse": { -"description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse", +"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { +"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", "properties": { -"outputResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResult", -"description": "Output result indicating where the data were exported to." +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" }, -"status": { -"$ref": "GoogleRpcStatus", -"description": "The status of the export operation." +"type": "array" +}, +"purgeCount": { +"description": "Number of suggestion deny list entries purged.", +"format": "int64", +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaFieldConfig": { -"description": "Configurations for fields of a schema. For example, configuring a field is indexable, or searchable.", -"id": "GoogleCloudDiscoveryengineV1alphaFieldConfig", +"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { +"description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", "properties": { -"advancedSiteSearchDataSources": { -"description": "If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``.", -"items": { -"enum": [ -"ADVANCED_SITE_SEARCH_DATA_SOURCE_UNSPECIFIED", -"METATAGS", -"PAGEMAP", -"SCHEMA_ORG" -], -"enumDescriptions": [ -"Value used when unset.", -"Retrieve value from meta tag.", -"Retrieve value from page map.", -"Retrieve value from schema.org data." -], +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", "type": "string" }, -"type": "array" -}, -"completableOption": { -"description": "If completable_option is COMPLETABLE_ENABLED, field values are directly used and returned as suggestions for Autocomplete in CompletionService.CompleteQuery. If completable_option is unset, the server behavior defaults to COMPLETABLE_DISABLED for fields that support setting completable options, which are just `string` fields. For those fields that do not support setting completable options, the server will skip completable option setting, and setting completable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"COMPLETABLE_OPTION_UNSPECIFIED", -"COMPLETABLE_ENABLED", -"COMPLETABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Completable option enabled for a schema field.", -"Completable option disabled for a schema field." -], +"failureCount": { +"description": "Count of entries that encountered errors while processing.", +"format": "int64", "type": "string" }, -"dynamicFacetableOption": { -"description": "If dynamic_facetable_option is DYNAMIC_FACETABLE_ENABLED, field values are available for dynamic facet. Could only be DYNAMIC_FACETABLE_DISABLED if FieldConfig.indexable_option is INDEXABLE_DISABLED. Otherwise, an `INVALID_ARGUMENT` error will be returned. If dynamic_facetable_option is unset, the server behavior defaults to DYNAMIC_FACETABLE_DISABLED for fields that support setting dynamic facetable options. For those fields that do not support setting dynamic facetable options, such as `object` and `boolean`, the server will skip dynamic facetable option setting, and setting dynamic_facetable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"DYNAMIC_FACETABLE_OPTION_UNSPECIFIED", -"DYNAMIC_FACETABLE_ENABLED", -"DYNAMIC_FACETABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Dynamic facetable option enabled for a schema field.", -"Dynamic facetable option disabled for a schema field." -], +"successCount": { +"description": "Count of entries that were deleted successfully.", +"format": "int64", "type": "string" }, -"fieldPath": { -"description": "Required. Field path of the schema field. For example: `title`, `description`, `release_info.release_year`.", +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", "type": "string" +} }, -"fieldType": { -"description": "Output only. Raw type of the field.", -"enum": [ -"FIELD_TYPE_UNSPECIFIED", -"OBJECT", -"STRING", -"NUMBER", -"INTEGER", -"BOOLEAN", -"GEOLOCATION", -"DATETIME" -], -"enumDescriptions": [ -"Field type is unspecified.", -"Field value type is Object.", -"Field value type is String.", -"Field value type is Number.", -"Field value type is Integer.", -"Field value type is Boolean.", -"Field value type is Geolocation. Geolocation is expressed as an object with the following keys: * `id`: a string representing the location id * `longitude`: a number representing the longitude coordinate of the location * `latitude`: a number repesenting the latitude coordinate of the location * `address`: a string representing the full address of the location `latitude` and `longitude` must always be provided together. At least one of a) `address` or b) `latitude`-`longitude` pair must be provided.", -"Field value type is Datetime. Datetime can be expressed as either: * a number representing milliseconds-since-the-epoch * a string representing milliseconds-since-the-epoch. e.g. `\"1420070400001\"` * a string representing the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date or date and time. e.g. `\"2015-01-01\"` or `\"2015-01-01T12:10:30Z\"`" -], -"readOnly": true, -"type": "string" +"type": "object" }, -"indexableOption": { -"description": "If indexable_option is INDEXABLE_ENABLED, field values are indexed so that it can be filtered or faceted in SearchService.Search. If indexable_option is unset, the server behavior defaults to INDEXABLE_DISABLED for fields that support setting indexable options. For those fields that do not support setting indexable options, such as `object` and `boolean` and key properties, the server will skip indexable_option setting, and setting indexable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"INDEXABLE_OPTION_UNSPECIFIED", -"INDEXABLE_ENABLED", -"INDEXABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Indexable option enabled for a schema field.", -"Indexable option disabled for a schema field." -], +"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { +"description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", +"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", +"properties": { +"purgeCount": { +"description": "The total count of events purged as a result of the operation.", +"format": "int64", "type": "string" +} }, -"keyPropertyType": { -"description": "Output only. Type of the key property that this field is mapped to. Empty string if this is not annotated as mapped to a key property. Example types are `title`, `description`. Full list is defined by `keyPropertyMapping` in the schema field annotation. If the schema field has a `KeyPropertyMapping` annotation, `indexable_option` and `searchable_option` of this field cannot be modified.", -"readOnly": true, -"type": "string" +"type": "object" }, -"recsFilterableOption": { -"description": "If recs_filterable_option is FILTERABLE_ENABLED, field values are filterable by filter expression in RecommendationService.Recommend. If FILTERABLE_ENABLED but the field type is numerical, field values are not filterable by text queries in RecommendationService.Recommend. Only textual fields are supported. If recs_filterable_option is unset, the default setting is FILTERABLE_DISABLED for fields that support setting filterable options. When a field set to [FILTERABLE_DISABLED] is filtered, a warning is generated and an empty result is returned.", -"enum": [ -"FILTERABLE_OPTION_UNSPECIFIED", -"FILTERABLE_ENABLED", -"FILTERABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Filterable option enabled for a schema field.", -"Filterable option disabled for a schema field." -], -"type": "string" +"GoogleCloudDiscoveryengineV1alphaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" }, -"retrievableOption": { -"description": "If retrievable_option is RETRIEVABLE_ENABLED, field values are included in the search results. If retrievable_option is unset, the server behavior defaults to RETRIEVABLE_DISABLED for fields that support setting retrievable options. For those fields that do not support setting retrievable options, such as `object` and `boolean`, the server will skip retrievable option setting, and setting retrievable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"RETRIEVABLE_OPTION_UNSPECIFIED", -"RETRIEVABLE_ENABLED", -"RETRIEVABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Retrievable option enabled for a schema field.", -"Retrievable option disabled for a schema field." -], -"type": "string" +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" }, -"schemaOrgPaths": { -"description": "Field paths for indexing custom attribute from schema.org data. More details of schema.org and its defined types can be found at [schema.org](https://schema.org). It is only used on advanced site search schema. Currently only support full path from root. The full path to a field is constructed by concatenating field names, starting from `_root`, with a period `.` as the delimiter. Examples: * Publish date of the root: _root.datePublished * Publish date of the reviews: _root.review.datePublished", -"items": { -"type": "string" +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" }, -"type": "array" +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" }, -"searchableOption": { -"description": "If searchable_option is SEARCHABLE_ENABLED, field values are searchable by text queries in SearchService.Search. If SEARCHABLE_ENABLED but field type is numerical, field values will not be searchable by text queries in SearchService.Search, as there are no text values associated to numerical fields. If searchable_option is unset, the server behavior defaults to SEARCHABLE_DISABLED for fields that support setting searchable options. Only `string` fields that have no key property mapping support setting searchable_option. For those fields that do not support setting searchable options, the server will skip searchable option setting, and setting searchable_option for those fields will throw `INVALID_ARGUMENT` error.", -"enum": [ -"SEARCHABLE_OPTION_UNSPECIFIED", -"SEARCHABLE_ENABLED", -"SEARCHABLE_DISABLED" -], -"enumDescriptions": [ -"Value used when unset.", -"Searchable option enabled for a schema field.", -"Searchable option disabled for a schema field." -], -"type": "string" +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1alphaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" }, -"GoogleCloudDiscoveryengineV1alphaIdpConfig": { -"description": "Identity Provider Config.", -"id": "GoogleCloudDiscoveryengineV1alphaIdpConfig", -"properties": { -"externalIdpConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", -"description": "External Identity provider config." +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" }, -"idpType": { -"description": "Identity provider type configured.", -"enum": [ -"IDP_TYPE_UNSPECIFIED", -"GSUITE", -"THIRD_PARTY" -], -"enumDescriptions": [ -"Default value. ACL search not enabled.", -"Google 1P provider.", -"Third party provider." -], -"type": "string" +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig": { -"description": "Third party IDP Config.", -"id": "GoogleCloudDiscoveryengineV1alphaIdpConfigExternalIdpConfig", +"GoogleCloudDiscoveryengineV1alphaQuery": { +"description": "Defines a user inputed query.", +"id": "GoogleCloudDiscoveryengineV1alphaQuery", "properties": { -"workforcePoolName": { -"description": "Workforce pool name. Example: \"locations/global/workforcePools/pool_id\"", +"queryId": { +"description": "Unique Id for the query.", +"type": "string" +}, +"text": { +"description": "Plain text.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the ImportCompletionSuggestions operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", "properties": { "createTime": { "description": "Operation create time.", "format": "google-datetime", "type": "string" }, -"failureCount": { -"description": "Count of CompletionSuggestions that failed to be imported.", -"format": "int64", +"invalidUris": { +"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", +"items": { "type": "string" }, +"type": "array" +}, +"pendingCount": { +"description": "Total number of URIs that have yet to be crawled.", +"format": "int32", +"type": "integer" +}, +"quotaExceededCount": { +"description": "Total number of URIs that were rejected due to insufficient indexing resources.", +"format": "int32", +"type": "integer" +}, "successCount": { -"description": "Count of CompletionSuggestions successfully imported.", -"format": "int64", -"type": "string" +"description": "Total number of URIs that have been crawled so far.", +"format": "int32", +"type": "integer" }, "updateTime": { "description": "Operation last update time. If the operation is done, this is also the finish time.", "format": "google-datetime", "type": "string" +}, +"validUrisCount": { +"description": "Total number of unique URIs in the request that are not in invalid_uris.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse": { -"description": "Response of the CompletionService.ImportCompletionSuggestions method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", -"id": "GoogleCloudDiscoveryengineV1alphaImportCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { +"description": "Response message for SiteSearchEngineService.RecrawlUris method.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "The desired location of errors incurred during the Import." +"failedUris": { +"description": "URIs that were not crawled before the LRO terminated.", +"items": { +"type": "string" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"type": "array" +}, +"failureSamples": { +"description": "Details for a sample of up to 10 `failed_uris`.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata": { -"description": "Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { +"description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"failureReasons": { +"description": "List of failure reasons by corpus type (e.g. desktop, mobile).", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"type": "array" }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", +"uri": { +"description": "URI that failed to be crawled.", "type": "string" +} }, -"totalCount": { -"description": "Total count of entries that were processed.", -"format": "int64", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { +"description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", +"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", +"properties": { +"corpusType": { +"description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", +"enum": [ +"CORPUS_TYPE_UNSPECIFIED", +"DESKTOP", +"MOBILE" +], +"enumDescriptions": [ +"Default value.", +"Denotes a crawling attempt for the desktop version of a page.", +"Denotes a crawling attempt for the mobile version of a page." +], "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"errorMessage": { +"description": "Reason why the URI was not crawled.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse": { -"description": "Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1alphaImportDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaSchema": { +"description": "Defines the structure and layout of a type of document data.", +"id": "GoogleCloudDiscoveryengineV1alphaSchema", "properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors in the request if set." -}, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"fieldConfigs": { +"description": "Output only. Configurations for fields of the schema.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" }, +"readOnly": true, "type": "array" -} }, -"type": "object" +"jsonSchema": { +"description": "The JSON representation of the schema.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaImportErrorConfig": { -"description": "Configuration of destination for Import related errors.", -"id": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"properties": { -"gcsPrefix": { -"description": "Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message.", +"name": { +"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" +}, +"structSchema": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "The structured representation of the schema.", +"type": "object" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequest": { +"description": "Request message for SearchService.Search method.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequest", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"boostSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", +"description": "Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)" +}, +"branch": { +"description": "The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"canonicalFilter": { +"description": "The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see SearchRequest.filter.", "type": "string" -} }, -"type": "object" +"contentSearchSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", +"description": "A specification for configuring the behavior of content search." }, -"GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.ImportSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaImportSuggestionDenyListEntriesResponse", -"properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"customFineTuningSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec", +"description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." +}, +"dataStoreSpecs": { +"description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, "type": "array" }, -"failedEntriesCount": { -"description": "Count of deny list entries that failed to be imported.", -"format": "int64", +"embeddingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", +"description": "Uses the provided embedding to do additional semantic document retrieval. The retrieval is based on the dot product of SearchRequest.EmbeddingSpec.EmbeddingVector.vector and the document embedding that is provided in SearchRequest.EmbeddingSpec.EmbeddingVector.field_path. If SearchRequest.EmbeddingSpec.EmbeddingVector.field_path is not provided, it will use ServingConfig.EmbeddingConfig.field_path." +}, +"facetSpecs": { +"description": "Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec" +}, +"type": "array" +}, +"filter": { +"description": "The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY(\"king kong\")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)", +"type": "string" +}, +"imageQuery": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", +"description": "Raw image query." +}, +"languageCode": { +"description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). This field helps to better interpret the query. If a value isn't specified, the query language code is automatically detected, which may not be accurate.", +"type": "string" +}, +"naturalLanguageQueryUnderstandingSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", +"description": "If `naturalLanguageQueryUnderstandingSpec` is not specified, no additional natural language query understanding will be done." +}, +"offset": { +"description": "A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"orderBy": { +"description": "The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.", "type": "string" }, -"importedEntriesCount": { -"description": "Count of deny list entries successfully imported.", -"format": "int64", +"pageSize": { +"description": "Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" +}, +"pageToken": { +"description": "A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" -} }, +"params": { +"additionalProperties": { +"type": "any" +}, +"description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: \"au\"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1`", "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata": { -"description": "Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsMetadata", -"properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"query": { +"description": "Raw search query.", "type": "string" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"queryExpansionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", +"description": "The query expansion specification that specifies the conditions under which query expansion occurs." }, -"successCount": { -"description": "Count of entries that were processed successfully.", -"format": "int64", +"rankingExpression": { +"description": "The ranking expression controls the customized ranking on retrieval documents. This overrides ServingConfig.ranking_expression. The ranking expression is a single function or multiple functions that are joined by \"+\". * ranking_expression = function, { \" + \", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"regionCode": { +"description": "The Unicode country/region code (CLDR) of a location, such as \"US\" and \"419\". For more information, see [Standard fields](https://cloud.google.com/apis/design/standard_fields). If set, then results will be boosted based on the region_code provided.", "type": "string" -} -}, -"type": "object" }, -"GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse": { -"description": "Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", -"id": "GoogleCloudDiscoveryengineV1alphaImportUserEventsResponse", -"properties": { -"errorConfig": { -"$ref": "GoogleCloudDiscoveryengineV1alphaImportErrorConfig", -"description": "Echoes the destination for the complete errors if this field was set in the request." +"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" }, -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"safeSearch": { +"description": "Whether to turn on safe search. This is only supported for website search.", +"type": "boolean" }, -"type": "array" +"searchAsYouTypeSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", +"description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, -"joinedEventsCount": { -"description": "Count of user events imported with complete existing Documents.", -"format": "int64", +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", "type": "string" }, -"unjoinedEventsCount": { -"description": "Count of user events imported, but with Document information not found in the existing Branch.", -"format": "int64", +"session": { +"description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" -} }, -"type": "object" +"sessionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", +"description": "Session specification. Can be used only when `session` is set." }, -"GoogleCloudDiscoveryengineV1alphaLanguageInfo": { -"description": "Language info for DataStore.", -"id": "GoogleCloudDiscoveryengineV1alphaLanguageInfo", -"properties": { -"language": { -"description": "Output only. Language part of normalized_language_code. E.g.: `en-US` -> `en`, `zh-Hans-HK` -> `zh`, `en` -> `en`.", -"readOnly": true, -"type": "string" +"spellCorrectionSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", +"description": "The spell correction specification that specifies the mode under which spell correction takes effect." }, -"languageCode": { -"description": "The language code for the DataStore.", -"type": "string" +"userInfo": { +"$ref": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"description": "Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics." }, -"normalizedLanguageCode": { -"description": "Output only. This is the normalized form of language_code. E.g.: language_code of `en-GB`, `en_GB`, `en-UK` or `en-gb` will have normalized_language_code of `en-GB`.", -"readOnly": true, +"userLabels": { +"additionalProperties": { "type": "string" }, -"region": { -"description": "Output only. Region part of normalized_language_code, if present. E.g.: `en-US` -> `US`, `zh-Hans-HK` -> `HK`, `en` -> ``.", -"readOnly": true, +"description": "The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.", +"type": "object" +}, +"userPseudoId": { +"description": "A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and CompleteQueryRequest.user_pseudo_id The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse": { -"description": "Response message for SearchTuningService.ListCustomModels method.", -"id": "GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec": { +"description": "Boost specification to boost certain documents.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpec", "properties": { -"models": { -"description": "List of custom tuning models.", +"conditionBoostSpecs": { +"description": "Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaCustomTuningModel" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaOutputResult": { -"description": "Output result that stores the information about where the exported data is stored.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResult", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec": { +"description": "Boost applies to documents which match a condition.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpec", "properties": { -"bigqueryResult": { -"$ref": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"description": "The BigQuery location where the result is stored." -} -}, -"type": "object" +"boost": { +"description": "Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.", +"format": "float", +"type": "number" }, -"GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult": { -"description": "A BigQuery output result.", -"id": "GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult", -"properties": { -"datasetId": { -"description": "The ID of a BigQuery Dataset.", -"type": "string" +"boostControlSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", +"description": "Complex specification for custom ranking based on customer defined attribute value." }, -"tableId": { -"description": "The ID of a BigQuery Table.", +"condition": { +"description": "An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID \"doc_1\" or \"doc_2\", and color \"Red\" or \"Blue\": `(document_id: ANY(\"doc_1\", \"doc_2\")) AND (color: ANY(\"Red\", \"Blue\"))`", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaProject": { -"description": "Metadata and configurations for a Google Cloud project in the service.", -"id": "GoogleCloudDiscoveryengineV1alphaProject", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec": { +"description": "Specification for custom ranking based on customer specified attribute value. It provides more controls for customized ranking than the simple (condition, boost) combination above.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpec", "properties": { -"createTime": { -"description": "Output only. The timestamp when this project is created.", -"format": "google-datetime", -"readOnly": true, +"attributeType": { +"description": "The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value).", +"enum": [ +"ATTRIBUTE_TYPE_UNSPECIFIED", +"NUMERICAL", +"FRESHNESS" +], +"enumDescriptions": [ +"Unspecified AttributeType.", +"The value of the numerical field will be used to dynamically update the boost amount. In this case, the attribute_value (the x value) of the control point will be the actual value of the numerical field for which the boost_amount is specified.", +"For the freshness use case the attribute value will be the duration between the current time and the date in the datetime field specified. The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. For example, `5D`, `3DT12H30M`, `T24H`." +], "type": "string" }, -"name": { -"description": "Output only. Full resource name of the project, for example `projects/{project_number}`. Note that when making requests, project number and project id are both acceptable, but the server will always respond in project number.", -"readOnly": true, -"type": "string" +"controlPoints": { +"description": "The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint" }, -"provisionCompletionTime": { -"description": "Output only. The timestamp when this project is successfully provisioned. Empty value means this project is still provisioning and is not ready for use.", -"format": "google-datetime", -"readOnly": true, -"type": "string" +"type": "array" }, -"serviceTermsMap": { -"additionalProperties": { -"$ref": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms" +"fieldName": { +"description": "The name of the field whose value will be used to determine the boost amount.", +"type": "string" }, -"description": "Output only. A map of terms of services. The key is the `id` of ServiceTerms.", -"readOnly": true, -"type": "object" +"interpolationType": { +"description": "The interpolation type to be applied to connect the control points listed below.", +"enum": [ +"INTERPOLATION_TYPE_UNSPECIFIED", +"LINEAR" +], +"enumDescriptions": [ +"Interpolation type is unspecified. In this case, it defaults to Linear.", +"Piecewise linear interpolation will be applied." +], +"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaProjectServiceTerms": { -"description": "Metadata about the terms of service.", -"id": "GoogleCloudDiscoveryengineV1alphaProjectServiceTerms", +"GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint": { +"description": "The control points used to define the curve. The curve defined through these control points can only be monotonically increasing or decreasing(constant values are acceptable).", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestBoostSpecConditionBoostSpecBoostControlSpecControlPoint", "properties": { -"acceptTime": { -"description": "The last time when the project agreed to the terms of service.", -"format": "google-datetime", +"attributeValue": { +"description": "Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`.", "type": "string" }, -"declineTime": { -"description": "The last time when the project declined or revoked the agreement to terms of service.", -"format": "google-datetime", -"type": "string" +"boostAmount": { +"description": "The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above.", +"format": "float", +"type": "number" +} }, -"id": { -"description": "The unique identifier of this terms of service. Available terms: * `GA_DATA_USE_TERMS`: [Terms for data use](https://cloud.google.com/retail/data-use-terms). When using this as `id`, the acceptable version to provide is `2022-11-23`.", -"type": "string" +"type": "object" }, -"state": { -"description": "Whether the project has accepted/rejected the service terms or it is still pending.", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec": { +"description": "A specification for configuring the behavior of content search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec", +"properties": { +"chunkSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS" +}, +"extractiveContentSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", +"description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." +}, +"searchResultMode": { +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ -"STATE_UNSPECIFIED", -"TERMS_ACCEPTED", -"TERMS_PENDING", -"TERMS_DECLINED" +"SEARCH_RESULT_MODE_UNSPECIFIED", +"DOCUMENTS", +"CHUNKS" ], "enumDescriptions": [ -"The default value of the enum. This value is not actually used.", -"The project has given consent to the terms of service.", -"The project is pending to review and accept the terms of service.", -"The project has declined or revoked the agreement to terms of service." +"Default value.", +"Returns documents in the search result.", +"Returns chunks in the search result. Only available if the DataStore.DocumentProcessingConfig.chunking_config is specified." ], "type": "string" }, -"version": { -"description": "The version string of the terms of service. For acceptable values, see the comments for id above.", -"type": "string" +"snippetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", +"description": "If `snippetSpec` is not specified, snippets are not included in the search response." +}, +"summarySpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", +"description": "If `summarySpec` is not specified, summaries are not included in the search response." } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec": { +"description": "Specifies the chunk spec to be returned from the search response. Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecChunkSpec", +"properties": { +"numNextChunks": { +"description": "The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.", +"format": "int32", +"type": "integer" +}, +"numPreviousChunks": { +"description": "The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.", +"format": "int32", +"type": "integer" +} }, -"GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata": { -"description": "Metadata associated with a project provision operation.", -"id": "GoogleCloudDiscoveryengineV1alphaProvisionProjectMetadata", -"properties": {}, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata": { -"description": "Metadata related to the progress of the PurgeCompletionSuggestions operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec": { +"description": "A specification for configuring the extractive content in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecExtractiveContentSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"maxExtractiveAnswerCount": { +"description": "The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each SearchResult.", +"format": "int32", +"type": "integer" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"maxExtractiveSegmentCount": { +"description": "The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is SOLUTION_TYPE_CHAT. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.", +"format": "int32", +"type": "integer" +}, +"numNextSegments": { +"description": "Return at most `num_next_segments` segments after each selected segments.", +"format": "int32", +"type": "integer" +}, +"numPreviousSegments": { +"description": "Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.", +"format": "int32", +"type": "integer" +}, +"returnExtractiveSegmentScore": { +"description": "Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse": { -"description": "Response message for CompletionService.PurgeCompletionSuggestions method.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeCompletionSuggestionsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec": { +"description": "A specification for configuring snippets in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSnippetSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", -"items": { -"$ref": "GoogleRpcStatus" +"maxSnippetCount": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated. To control snippet return, use `return_snippet` field. For backwards compatibility, we will return snippet if max_snippet_count > 0.", +"format": "int32", +"type": "integer" }, -"type": "array" +"referenceOnly": { +"deprecated": true, +"description": "[DEPRECATED] This field is deprecated and will have no affect on the snippet.", +"type": "boolean" }, -"purgeSucceeded": { -"description": "Whether the completion suggestions were successfully purged.", +"returnSnippet": { +"description": "If `true`, then return snippet. If no snippet can be generated, we return \"No snippet is available for this page.\" A `snippet_status` with `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned.", "type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata": { -"description": "Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec": { +"description": "A specification for configuring a summary returned in a search response.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"ignoreAdversarialQuery": { +"description": "Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.", +"type": "boolean" }, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", -"type": "string" +"ignoreNonSummarySeekingQuery": { +"description": "Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.", +"type": "boolean" }, -"ignoredCount": { -"description": "Count of entries that were ignored as entries were not found.", -"format": "int64", -"type": "string" +"includeCitations": { +"description": "Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.", +"type": "boolean" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", +"languageCode": { +"description": "Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.", "type": "string" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"modelPromptSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", +"description": "If specified, the spec will be used to modify the prompt provided to the LLM." +}, +"modelSpec": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", +"description": "If specified, the spec will be used to modify the model specification provided to the LLM." +}, +"summaryResultCount": { +"description": "The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.", +"format": "int32", +"type": "integer" +}, +"useSemanticChunks": { +"description": "If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.", +"type": "boolean" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse": { -"description": "Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeDocumentsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec": { +"description": "Specification of the prompt to use with the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelPromptSpec", "properties": { -"purgeCount": { -"description": "The total count of documents purged as a result of the operation.", -"format": "int64", -"type": "string" -}, -"purgeSample": { -"description": "A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random.", -"items": { +"preamble": { +"description": "Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.", "type": "string" -}, -"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata": { -"description": "Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec": { +"description": "Specification of the model.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpecModelSpec", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", +"version": { +"description": "The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). * `preview`: string. (Public preview) Uses a preview model. For more information, see [Answer generation model versions and lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models).", "type": "string" +} }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec": { +"description": "A struct to define data stores to filter on in a search call and configurations for those data stores. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec", +"properties": { +"dataStore": { +"description": "Required. Full resource name of DataStore, such as `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse": { -"description": "Response message for CompletionService.PurgeSuggestionDenyListEntries method.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeSuggestionDenyListEntriesResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec": { +"description": "The specification that uses customized query embedding vector to do semantic document retrieval.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpec", "properties": { -"errorSamples": { -"description": "A sample of errors encountered while processing the request.", +"embeddingVectors": { +"description": "The embedding vector used for retrieval. Limit to 1.", "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector" }, "type": "array" -}, -"purgeCount": { -"description": "Number of suggestion deny list entries purged.", -"format": "int64", -"type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata": { -"description": "Metadata related to the progress of the PurgeUserEvents operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector": { +"description": "Embedding vector.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestEmbeddingSpecEmbeddingVector", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" -}, -"failureCount": { -"description": "Count of entries that encountered errors while processing.", -"format": "int64", +"fieldPath": { +"description": "Embedding field path in schema.", "type": "string" }, -"successCount": { -"description": "Count of entries that were deleted successfully.", -"format": "int64", -"type": "string" +"vector": { +"description": "Query embedding vector.", +"items": { +"format": "float", +"type": "number" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse": { -"description": "Response of the PurgeUserEventsRequest. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.", -"id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsResponse", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec": { +"description": "A facet specification to perform faceted search.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpec", "properties": { -"purgeCount": { -"description": "The total count of events purged as a result of the operation.", -"format": "int64", +"enableDynamicPosition": { +"description": "Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: * \"rating\", enable_dynamic_position = true * \"price\", enable_dynamic_position = false * \"brands\", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be (\"price\", \"brands\", \"rating\", \"gender\") or (\"price\", \"brands\", \"gender\", \"rating\") depends on how API orders \"gender\" and \"rating\" facets. However, notice that \"price\" and \"brands\" are always ranked at first and second position because their enable_dynamic_position is false.", +"type": "boolean" +}, +"excludedFilterKeys": { +"description": "List of keys to exclude when faceting. By default, FacetKey.key is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet \"Red\" and 200 documents with the color facet \"Blue\". A query containing the filter \"color:ANY(\"Red\")\" and having \"color\" as FacetKey.key would by default return only \"Red\" documents in the search results, and also return \"Red\" with count 100 as the only color facet. Although there are also blue documents available, \"Blue\" would not be shown as an available facet value. If \"color\" is listed in \"excludedFilterKeys\", then the query returns the facet values \"Red\" with count 100 and \"Blue\" with count 200, because the \"color\" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only \"Red\" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"items": { "type": "string" -} }, -"type": "object" +"type": "array" }, -"GoogleCloudDiscoveryengineV1alphaQuery": { -"description": "Defines a user inputed query.", -"id": "GoogleCloudDiscoveryengineV1alphaQuery", -"properties": { -"queryId": { -"description": "Unique Id for the query.", -"type": "string" +"facetKey": { +"$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", +"description": "Required. The facet key specification." }, -"text": { -"description": "Plain text.", -"type": "string" +"limit": { +"description": "Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. For aggregation in healthcare search, when the [FacetKey.key] is \"healthcare_aggregation_key\", the limit will be overridden to 10,000 internally, regardless of the value set here. If this field is negative, an `INVALID_ARGUMENT` is returned.", +"format": "int32", +"type": "integer" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { -"description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", +"GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey": { +"description": "Specifies how a facet is computed.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestFacetSpecFacetKey", "properties": { -"createTime": { -"description": "Operation create time.", -"format": "google-datetime", -"type": "string" +"caseInsensitive": { +"description": "True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.", +"type": "boolean" }, -"invalidUris": { -"description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", +"contains": { +"description": "Only get facet values that contain the given strings. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"contains\" to \"2022\", the \"category\" facet only contains \"Action > 2022\" and \"Sci-Fi > 2022\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, -"pendingCount": { -"description": "Total number of URIs that have yet to be crawled.", -"format": "int32", -"type": "integer" -}, -"quotaExceededCount": { -"description": "Total number of URIs that were rejected due to insufficient indexing resources.", -"format": "int32", -"type": "integer" -}, -"successCount": { -"description": "Total number of URIs that have been crawled so far.", -"format": "int32", -"type": "integer" +"intervals": { +"description": "Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1alphaInterval" }, -"updateTime": { -"description": "Operation last update time. If the operation is done, this is also the finish time.", -"format": "google-datetime", -"type": "string" +"type": "array" }, -"validUrisCount": { -"description": "Total number of unique URIs in the request that are not in invalid_uris.", -"format": "int32", -"type": "integer" -} +"key": { +"description": "Required. Supported textual and numerical facet keys in Document object, over which the facet values are computed. Facet key is case-sensitive.", +"type": "string" }, -"type": "object" +"orderBy": { +"description": "The order in which documents are returned. Allowed values are: * \"count desc\", which means order by SearchResponse.Facet.values.count descending. * \"value desc\", which means order by SearchResponse.Facet.values.value descending. Only applies to textual facets. If not set, textual values are sorted in [natural order](https://en.wikipedia.org/wiki/Natural_sort_order); numerical intervals are sorted in the order given by FacetSpec.FacetKey.intervals.", +"type": "string" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { -"description": "Response message for SiteSearchEngineService.RecrawlUris method.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", -"properties": { -"failedUris": { -"description": "URIs that were not crawled before the LRO terminated.", +"prefixes": { +"description": "Only get facet values that start with the given string prefix. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"prefixes\" to \"Action\", the \"category\" facet only contains \"Action > 2022\" and \"Action > 2021\". Only supported on textual fields. Maximum is 10.", "items": { "type": "string" }, "type": "array" }, -"failureSamples": { -"description": "Details for a sample of up to 10 `failed_uris`.", +"restrictedValues": { +"description": "Only get facet for the given restricted values. Only supported on textual fields. For example, suppose \"category\" has three values \"Action > 2022\", \"Action > 2021\" and \"Sci-Fi > 2022\". If set \"restricted_values\" to \"Action > 2022\", the \"category\" facet only contains \"Action > 2022\". Only supported on textual fields. Maximum is 10.", "items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" +"type": "string" }, "type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { -"description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", +"GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery": { +"description": "Specifies the image query input.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery", "properties": { -"failureReasons": { -"description": "List of failure reasons by corpus type (e.g. desktop, mobile).", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" -}, -"type": "array" -}, -"uri": { -"description": "URI that failed to be crawled.", +"imageBytes": { +"description": "Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.", "type": "string" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { -"description": "Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.", -"id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", +"GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec": { +"description": "Specification to enable natural language understanding capabilities for search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec", "properties": { -"corpusType": { -"description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", +"filterExtractionCondition": { +"description": "The condition under which filter extraction should occur. Default to Condition.DISABLED.", "enum": [ -"CORPUS_TYPE_UNSPECIFIED", -"DESKTOP", -"MOBILE" +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" ], "enumDescriptions": [ -"Default value.", -"Denotes a crawling attempt for the desktop version of a page.", -"Denotes a crawling attempt for the mobile version of a page." +"Server behavior defaults to Condition.DISABLED.", +"Disables NL filter extraction.", +"Enables NL filter extraction." ], "type": "string" }, -"errorMessage": { -"description": "Reason why the URI was not crawled.", +"geoSearchQueryDetectionFieldNames": { +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", +"items": { "type": "string" +}, +"type": "array" } }, "type": "object" }, -"GoogleCloudDiscoveryengineV1alphaSchema": { -"description": "Defines the structure and layout of a type of document data.", -"id": "GoogleCloudDiscoveryengineV1alphaSchema", +"GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec": { +"description": "Specification to determine under which conditions query expansion should occur.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestQueryExpansionSpec", "properties": { -"fieldConfigs": { -"description": "Output only. Configurations for fields of the schema.", -"items": { -"$ref": "GoogleCloudDiscoveryengineV1alphaFieldConfig" +"condition": { +"description": "The condition under which query expansion should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"AUTO" +], +"enumDescriptions": [ +"Unspecified query expansion condition. In this case, server behavior defaults to Condition.DISABLED.", +"Disabled query expansion. Only the exact search query is used, even if SearchResponse.total_size is zero.", +"Automatic query expansion built by the Search API." +], +"type": "string" }, -"readOnly": true, -"type": "array" +"pinUnexpandedResults": { +"description": "Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.", +"type": "boolean" +} }, -"jsonSchema": { -"description": "The JSON representation of the schema.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec": { +"description": "Specification for search as you type in search requests.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec", +"properties": { +"condition": { +"description": "The condition under which search as you type should occur. Default to Condition.DISABLED.", +"enum": [ +"CONDITION_UNSPECIFIED", +"DISABLED", +"ENABLED" +], +"enumDescriptions": [ +"Server behavior defaults to Condition.DISABLED.", +"Disables Search As You Type.", +"Enables Search As You Type." +], "type": "string" +} }, -"name": { -"description": "Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec": { +"description": "Session specification. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec", +"properties": { +"queryId": { +"description": "If set, the search result gets stored to the \"turn\" specified by this query ID. Example: Let's say the session looks like this: session { name: \".../sessions/xxx\" turns { query { text: \"What is foo?\" query_id: \".../questions/yyy\" } answer: \"Foo is ...\" } turns { query { text: \"How about bar then?\" query_id: \".../questions/zzz\" } } } The user can call /search API with a request like this: session: \".../sessions/xxx\" session_spec { query_id: \".../questions/zzz\" } Then, the API stores the search result, associated with the last turn. The stored search result can be used by a subsequent /answer API call (with the session ID and the query ID specified). Also, it is possible to call /search and /answer in parallel with the same session ID & query ID.", "type": "string" }, -"structSchema": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" +"searchResultPersistenceCount": { +"description": "The number of top search results to persist. The persisted search results can be used for the subsequent /answer api call. This field is simliar to the `summary_result_count` field in SearchRequest.ContentSearchSpec.SummarySpec.summary_result_count. At most 10 results for documents mode, or 50 for chunks mode.", +"format": "int32", +"type": "integer" +} }, -"description": "The structured representation of the schema.", "type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec": { +"description": "The specification for query spell correction.", +"id": "GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec", +"properties": { +"mode": { +"description": "The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO.", +"enum": [ +"MODE_UNSPECIFIED", +"SUGGESTION_ONLY", +"AUTO" +], +"enumDescriptions": [ +"Unspecified spell correction mode. In this case, server behavior defaults to Mode.AUTO.", +"Search API tries to find a spelling suggestion. If a suggestion is found, it is put in the SearchResponse.corrected_query. The spelling suggestion won't be used as the search query.", +"Automatic spell correction built by the Search API. Search will be based on the corrected query if found." +], +"type": "string" } }, "type": "object" @@ -10092,6 +11477,29 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata": { +"description": "Metadata related to the progress of the SiteSearchEngineService.SetUriPatternDocumentData operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataMetadata", +"properties": { +"createTime": { +"description": "Operation create time.", +"format": "google-datetime", +"type": "string" +}, +"updateTime": { +"description": "Operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse": { +"description": "Response message for SiteSearchEngineService.SetUriPatternDocumentData method.", +"id": "GoogleCloudDiscoveryengineV1alphaSetUriPatternDocumentDataResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo": { "description": "Verification information for target sites in advanced site search.", "id": "GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo", @@ -10324,6 +11732,21 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1alphaUserInfo": { +"description": "Information of an end user.", +"id": "GoogleCloudDiscoveryengineV1alphaUserInfo", +"properties": { +"userAgent": { +"description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if UserEvent.direct_user_request is set.", +"type": "string" +}, +"userId": { +"description": "Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaAlloyDbSource": { "description": "AlloyDB source import data from.", "id": "GoogleCloudDiscoveryengineV1betaAlloyDbSource", @@ -10716,7 +12139,7 @@ "type": "string" }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`. See [parse and chunk documents](https://cloud.google.com/generative-ai-app-builder/docs/parse-chunk-documents)", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -10867,7 +12290,7 @@ "properties": { "answer": { "$ref": "GoogleCloudDiscoveryengineV1betaAnswer", -"description": "Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." +"description": "Answer resource object. If AnswerQueryRequest.QueryUnderstandingSpec.QueryRephraserSpec.max_rephrase_steps is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API." }, "answerQueryToken": { "description": "A global unique ID used for logging.", @@ -11131,7 +12554,7 @@ "description": "Properties of the object.", "type": "any" }, -"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).", +"description": "Data representation. The structured JSON data for the document. It's populated from the struct data from the Document , or the Chunk in search result .", "type": "object" }, "title": { @@ -12142,6 +13565,12 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata": { +"description": "Metadata for EvaluationService.CreateEvaluation method.", +"id": "GoogleCloudDiscoveryengineV1betaCreateEvaluationMetadata", +"properties": {}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata": { "description": "Metadata for Create Schema LRO.", "id": "GoogleCloudDiscoveryengineV1betaCreateSchemaMetadata", @@ -12857,50 +14286,140 @@ "type": "string" } }, -"type": "object" +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { +"description": "Common configurations for an Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", +"properties": { +"companyName": { +"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { +"description": "Configurations for a Search Engine.", +"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", +"properties": { +"searchAddOns": { +"description": "The add-on that this search engine enables.", +"items": { +"enum": [ +"SEARCH_ADD_ON_UNSPECIFIED", +"SEARCH_ADD_ON_LLM" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Large language model add-on." +], +"type": "string" +}, +"type": "array" +}, +"searchTier": { +"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", +"enum": [ +"SEARCH_TIER_UNSPECIFIED", +"SEARCH_TIER_STANDARD", +"SEARCH_TIER_ENTERPRISE" +], +"enumDescriptions": [ +"Default value when the enum is unspecified. This is invalid to use.", +"Standard tier.", +"Enterprise tier." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluation": { +"description": "An evaluation is a single execution (or run) of an evaluation process. It encapsulates the state of the evaluation and the resulting data.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluation", +"properties": { +"createTime": { +"description": "Output only. Timestamp the Evaluation was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. Timestamp the Evaluation was completed at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"error": { +"$ref": "GoogleRpcStatus", +"description": "Output only. The error that occurred during evaluation. Only populated when the evaluation's state is FAILED.", +"readOnly": true +}, +"errorSamples": { +"description": "Output only. A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"readOnly": true, +"type": "array" +}, +"evaluationSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"description": "Required. The specification of the evaluation." }, -"GoogleCloudDiscoveryengineV1betaEngineCommonConfig": { -"description": "Common configurations for an Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineCommonConfig", -"properties": { -"companyName": { -"description": "The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.", +"name": { +"description": "Immutable. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" -} }, -"type": "object" +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED.", +"readOnly": true }, -"GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig": { -"description": "Configurations for a Search Engine.", -"id": "GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig", -"properties": { -"searchAddOns": { -"description": "The add-on that this search engine enables.", -"items": { +"state": { +"description": "Output only. The state of the evaluation.", "enum": [ -"SEARCH_ADD_ON_UNSPECIFIED", -"SEARCH_ADD_ON_LLM" +"STATE_UNSPECIFIED", +"PENDING", +"RUNNING", +"SUCCEEDED", +"FAILED" ], "enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Large language model add-on." +"The evaluation is unspecified.", +"The service is preparing to run the evaluation.", +"The evaluation is in progress.", +"The evaluation completed successfully.", +"The evaluation failed." ], +"readOnly": true, "type": "string" +} }, -"type": "array" +"type": "object" }, -"searchTier": { -"description": "The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.", -"enum": [ -"SEARCH_TIER_UNSPECIFIED", -"SEARCH_TIER_STANDARD", -"SEARCH_TIER_ENTERPRISE" -], -"enumDescriptions": [ -"Default value when the enum is unspecified. This is invalid to use.", -"Standard tier.", -"Enterprise tier." -], +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec": { +"description": "Describes the specification of the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec", +"properties": { +"querySetSpec": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"description": "Required. The specification of the query set." +}, +"searchRequest": { +"$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest", +"description": "Required. The search request that is used to perform the evaluation. Only the following fields within SearchRequest are supported; if any other fields are provided, an UNSUPPORTED error will be returned: * SearchRequest.serving_config * SearchRequest.branch * SearchRequest.canonical_filter * SearchRequest.query_expansion_spec * SearchRequest.spell_correction_spec * SearchRequest.content_search_spec * SearchRequest.user_pseudo_id" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec": { +"description": "Describes the specification of the query set.", +"id": "GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpecQuerySetSpec", +"properties": { +"sampleQuerySet": { +"description": "Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.", "type": "string" } }, @@ -13261,6 +14780,93 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata": { +"description": "Metadata related to the progress of the ImportSampleQueries operation. This will be returned by the google.longrunning.Operation.metadata field.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesMetadata", +"properties": { +"createTime": { +"description": "ImportSampleQueries operation create time.", +"format": "google-datetime", +"type": "string" +}, +"failureCount": { +"description": "Count of SampleQuerys that failed to be imported.", +"format": "int64", +"type": "string" +}, +"successCount": { +"description": "Count of SampleQuerys successfully imported.", +"format": "int64", +"type": "string" +}, +"totalCount": { +"description": "Total count of SampleQuerys that were processed.", +"format": "int64", +"type": "string" +}, +"updateTime": { +"description": "ImportSampleQueries operation last update time. If the operation is done, this is also the finish time.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest": { +"description": "Request message for SampleQueryService.ImportSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequest", +"properties": { +"bigquerySource": { +"$ref": "GoogleCloudDiscoveryengineV1betaBigQuerySource", +"description": "BigQuery input source." +}, +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"gcsSource": { +"$ref": "GoogleCloudDiscoveryengineV1betaGcsSource", +"description": "Cloud Storage location for the input content." +}, +"inlineSource": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", +"description": "The Inline source for sample query entries." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource": { +"description": "The inline source for SampleQuerys.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesRequestInlineSource", +"properties": { +"sampleQueries": { +"description": "Required. A list of SampleQuerys to import. Max of 1000 items.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse": { +"description": "Response of the SampleQueryService.ImportSampleQueries method. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.", +"id": "GoogleCloudDiscoveryengineV1betaImportSampleQueriesResponse", +"properties": { +"errorConfig": { +"$ref": "GoogleCloudDiscoveryengineV1betaImportErrorConfig", +"description": "The desired location of errors incurred during the Import." +}, +"errorSamples": { +"description": "A sample of errors encountered while processing the request.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata": { "description": "Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.", "id": "GoogleCloudDiscoveryengineV1betaImportSuggestionDenyListEntriesMetadata", @@ -13580,6 +15186,95 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse": { +"description": "Response message for EvaluationService.ListEvaluationResults method.", +"id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponse", +"properties": { +"evaluationResults": { +"description": "The EvaluationResults.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationResultsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult": { +"description": "Represents the results of an evaluation for a single SampleQuery.", +"id": "GoogleCloudDiscoveryengineV1betaListEvaluationResultsResponseEvaluationResult", +"properties": { +"qualityMetrics": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"description": "Output only. The metrics produced by the evaluation, for a given SampleQuery.", +"readOnly": true +}, +"sampleQuery": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery", +"description": "Output only. The SampleQuery that was evaluated.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListEvaluationsResponse": { +"description": "Response message for EvaluationService.ListEvaluations method.", +"id": "GoogleCloudDiscoveryengineV1betaListEvaluationsResponse", +"properties": { +"evaluations": { +"description": "The Evaluations.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaEvaluation" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token that can be sent as ListEvaluationsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse": { +"description": "Response message for SampleQueryService.ListSampleQueries method.", +"id": "GoogleCloudDiscoveryengineV1betaListSampleQueriesResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQueriesRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQueries": { +"description": "The SampleQuerys.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuery" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse": { +"description": "Response message for SampleQuerySetService.ListSampleQuerySets method.", +"id": "GoogleCloudDiscoveryengineV1betaListSampleQuerySetsResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as ListSampleQuerySetsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, +"sampleQuerySets": { +"description": "The SampleQuerySets.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQuerySet" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaListSchemasResponse": { "description": "Response message for SchemaService.ListSchemas method.", "id": "GoogleCloudDiscoveryengineV1betaListSchemasResponse", @@ -13936,6 +15631,60 @@ }, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaQualityMetrics": { +"description": "Describes the metrics produced by the evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetrics", +"properties": { +"docNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per document, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved documents (D1, D2, D3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [D3 (0), D1 (1), D2 (1)] Ideal: [D1 (1), D2 (1), D3 (0)] Calculate NDCG@3 for each SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"docPrecision": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Precision per document, at various top-k cutoff levels. Precision is the fraction of retrieved documents that are relevant. Example (top-5): * For a single SampleQuery, If 4 out of 5 retrieved documents in the top-5 are relevant, precision@5 = 4/5 = 0.8" +}, +"docRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per document, at various top-k cutoff levels. Recall is the fraction of relevant documents retrieved out of all relevant documents. Example (top-5): * For a single SampleQuery, If 3 out of 5 relevant documents are retrieved in the top-5, recall@5 = 3/5 = 0.6" +}, +"pageNdcg": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Normalized discounted cumulative gain (NDCG) per page, at various top-k cutoff levels. NDCG measures the ranking quality, giving higher relevance to top results. Example (top-3): Suppose SampleQuery with three retrieved pages (P1, P2, P3) and binary relevance judgements (1 for relevant, 0 for not relevant): Retrieved: [P3 (0), P1 (1), P2 (1)] Ideal: [P1 (1), P2 (1), P3 (0)] Calculate NDCG@3 for SampleQuery: * DCG@3: 0/log2(1+1) + 1/log2(2+1) + 1/log2(3+1) = 1.13 * Ideal DCG@3: 1/log2(1+1) + 1/log2(2+1) + 0/log2(3+1) = 1.63 * NDCG@3: 1.13/1.63 = 0.693" +}, +"pageRecall": { +"$ref": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"description": "Recall per page, at various top-k cutoff levels. Recall is the fraction of relevant pages retrieved out of all relevant pages. Example (top-5): * For a single SampleQuery, if 3 out of 5 relevant pages are retrieved in the top-5, recall@5 = 3/5 = 0.6" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics": { +"description": "Stores the metric values at specific top-k levels.", +"id": "GoogleCloudDiscoveryengineV1betaQualityMetricsTopkMetrics", +"properties": { +"top1": { +"description": "The top-1 value.", +"format": "double", +"type": "number" +}, +"top10": { +"description": "The top-10 value.", +"format": "double", +"type": "number" +}, +"top3": { +"description": "The top-3 value.", +"format": "double", +"type": "number" +}, +"top5": { +"description": "The top-5 value.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaQuery": { "description": "Defines a user inputed query.", "id": "GoogleCloudDiscoveryengineV1betaQuery", @@ -14186,6 +15935,94 @@ "properties": {}, "type": "object" }, +"GoogleCloudDiscoveryengineV1betaSampleQuery": { +"description": "Sample Query captures metadata to be used for evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQuery", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuery was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the sample query, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}/sampleQueries/{sampleQuery}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +}, +"queryEntry": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", +"description": "The query entry." +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry": { +"description": "Query Entry captures metadata to be used for search evaluation.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntry", +"properties": { +"query": { +"description": "Required. The query.", +"type": "string" +}, +"targets": { +"description": "List of targets for the query.", +"items": { +"$ref": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget": { +"description": "Defines the parameters of the query's expected outcome.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQueryQueryEntryTarget", +"properties": { +"pageNumbers": { +"description": "Expected page numbers of the target. Each page number must be non negative.", +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"score": { +"description": "Relevance score of the target.", +"format": "double", +"type": "number" +}, +"uri": { +"description": "Expected uri of the target. This field must be a UTF-8 encoded string with a length limit of 2048 characters. Example of valid uris: `https://example.com/abc`, `gcs://example/example.pdf`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDiscoveryengineV1betaSampleQuerySet": { +"description": "A SampleQuerySet is the parent resource of SampleQuery, and contains the configurations shared by all SampleQuery under it.", +"id": "GoogleCloudDiscoveryengineV1betaSampleQuerySet", +"properties": { +"createTime": { +"description": "Output only. Timestamp the SampleQuerySet was created at.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "The description of the SampleQuerySet.", +"type": "string" +}, +"displayName": { +"description": "Required. The sample query set display name. This field must be a UTF-8 encoded string with a length limit of 128 characters.", +"type": "string" +}, +"name": { +"description": "Immutable. The full resource name of the SampleQuerySet, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDiscoveryengineV1betaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1betaSchema", @@ -14332,6 +16169,10 @@ "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec", "description": "Search as you type configuration. Only supported for the IndustryVertical.MEDIA vertical." }, +"servingConfig": { +"description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", +"type": "string" +}, "session": { "description": "The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is \"How did Alphabet do in 2022?\" and the current query is \"How about 2023?\", the current query will be interpreted as \"How did Alphabet do in 2023?\". Example #2 (coordination between /search API calls and /answer API calls): 1. Call /search API with the auto-session mode (see below). 2. Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Auto-session mode: when `projects/.../sessions/-` is used, a new session gets automatically created. Otherwise, users can use the create-session API to create a session manually. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team.", "type": "string" @@ -14469,7 +16310,7 @@ "description": "If there is no extractive_content_spec provided, there will be no extractive answer in the search response." }, "searchResultMode": { -"description": "Specifies the search result mode. If unspecified, the search result mode is based on DataStore.DocumentProcessingConfig.chunking_config: * If DataStore.DocumentProcessingConfig.chunking_config is specified, it defaults to `CHUNKS`. * Otherwise, it defaults to `DOCUMENTS`.", +"description": "Specifies the search result mode. If unspecified, the search result mode defaults to `DOCUMENTS`.", "enum": [ "SEARCH_RESULT_MODE_UNSPECIFIED", "DOCUMENTS", @@ -14773,7 +16614,7 @@ "type": "string" }, "geoSearchQueryDetectionFieldNames": { -"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in Servingconfig.geo_search_query_detection_field_names.", +"description": "Field names used for location-based filtering, where geolocation filters are detected in natural language search queries. Only valid when the FilterExtractionCondition is set to `ENABLED`. If this field is set, it overrides the field names set in ServingConfig.geo_search_query_detection_field_names.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/displayvideo.v3.json b/googleapiclient/discovery_cache/documents/displayvideo.v3.json index d549a6a0d83..2b1d5b15a31 100644 --- a/googleapiclient/discovery_cache/documents/displayvideo.v3.json +++ b/googleapiclient/discovery_cache/documents/displayvideo.v3.json @@ -9222,7 +9222,7 @@ } } }, -"revision": "20240701", +"revision": "20240717", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -16719,7 +16719,7 @@ false "type": "array" }, "adGroupQaIds": { -"description": "Optional. YouTube Ad Groups QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"description": "Optional. YouTube Ad Groups, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", "items": { "format": "int64", "type": "string" @@ -16751,7 +16751,7 @@ false "type": "array" }, "lineItemQaIds": { -"description": "Optional. Line Items QA to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", +"description": "Optional. Line Items, by ID, to download in QA format. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", "items": { "format": "int64", "type": "string" @@ -19624,8 +19624,8 @@ false "Line Item.", "YouTube Ad Group.", "YouTube Ad.", -"Line Item QA.", -"YouTube Ad Group QA." +"Line Item - QA format.", +"YouTube Ad Group - QA format." ], "type": "string" }, @@ -19656,8 +19656,8 @@ false "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" } @@ -20529,7 +20529,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/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index a39d7a4abbd..54ee4b5dc4b 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -183,6 +183,11 @@ "required": true, "type": "string" }, +"includeTabsContent": { +"description": "Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document. - When `True`: Document content populates in the Document.tabs field instead of the text content fields in Document. - When `False`: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty.", +"location": "query", +"type": "boolean" +}, "suggestionsViewMode": { "description": "The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.", "enum": [ @@ -216,7 +221,7 @@ } } }, -"revision": "20240626", +"revision": "20240722", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -341,6 +346,21 @@ }, "type": "object" }, +"BookmarkLink": { +"description": "A reference to a bookmark in this document.", +"id": "BookmarkLink", +"properties": { +"id": { +"description": "The ID of a bookmark in this document.", +"type": "string" +}, +"tabId": { +"description": "The ID of the tab containing this bookmark.", +"type": "string" +} +}, +"type": "object" +}, "Bullet": { "description": "Describes the bullet of a paragraph.", "id": "Bullet", @@ -671,6 +691,10 @@ "footerId": { "description": "The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section.", "type": "string" +}, +"tabId": { +"description": "The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -682,6 +706,10 @@ "headerId": { "description": "The id of the header to delete. If this header is defined on DocumentStyle, the reference to this header is removed, resulting in no header of that type for the first section of the document. If this header is defined on a SectionStyle, the reference to this header is removed and the header of that type is now continued from the previous section.", "type": "string" +}, +"tabId": { +"description": "The tab containing the header to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -697,6 +725,10 @@ "namedRangeId": { "description": "The ID of the named range to delete.", "type": "string" +}, +"tabsCriteria": { +"$ref": "TabsCriteria", +"description": "Optional. The criteria used to specify which tab(s) the range deletion should occur in. When omitted, the range deletion is applied to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the range deletion applies to the singular tab. In a document containing multiple tabs: - If provided, the range deletion applies to the specified tabs. - If not provided, the range deletion applies to all tabs." } }, "type": "object" @@ -719,6 +751,10 @@ "objectId": { "description": "The ID of the positioned object to delete.", "type": "string" +}, +"tabId": { +"description": "The tab that the positioned object to delete is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -872,6 +908,13 @@ ], "type": "string" }, +"tabs": { +"description": "Tabs that are part of a document. Tabs can contain child tabs, a tab nested within another tab. Child tabs are represented by the Tab.child_tabs field.", +"items": { +"$ref": "Tab" +}, +"type": "array" +}, "title": { "description": "The title of the document.", "type": "string" @@ -1046,6 +1089,88 @@ }, "type": "object" }, +"DocumentTab": { +"description": "A tab with document contents.", +"id": "DocumentTab", +"properties": { +"body": { +"$ref": "Body", +"description": "The main body of the document tab." +}, +"documentStyle": { +"$ref": "DocumentStyle", +"description": "The style of the document tab." +}, +"footers": { +"additionalProperties": { +"$ref": "Footer" +}, +"description": "The footers in the document tab, keyed by footer ID.", +"type": "object" +}, +"footnotes": { +"additionalProperties": { +"$ref": "Footnote" +}, +"description": "The footnotes in the document tab, keyed by footnote ID.", +"type": "object" +}, +"headers": { +"additionalProperties": { +"$ref": "Header" +}, +"description": "The headers in the document tab, keyed by header ID.", +"type": "object" +}, +"inlineObjects": { +"additionalProperties": { +"$ref": "InlineObject" +}, +"description": "The inline objects in the document tab, keyed by object ID.", +"type": "object" +}, +"lists": { +"additionalProperties": { +"$ref": "List" +}, +"description": "The lists in the document tab, keyed by list ID.", +"type": "object" +}, +"namedRanges": { +"additionalProperties": { +"$ref": "NamedRanges" +}, +"description": "The named ranges in the document tab, keyed by name.", +"type": "object" +}, +"namedStyles": { +"$ref": "NamedStyles", +"description": "The named styles of the document tab." +}, +"positionedObjects": { +"additionalProperties": { +"$ref": "PositionedObject" +}, +"description": "The positioned objects in the document tab, keyed by object ID.", +"type": "object" +}, +"suggestedDocumentStyleChanges": { +"additionalProperties": { +"$ref": "SuggestedDocumentStyle" +}, +"description": "The suggested changes to the style of the document tab, keyed by suggestion ID.", +"type": "object" +}, +"suggestedNamedStylesChanges": { +"additionalProperties": { +"$ref": "SuggestedNamedStyles" +}, +"description": "The suggested changes to the named styles of the document tab, keyed by suggestion ID.", +"type": "object" +} +}, +"type": "object" +}, "EmbeddedDrawingProperties": { "description": "The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.", "id": "EmbeddedDrawingProperties", @@ -1233,6 +1358,10 @@ "segmentId": { "description": "The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.", "type": "string" +}, +"tabId": { +"description": "The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -1352,6 +1481,21 @@ }, "type": "object" }, +"HeadingLink": { +"description": "A reference to a heading in this document.", +"id": "HeadingLink", +"properties": { +"id": { +"description": "The ID of a heading in this document.", +"type": "string" +}, +"tabId": { +"description": "The ID of the tab containing this heading.", +"type": "string" +} +}, +"type": "object" +}, "HorizontalRule": { "description": "A ParagraphElement representing a horizontal line.", "id": "HorizontalRule", @@ -1716,14 +1860,26 @@ "description": "A reference to another portion of a document or an external URL resource.", "id": "Link", "properties": { +"bookmark": { +"$ref": "BookmarkLink", +"description": "A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmark_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned." +}, "bookmarkId": { "description": "The ID of a bookmark in this document.", "type": "string" }, +"heading": { +"$ref": "HeadingLink", +"description": "A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.heading_id when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned." +}, "headingId": { "description": "The ID of a heading in this document.", "type": "string" }, +"tabId": { +"description": "The ID of a tab in this document.", +"type": "string" +}, "url": { "description": "An external URL.", "type": "string" @@ -1822,6 +1978,10 @@ "segmentId": { "description": "The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body.", "type": "string" +}, +"tabId": { +"description": "The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -2760,6 +2920,10 @@ "description": "The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges.", "format": "int32", "type": "integer" +}, +"tabId": { +"description": "The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" @@ -2775,6 +2939,10 @@ "replaceText": { "description": "The text that will replace the matched text.", "type": "string" +}, +"tabsCriteria": { +"$ref": "TabsCriteria", +"description": "Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs." } }, "type": "object" @@ -2811,6 +2979,10 @@ ], "type": "string" }, +"tabId": { +"description": "The tab that the image to be replaced is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" +}, "uri": { "description": "The URI of the new image. The image is fetched once at insertion time and a copy is stored for display inside the document. Images must be less than 50MB, cannot exceed 25 megapixels, and must be in PNG, JPEG, or GIF format. The provided URI can't surpass 2 KB in length. The URI is saved with the image, and exposed through the ImageProperties.source_uri field.", "type": "string" @@ -2830,6 +3002,10 @@ "description": "The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op.", "type": "string" }, +"tabsCriteria": { +"$ref": "TabsCriteria", +"description": "Optional. The criteria used to specify in which tabs the replacement occurs. When omitted, the replacement applies to all tabs. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the replacement applies to the singular tab. In a document containing multiple tabs: - If provided, the replacement applies to the specified tabs. - If omitted, the replacement applies to all tabs." +}, "text": { "description": "Replaces the content of the specified named range(s) with the given text.", "type": "string" @@ -3535,6 +3711,57 @@ }, "type": "object" }, +"Tab": { +"description": "A tab in a document.", +"id": "Tab", +"properties": { +"childTabs": { +"description": "The child tabs nested within this tab.", +"items": { +"$ref": "Tab" +}, +"type": "array" +}, +"documentTab": { +"$ref": "DocumentTab", +"description": "A tab with document contents, like text and images." +}, +"tabProperties": { +"$ref": "TabProperties", +"description": "The properties of the tab, like ID and title." +} +}, +"type": "object" +}, +"TabProperties": { +"description": "Properties of a tab.", +"id": "TabProperties", +"properties": { +"index": { +"description": "The index of the tab within the parent.", +"format": "int32", +"type": "integer" +}, +"nestingLevel": { +"description": "Output only. The depth of the tab within the document. Root-level tabs start at 0.", +"format": "int32", +"type": "integer" +}, +"parentTabId": { +"description": "Optional. The ID of the parent tab. Empty when the current tab is a root-level tab, which means it doesn't have any parents.", +"type": "string" +}, +"tabId": { +"description": "Output only. The ID of the tab. This field can't be changed.", +"type": "string" +}, +"title": { +"description": "The user-visible name of the tab.", +"type": "string" +} +}, +"type": "object" +}, "TabStop": { "description": "A tab stop within a paragraph.", "id": "TabStop", @@ -3998,6 +4225,20 @@ }, "type": "object" }, +"TabsCriteria": { +"description": "A criteria that specifies in which tabs a request executes.", +"id": "TabsCriteria", +"properties": { +"tabIds": { +"description": "The list of tab IDs in which the request executes.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "TextRun": { "description": "A ParagraphElement that represents a run of text that all has the same styling.", "id": "TextRun", @@ -4171,6 +4412,10 @@ "description": "The fields that should be updated. At least one field must be specified. The root `document_style` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. For example to update the background, set `fields` to `\"background\"`.", "format": "google-fieldmask", "type": "string" +}, +"tabId": { +"description": "The tab that contains the style to update. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If not provided, the request applies to the first tab in the document.", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/documentai.v1.json b/googleapiclient/discovery_cache/documents/documentai.v1.json index d5db73c2377..7707a17ba6d 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1.json @@ -1042,7 +1042,7 @@ } } }, -"revision": "20240703", +"revision": "20240716", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4686,6 +4686,11 @@ true "$ref": "GoogleCloudDocumentaiV1DocumentSchema", "description": "The schema of the processor version. Describes the output." }, +"genAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", +"description": "Output only. Information about Generative AI model-based processor versions.", +"readOnly": true +}, "googleManaged": { "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", "readOnly": true, @@ -4793,6 +4798,62 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo": { +"description": "Information about Generative AI model-based processor versions.", +"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfo", +"properties": { +"customGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"description": "Information for a custom Generative AI model created by the user." +}, +"foundationGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"description": "Information for a pretrained Google-managed foundation model." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { +"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", +"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"properties": { +"baseProcessorVersionId": { +"description": "The base processor version ID for the custom model.", +"type": "string" +}, +"customModelType": { +"description": "The type of custom model created by the user.", +"enum": [ +"CUSTOM_MODEL_TYPE_UNSPECIFIED", +"VERSIONED_FOUNDATION", +"FINE_TUNED" +], +"enumDescriptions": [ +"The model type is unspecified.", +"The model is a versioned foundation model.", +"The model is a finetuned foundation model." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { +"description": "Information for a pretrained Google-managed foundation model.", +"id": "GoogleCloudDocumentaiV1ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"properties": { +"finetuningAllowed": { +"description": "Whether finetuning is allowed for this base processor version.", +"type": "boolean" +}, +"minTrainLabeledDocuments": { +"description": "The minimum number of labeled documents in the training dataset required for finetuning.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1RawDocument": { "description": "Payload message of raw document content (bytes).", "id": "GoogleCloudDocumentaiV1RawDocument", diff --git a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json index 9a61f6c8847..ea38690adb3 100644 --- a/googleapiclient/discovery_cache/documents/documentai.v1beta3.json +++ b/googleapiclient/discovery_cache/documents/documentai.v1beta3.json @@ -1284,7 +1284,7 @@ } } }, -"revision": "20240703", +"revision": "20240716", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -9293,6 +9293,11 @@ true "$ref": "GoogleCloudDocumentaiV1beta3DocumentSchema", "description": "The schema of the processor version. Describes the output." }, +"genAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", +"description": "Output only. Information about Generative AI model-based processor versions.", +"readOnly": true +}, "googleManaged": { "description": "Output only. Denotes that this `ProcessorVersion` is managed by Google.", "readOnly": true, @@ -9400,6 +9405,62 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo": { +"description": "Information about Generative AI model-based processor versions.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfo", +"properties": { +"customGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"description": "Information for a custom Generative AI model created by the user." +}, +"foundationGenAiModelInfo": { +"$ref": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"description": "Information for a pretrained Google-managed foundation model." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo": { +"description": "Information for a custom Generative AI model created by the user. These are created with `Create New Version` in either the `Call foundation model` or `Fine tuning` tabs.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoCustomGenAiModelInfo", +"properties": { +"baseProcessorVersionId": { +"description": "The base processor version ID for the custom model.", +"type": "string" +}, +"customModelType": { +"description": "The type of custom model created by the user.", +"enum": [ +"CUSTOM_MODEL_TYPE_UNSPECIFIED", +"VERSIONED_FOUNDATION", +"FINE_TUNED" +], +"enumDescriptions": [ +"The model type is unspecified.", +"The model is a versioned foundation model.", +"The model is a finetuned foundation model." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo": { +"description": "Information for a pretrained Google-managed foundation model.", +"id": "GoogleCloudDocumentaiV1beta3ProcessorVersionGenAiModelInfoFoundationGenAiModelInfo", +"properties": { +"finetuningAllowed": { +"description": "Whether finetuning is allowed for this base processor version.", +"type": "boolean" +}, +"minTrainLabeledDocuments": { +"description": "The minimum number of labeled documents in the training dataset required for finetuning.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1beta3PropertyMetadata": { "description": "Metadata about a property.", "id": "GoogleCloudDocumentaiV1beta3PropertyMetadata", diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 8d5a96ad9c0..66106394321 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -585,7 +585,7 @@ } } }, -"revision": "20240710", +"revision": "20240717", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { "GoogleFirebaseAppdistroV1Release": { @@ -875,14 +875,16 @@ "CRASHED", "NOT_INSTALLED", "UNABLE_TO_CRAWL", -"DEVICE_OUT_OF_MEMORY" +"DEVICE_OUT_OF_MEMORY", +"FAILED_AI_STEP" ], "enumDescriptions": [ "Reason unspecified.", "The app crashed during the test.", "If an app is not installed and thus no test can be run with the app. This might be caused by trying to run a test on an unsupported platform.", "If the app could not be crawled (possibly because the app did not start).", -"If the device ran out of memory during the test." +"If the device ran out of memory during the test.", +"At least one AI step failed." ], "readOnly": true, "type": "string" diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index ac3e4905bd6..d5ed50c9f1d 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20240705", +"revision": "20240722", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -282,14 +282,14 @@ ], "enumDescriptions": [ "The finish reason is unspecified.", -"Natural stop point of the model or provided stop sequence.", -"The maximum number of tokens as specified in the request was reached.", -"The token generation was stopped as the response was flagged for safety reasons. NOTE: When streaming the Candidate.content will be empty if content filters blocked the output.", -"The token generation was stopped as the response was flagged for unauthorized citations.", -"All other reasons that stopped the token generation", -"The token generation was stopped as the response was flagged for the terms which are included from the terminology blocklist.", -"The token generation was stopped as the response was flagged for the prohibited contents.", -"The token generation was stopped as the response was flagged for Sensitive Personally Identifiable Information (SPII) contents.", +"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 copyright violations.", +"All other reasons that stopped the token generation.", +"Token generation stopped because the content contains forbidden terms.", +"Token generation stopped for potentially containing prohibited content.", +"Token generation stopped because the content potentially contains Sensitive Personally Identifiable Information (SPII).", "The function call generated by the model is invalid." ], "readOnly": true, @@ -313,12 +313,6 @@ }, "readOnly": true, "type": "array" -}, -"score": { -"description": "Output only. Confidence score of the candidate.", -"format": "double", -"readOnly": true, -"type": "number" } }, "type": "object" @@ -892,7 +886,8 @@ "id": "GoogleCloudAiplatformV1beta1Retrieval", "properties": { "disableAttribution": { -"description": "Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.", +"deprecated": true, +"description": "Optional. Deprecated. This option is no longer supported.", "type": "boolean" }, "vertexAiSearch": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 26f47eed32b..5c309e82d56 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -1706,7 +1706,7 @@ } } }, -"revision": "20240630", +"revision": "20240713", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2388,7 +2388,7 @@ "type": "object" }, "FindNearest": { -"description": "Nearest Neighbors search config.", +"description": "Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.", "id": "FindNearest", "properties": { "distanceMeasure": { @@ -2499,7 +2499,7 @@ "type": "string" }, "retention": { -"description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention is 14 weeks.", +"description": "At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.", "format": "google-duration", "type": "string" }, @@ -2633,12 +2633,7 @@ "GoogleFirestoreAdminV1DailyRecurrence": { "description": "Represents a recurring schedule that runs every day. The time zone is UTC.", "id": "GoogleFirestoreAdminV1DailyRecurrence", -"properties": { -"time": { -"$ref": "TimeOfDay", -"description": "Time of the day. The first run scheduled will be either on the same day if schedule creation time precedes time_of_day or the next day otherwise." -} -}, +"properties": {}, "type": "object" }, "GoogleFirestoreAdminV1Database": { @@ -3602,10 +3597,6 @@ "Sunday" ], "type": "string" -}, -"time": { -"$ref": "TimeOfDay", -"description": "Time of the day. If day is today, the first run will happen today if schedule creation time precedes time_of_day, and the next week otherwise." } }, "type": "object" @@ -4341,33 +4332,6 @@ }, "type": "object" }, -"TimeOfDay": { -"description": "Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`.", -"id": "TimeOfDay", -"properties": { -"hours": { -"description": "Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", -"format": "int32", -"type": "integer" -}, -"minutes": { -"description": "Minutes of hour of day. Must be from 0 to 59.", -"format": "int32", -"type": "integer" -}, -"nanos": { -"description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", -"format": "int32", -"type": "integer" -}, -"seconds": { -"description": "Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.", -"format": "int32", -"type": "integer" -} -}, -"type": "object" -}, "TransactionOptions": { "description": "Options for creating a new transaction.", "id": "TransactionOptions", diff --git a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json index 2d521e4c573..9f90e1198eb 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1beta1.json @@ -950,7 +950,7 @@ } } }, -"revision": "20240626", +"revision": "20240713", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -1632,7 +1632,7 @@ "type": "object" }, "FindNearest": { -"description": "Nearest Neighbors search config.", +"description": "Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.", "id": "FindNearest", "properties": { "distanceMeasure": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json index a1c5ff380b8..0053a520c56 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json @@ -4554,7 +4554,7 @@ } } }, -"revision": "20240619", +"revision": "20240718", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -5151,7 +5151,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { -"description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", +"description": "Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", "type": "boolean" } }, @@ -5678,11 +5678,11 @@ "type": "string" }, "sendFullResource": { -"description": "Whether to send full FHIR resource to this Pub/Sub topic.", +"description": "Whether to send full FHIR resource to this Pub/Sub topic. The default value is false.", "type": "boolean" }, "sendPreviousResourceOnDelete": { -"description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", +"description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", "type": "boolean" } }, @@ -5707,7 +5707,7 @@ "type": "string" }, "defaultSearchHandlingStrict": { -"description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.", +"description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", "type": "boolean" }, "disableReferentialIntegrity": { @@ -5715,11 +5715,11 @@ "type": "boolean" }, "disableResourceVersioning": { -"description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", +"description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.", "type": "boolean" }, "enableUpdateCreate": { -"description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.", +"description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.", "type": "boolean" }, "labels": { @@ -6045,7 +6045,7 @@ "type": "string" }, "force": { -"description": "If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", +"description": "The default value is false. If this flag is `TRUE`, all tables are deleted from the dataset before the new exported tables are written. If the flag is not set and the destination dataset contains tables, the export call returns an error. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", "type": "boolean" }, "schemaConfig": { @@ -6743,7 +6743,8 @@ "type": "object" }, "messageType": { -"description": "The message type for this message. MSH-9.1.", +"description": "Output only. The message type for this message. MSH-9.1.", +"readOnly": true, "type": "string" }, "name": { @@ -6757,23 +6758,27 @@ "readOnly": true }, "patientIds": { -"description": "All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.", +"description": "Output only. All patient IDs listed in the PID-2, PID-3, and PID-4 segments of this message.", "items": { "$ref": "PatientId" }, +"readOnly": true, "type": "array" }, "schematizedData": { "$ref": "SchematizedData", -"description": "The parsed version of the raw message data schematized according to this store's schemas and type definitions." +"description": "Output only. The parsed version of the raw message data schematized according to this store's schemas and type definitions.", +"readOnly": true }, "sendFacility": { -"description": "The hospital that this message came from. MSH-4.", +"description": "Output only. The hospital that this message came from. MSH-4.", +"readOnly": true, "type": "string" }, "sendTime": { -"description": "The datetime the sending application sent this message. MSH-7.", +"description": "Output only. The datetime the sending application sent this message. MSH-7.", "format": "google-datetime", +"readOnly": true, "type": "string" } }, @@ -7709,19 +7714,19 @@ "id": "ValidationConfig", "properties": { "disableFhirpathValidation": { -"description": "Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableProfileValidation": { -"description": "Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", +"description": "Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against structure definitions in this FHIR store.", "type": "boolean" }, "disableReferenceTypeValidation": { -"description": "Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableRequiredFieldValidation": { -"description": "Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "enabledImplementationGuides": { diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json index 4b0c58614df..51267cfff03 100644 --- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json @@ -5672,7 +5672,7 @@ } } }, -"revision": "20240619", +"revision": "20240718", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5929,6 +5929,25 @@ }, "type": "object" }, +"ApplyAdminConsentsErrorDetail": { +"description": "Contains the error details of the unsupported admin Consent resources for when the ApplyAdminConsents method fails to apply one or more Consent resources.", +"id": "ApplyAdminConsentsErrorDetail", +"properties": { +"consentErrors": { +"description": "The list of Consent resources that are unsupported or cannot be applied and the error associated with each of them.", +"items": { +"$ref": "ConsentErrors" +}, +"type": "array" +}, +"existingOperationId": { +"description": "The currently in progress non-validate-only ApplyAdminConsents operation ID if exist.", +"format": "uint64", +"type": "string" +} +}, +"type": "object" +}, "ApplyAdminConsentsRequest": { "description": "Request to apply the admin Consent resources for the specified FHIR store.", "id": "ApplyAdminConsentsRequest", @@ -6522,7 +6541,7 @@ "description": "Optional. Specifies how the server logs the consent-aware requests. If not specified, the `AccessDeterminationLogConfig.LogLevel.MINIMUM` option is used." }, "accessEnforced": { -"description": "Optional. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.", +"description": "Optional. The default value is false. If set to true, when accessing FHIR resources, the consent headers will be verified against consents given by patients. See the ConsentEnforcementVersion for the supported consent headers.", "type": "boolean" }, "consentHeaderHandling": { @@ -6551,6 +6570,21 @@ }, "type": "object" }, +"ConsentErrors": { +"description": "The Consent resource name and error.", +"id": "ConsentErrors", +"properties": { +"error": { +"$ref": "Status", +"description": "The error code and message." +}, +"name": { +"description": "The versioned name of the admin Consent resource, in the format `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}/_history/{version_id}`. For FHIR stores with `disable_resource_versioning=true`, the format is `projects/{project_id}/locations/{location}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/fhir/Consent/{resource_id}`.", +"type": "string" +} +}, +"type": "object" +}, "ConsentEvaluation": { "description": "The detailed evaluation of a particular Consent.", "id": "ConsentEvaluation", @@ -6773,7 +6807,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { -"description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", +"description": "Ensures in-flight data remains in the region of origin during de-identification. The default value is false. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", "type": "boolean" } }, @@ -7610,11 +7644,11 @@ "type": "string" }, "sendFullResource": { -"description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.", +"description": "Whether to send full FHIR resource to this Pub/Sub topic for Create and Update operation. The default value is false. Note that setting this to true does not guarantee that all resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full resource as a separate operation.", "type": "boolean" }, "sendPreviousResourceOnDelete": { -"description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", +"description": "Whether to send full FHIR resource to this Pub/Sub topic for deleting FHIR resource. The default value is false. Note that setting this to true does not guarantee that all previous resources will be sent in the format of full FHIR resource. When a resource change is too large or during heavy traffic, only the resource name will be sent. Clients should always check the \"payloadType\" label from a Pub/Sub message to determine whether it needs to fetch the full previous resource as a separate operation.", "type": "boolean" } }, @@ -7654,7 +7688,7 @@ "description": "Optional. Specifies whether this store has consent enforcement. Not available for DSTU2 FHIR version due to absence of Consent resources." }, "defaultSearchHandlingStrict": { -"description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`.", +"description": "If true, overrides the default search behavior for this FHIR store to `handling=strict` which returns an error for unrecognized search parameters. If false, uses the FHIR specification default `handling=lenient` which ignores unrecognized search parameters. The handling can always be changed from the default on an individual API call by setting the HTTP header `Prefer: handling=strict` or `Prefer: handling=lenient`. Defaults to false.", "type": "boolean" }, "disableReferentialIntegrity": { @@ -7662,15 +7696,15 @@ "type": "boolean" }, "disableResourceVersioning": { -"description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, which is the default behavior, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions.", +"description": "Immutable. Whether to disable resource versioning for this FHIR store. This field can not be changed after the creation of FHIR store. If set to false, all write operations cause historical versions to be recorded automatically. The historical versions can be fetched through the history APIs, but cannot be updated. If set to true, no historical versions are kept. The server sends errors for attempts to read the historical versions. Defaults to false.", "type": "boolean" }, "enableHistoryModifications": { -"description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error.", +"description": "Optional. Whether to allow ExecuteBundle to accept history bundles, and directly insert and overwrite historical resource versions into the FHIR store. If set to false, using history bundles fails with an error. Defaults to false.", "type": "boolean" }, "enableUpdateCreate": { -"description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources.", +"description": "Whether this FHIR store has the [updateCreate capability](https://www.hl7.org/fhir/capabilitystatement-definitions.html#CapabilityStatement.rest.resource.updateCreate). This determines if the client can use an Update operation to create a new resource with a client-specified ID. If false, all IDs are server-assigned through the Create operation and attempts to update a non-existent resource return errors. It is strongly advised not to include or encode any sensitive data such as patient identifiers in client-specified resource IDs. Those IDs are part of the FHIR resource path recorded in Cloud audit logs and Pub/Sub notifications. Those IDs can also be contained in reference fields within other resources. Defaults to false.", "type": "boolean" }, "labels": { @@ -10227,19 +10261,19 @@ "id": "ValidationConfig", "properties": { "disableFhirpathValidation": { -"description": "Whether to disable FHIRPath validation for incoming resources. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable FHIRPath validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against FHIRPath requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableProfileValidation": { -"description": "Whether to disable profile validation for this FHIR store. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.", +"description": "Whether to disable profile validation for this FHIR store. The default value is false. Set this to true to disable checking incoming resources for conformance against StructureDefinitions in this FHIR store.", "type": "boolean" }, "disableReferenceTypeValidation": { -"description": "Whether to disable reference type validation for incoming resources. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable reference type validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against reference type requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "disableRequiredFieldValidation": { -"description": "Whether to disable required fields validation for incoming resources. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", +"description": "Whether to disable required fields validation for incoming resources. The default value is false. Set this to true to disable checking incoming resources for conformance against required fields requirement defined in the FHIR specification. This property only affects resource types that do not have profiles configured for them, any rules in enabled implementation guides will still be enforced.", "type": "boolean" }, "enabledImplementationGuides": { diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json index f2224a0a9c9..dc598fd5905 100644 --- a/googleapiclient/discovery_cache/documents/iam.v1.json +++ b/googleapiclient/discovery_cache/documents/iam.v1.json @@ -988,7 +988,7 @@ ] }, "delete": { -"description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.", +"description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.", "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}", "httpMethod": "DELETE", "id": "iam.organizations.roles.delete", @@ -2288,7 +2288,7 @@ ] }, "delete": { -"description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed.", +"description": "Deletes a custom Role. When you delete a custom role, the following changes occur immediately: * You cannot bind a principal to the custom role in an IAM Policy. * Existing bindings to the custom role are not changed, but they have no effect. * By default, the response from ListRoles does not include the custom role. A deleted custom role still counts toward the [custom role limit](/iam/quotas#limits) until it is permanently deleted. You have 7 days to undelete the custom role. After 7 days, the following changes occur: * The custom role is permanently deleted and cannot be recovered. * If an IAM policy contains a binding to the custom role, the binding is permanently removed. * The custom role no longer counts toward your custom role limit.", "flatPath": "v1/projects/{projectsId}/roles/{rolesId}", "httpMethod": "DELETE", "id": "iam.projects.roles.delete", @@ -3056,34 +3056,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, -"patch": { -"description": "Patches a ServiceAccountKey.", -"flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}:patch", -"httpMethod": "POST", -"id": "iam.projects.serviceAccounts.keys.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "The resource name of the service account key in the following format `projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.", -"location": "path", -"pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}:patch", -"request": { -"$ref": "PatchServiceAccountKeyRequest" -}, -"response": { -"$ref": "ServiceAccountKey" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform" -] -}, "upload": { "description": "Uploads the public key portion of a key pair that you manage, and associates the public key with a ServiceAccount. After you upload the public key, you can use the private key from the key pair as a service account key.", "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys:upload", @@ -3216,7 +3188,7 @@ } } }, -"revision": "20240703", +"revision": "20240722", "rootUrl": "https://iam.googleapis.com/", "schemas": { "AccessRestrictions": { @@ -4271,22 +4243,6 @@ }, "type": "object" }, -"PatchServiceAccountKeyRequest": { -"description": "The service account key patch request.", -"id": "PatchServiceAccountKeyRequest", -"properties": { -"serviceAccountKey": { -"$ref": "ServiceAccountKey", -"description": "Required. The service account key to update." -}, -"updateMask": { -"description": "Required. The update mask to apply to the service account key. Only the following fields are eligible for patching: - contact - description", -"format": "google-fieldmask", -"type": "string" -} -}, -"type": "object" -}, "PatchServiceAccountRequest": { "description": "The service account patch request. You can patch only the `display_name` and `description` fields. You must use the `update_mask` field to specify which of these fields you want to patch. Only the fields specified in the request are guaranteed to be returned in the response. Other fields may be empty in the response.", "id": "PatchServiceAccountRequest", @@ -4691,19 +4647,6 @@ false "description": "Represents a service account key. A service account has two sets of key-pairs: user-managed, and system-managed. User-managed key-pairs can be created and deleted by users. Users are responsible for rotating these keys periodically to ensure security of their service accounts. Users retain the private key of these key-pairs, and Google retains ONLY the public key. System-managed keys are automatically rotated by Google, and are used for signing for a maximum of two weeks. The rotation process is probabilistic, and usage of the new key will gradually ramp up and down over the key's lifetime. If you cache the public key set for a service account, we recommend that you update the cache every 15 minutes. User-managed keys can be added and removed at any time, so it is important to update the cache frequently. For Google-managed keys, Google will publish a key at least 6 hours before it is first used for signing and will keep publishing it for at least 6 hours after it was last used for signing. Public keys for all service accounts are also published at the OAuth2 Service Account API.", "id": "ServiceAccountKey", "properties": { -"contact": { -"description": "Optional. A user provided email address as the point of contact for this service account key. Must be an email address. Limit 64 characters.", -"type": "string" -}, -"creator": { -"description": "Output only. The cloud identity that created this service account key. Populated automatically when the key is created and not editable by the user.", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "Optional. A user provided description of this service account key.", -"type": "string" -}, "disableReason": { "description": "Output only. optional. If the key is disabled, it may have a DisableReason describing why it was disabled.", "enum": [ diff --git a/googleapiclient/discovery_cache/documents/language.v2.json b/googleapiclient/discovery_cache/documents/language.v2.json index 953f6354d5c..a4cec0fd65b 100644 --- a/googleapiclient/discovery_cache/documents/language.v2.json +++ b/googleapiclient/discovery_cache/documents/language.v2.json @@ -208,7 +208,7 @@ } } }, -"revision": "20240623", +"revision": "20240713", "rootUrl": "https://language.googleapis.com/", "schemas": { "AnalyzeEntitiesRequest": { @@ -577,6 +577,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", +"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -862,6 +863,7 @@ "", "", "", +"", "" ], "type": "string" @@ -1108,6 +1110,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", +"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1393,6 +1396,7 @@ "", "", "", +"", "" ], "type": "string" @@ -1525,6 +1529,7 @@ "A2_ULTRAGPU_4G", "A2_ULTRAGPU_8G", "A3_HIGHGPU_8G", +"A3_MEGAGPU_8G", "E2_STANDARD_2", "E2_STANDARD_4", "E2_STANDARD_8", @@ -1810,6 +1815,7 @@ "", "", "", +"", "" ], "type": "string" @@ -2968,6 +2974,7 @@ false "NVIDIA_A100_80GB", "NVIDIA_L4", "NVIDIA_H100_80GB", +"NVIDIA_H100_MEGA_80GB", "TPU_V2", "TPU_V3", "TPU_V4_POD", @@ -2984,6 +2991,7 @@ false "Nvidia A100 80GB GPU.", "Nvidia L4 GPU.", "Nvidia H100 80Gb GPU.", +"Nvidia H100 80Gb GPU.", "TPU v2 (JellyFish).", "TPU v3 (DragonFish).", "TPU_v4 (PufferFish).", diff --git a/googleapiclient/discovery_cache/documents/manufacturers.v1.json b/googleapiclient/discovery_cache/documents/manufacturers.v1.json index dd5330df4a4..62689be83cf 100644 --- a/googleapiclient/discovery_cache/documents/manufacturers.v1.json +++ b/googleapiclient/discovery_cache/documents/manufacturers.v1.json @@ -416,7 +416,7 @@ } } }, -"revision": "20240524", +"revision": "20240716", "rootUrl": "https://manufacturers.googleapis.com/", "schemas": { "Attributes": { @@ -892,6 +892,14 @@ "description": "Product issue.", "id": "Issue", "properties": { +"applicableCountries": { +"description": "Output only. List of country codes (ISO 3166-1 alpha-2) where issue applies to the manufacturer product.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "attribute": { "description": "If present, the attribute that triggered the issue. For more information about attributes, see https://support.google.com/manufacturers/answer/6124116.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/meet.v2.json b/googleapiclient/discovery_cache/documents/meet.v2.json index 26c8d3453b4..aec2c6df6dd 100644 --- a/googleapiclient/discovery_cache/documents/meet.v2.json +++ b/googleapiclient/discovery_cache/documents/meet.v2.json @@ -543,7 +543,7 @@ ] }, "endActiveConference": { -"description": "Ends an active conference (if there's one).", +"description": "Ends an active conference (if there's one). For an example, see [End active conference](https://developers.google.com/meet/api/guides/meeting-spaces#end-active-conference).", "flatPath": "v2/spaces/{spacesId}:endActiveConference", "httpMethod": "POST", "id": "meet.spaces.endActiveConference", @@ -552,7 +552,7 @@ ], "parameters": { "name": { -"description": "Required. Resource name of the space.", +"description": "Required. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -571,7 +571,7 @@ ] }, "get": { -"description": "Gets a space by `space_id` or `meeting_code`.", +"description": "Gets details about a meeting space. For an example, see [Get a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#get-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "GET", "id": "meet.spaces.get", @@ -580,7 +580,7 @@ ], "parameters": { "name": { -"description": "Required. Resource name of the space.", +"description": "Required. Resource name of the space. Format: `spaces/{space}` or `spaces/{meetingCode}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. `{meetingCode}` is an alias for the space. It's a typeable, unique character string and is non-case sensitive. For example, `abc-mnop-xyz`. The maximum length is 128 characters. A `meetingCode` shouldn't be stored long term as it can become dissociated from a meeting space and can be reused for different meeting spaces in the future. Generally, a `meetingCode` expires 365 days after last use. For more information, see [Learn about meeting codes in Google Meet](https://support.google.com/meet/answer/10710509). For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -597,7 +597,7 @@ ] }, "patch": { -"description": "Updates a space.", +"description": "Updates details about a meeting space. For an example, see [Update a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#update-meeting-space).", "flatPath": "v2/spaces/{spacesId}", "httpMethod": "PATCH", "id": "meet.spaces.patch", @@ -606,7 +606,7 @@ ], "parameters": { "name": { -"description": "Immutable. Resource name of the space. Format: `spaces/{space}`", +"description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "location": "path", "pattern": "^spaces/[^/]+$", "required": true, @@ -633,7 +633,7 @@ } } }, -"revision": "20240707", +"revision": "20240716", "rootUrl": "https://meet.googleapis.com/", "schemas": { "ActiveConference": { @@ -1000,17 +1000,17 @@ "description": "Configuration pertaining to the meeting space." }, "meetingCode": { -"description": "Output only. Type friendly code to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+` such as `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space ID to get the space.", +"description": "Output only. Type friendly unique string used to join the meeting. Format: `[a-z]+-[a-z]+-[a-z]+`. For example, `abc-mnop-xyz`. The maximum length is 128 characters. Can only be used as an alias of the space name to get the space.", "readOnly": true, "type": "string" }, "meetingUri": { -"description": "Output only. URI used to join meetings, such as `https://meet.google.com/abc-mnop-xyz`.", +"description": "Output only. URI used to join meetings consisting of `https://meet.google.com/` followed by the `meeting_code`. For example, `https://meet.google.com/abc-mnop-xyz`.", "readOnly": true, "type": "string" }, "name": { -"description": "Immutable. Resource name of the space. Format: `spaces/{space}`", +"description": "Immutable. Resource name of the space. Format: `spaces/{space}`. `{space}` is the resource identifier for the space. It's a unique, server-generated ID and is case sensitive. For example, `jQCFfuBOdN5z`. For more information, see [How Meet identifies a meeting space](https://developers.google.com/meet/api/guides/meeting-spaces#identify-meeting-space).", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 6b2052102d3..2b442215d42 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -1153,7 +1153,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", +"description": "Required. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}`", "location": "path", "pattern": "^accounts/[^/]+/termsOfServiceAgreementStates/[^/]+$", "required": true, @@ -1453,7 +1453,7 @@ } } }, -"revision": "20240709", +"revision": "20240719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfService": { @@ -3358,7 +3358,7 @@ false "description": "The accepted terms of service of this kind and for the associated region_code" }, "name": { -"description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}`", +"description": "Identifier. The resource name of the terms of service version. Format: `accounts/{account}/termsOfServiceAgreementState/{identifier}` The identifier format is: `{TermsOfServiceKind}-{country}` For example, an identifier could be: `MERCHANT_CENTER-US`", "type": "string" }, "regionCode": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json index 27cad1e815b..47f1350d3ff 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.datasources_v1beta.json @@ -290,7 +290,7 @@ } } }, -"revision": "20240614", +"revision": "20240719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "DataSource": { @@ -526,7 +526,7 @@ "Not specified.", "Online product.", "Local product.", -"Unified data source for both local and online products." +"Unified data source for both local and online products. Note: Products management through the API is not possible for this channel." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json index d0044bb752d..5ee7d0267c9 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1beta.json @@ -242,7 +242,7 @@ } } }, -"revision": "20240614", +"revision": "20240719", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "Attributes": { @@ -1085,6 +1085,10 @@ false "format": "int64", "type": "string" }, +"memberPriceEffectiveDate": { +"$ref": "Interval", +"description": "A date range during which the item is eligible for member price. If not specified, the member price is always applicable. The date range is represented by a pair of ISO 8601 dates separated by a space, comma, or slash." +}, "price": { "$ref": "Price", "description": "The price for members of the given tier, that is, the instant discount price. Must be smaller or equal to the regular price." diff --git a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json index b1f9a6e5b5e..8272febb31a 100644 --- a/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/migrationcenter.v1alpha1.json @@ -2473,7 +2473,7 @@ } } }, -"revision": "20240704", +"revision": "20240711", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3452,7 +3452,7 @@ "description": "Preferences concerning the machine types to consider on Compute Engine." }, "multithreading": { -"description": "Optional. Preferences for multithreading support.", +"description": "Optional. Preferences for multithreading support on Windows Server.", "enum": [ "MULTITHREADING_UNSPECIFIED", "MULTITHREADING_DISABLED", @@ -3460,10 +3460,10 @@ "MULTITHREADING_DISABLED_WITH_COMPENSATION" ], "enumDescriptions": [ -"Same as MULTITHREADING_DISABLED_WITH_COMPENSATION.", -"Disable simultaneous multithreading if doing so is advantageous.", -"Always enable simultaneous multithreading.", -"Disable simultaneous multithreading and increase number of VCPUs to compensate, if doing so is advantageous." +"Same as MULTITHREADING_AUTO.", +"Disable simultaneous multithreading.", +"Enable simultaneous multithreading.", +"Disable simultaneous multithreading and increase number of VCPUs to compensate." ], "type": "string" }, @@ -4070,10 +4070,10 @@ "MULTITHREADING_DISABLED_WITH_COMPENSATION" ], "enumDescriptions": [ -"Same as MULTITHREADING_DISABLED_WITH_COMPENSATION.", -"Disable simultaneous multithreading if doing so is lower cost.", -"Always enable simultaneous multithreading.", -"Disable simultaneous multithreading and increase number of VCPUs to compensate, if doing so is lower cost." +"Same as MULTITHREADING_AUTO.", +"Disable simultaneous multithreading.", +"Enable simultaneous multithreading.", +"Disable simultaneous multithreading and increase number of VCPUs to compensate." ], "type": "string" }, @@ -6991,7 +6991,8 @@ false }, "monthlyCostCompute": { "$ref": "Money", -"description": "Compute monthly cost for this preference set." +"description": "Output only. Compute monthly cost for this preference set.", +"readOnly": true }, "monthlyCostDatabaseBackup": { "$ref": "Money", @@ -7005,23 +7006,28 @@ false }, "monthlyCostNetworkEgress": { "$ref": "Money", -"description": "Network Egress monthly cost for this preference set. Only present for virtual machines." +"description": "Output only. Network Egress monthly cost for this preference set. Only present for virtual machines.", +"readOnly": true }, "monthlyCostOsLicense": { "$ref": "Money", -"description": "Operating system licensing monthly cost for this preference set. Only present for virtual machines." +"description": "Output only. Operating system licensing monthly cost for this preference set. Only present for virtual machines.", +"readOnly": true }, "monthlyCostOther": { "$ref": "Money", -"description": "Miscellaneous monthly cost for this preference set." +"description": "Output only. Miscellaneous monthly cost for this preference set.", +"readOnly": true }, "monthlyCostStorage": { "$ref": "Money", -"description": "Storage monthly cost for this preference set." +"description": "Output only. Storage monthly cost for this preference set.", +"readOnly": true }, "monthlyCostTotal": { "$ref": "Money", -"description": "Total monthly cost for this preference set." +"description": "Output only. Total monthly cost for this preference set.", +"readOnly": true }, "preferenceSet": { "$ref": "PreferenceSet", diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index b2c0393fb28..529a97940c9 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240709", +"revision": "20240715", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1939,7 +1939,8 @@ "NUGET", "RUBYGEMS", "RUST", -"COMPOSER" +"COMPOSER", +"SWIFT" ], "enumDescriptions": [ "", @@ -1952,7 +1953,8 @@ "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", "Rust packages from Cargo (Github ecosystem is `RUST`).", -"PHP packages from Composer package manager." +"PHP packages from Composer package manager.", +"Swift packages from Swift Package Manager (SwiftPM)." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index 2df09cd2fdb..8dd69ba675c 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -339,7 +339,7 @@ } } }, -"revision": "20240709", +"revision": "20240715", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -1934,7 +1934,8 @@ "NUGET", "RUBYGEMS", "RUST", -"COMPOSER" +"COMPOSER", +"SWIFT" ], "enumDescriptions": [ "", @@ -1947,7 +1948,8 @@ "Nuget (C#/.NET) packages.", "Ruby packges (from RubyGems package manager).", "Rust packages from Cargo (Github ecosystem is `RUST`).", -"PHP packages from Composer package manager." +"PHP packages from Composer package manager.", +"Swift packages from Swift Package Manager (SwiftPM)." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/pollen.v1.json b/googleapiclient/discovery_cache/documents/pollen.v1.json index 6c61b097e0e..db43cff4afc 100644 --- a/googleapiclient/discovery_cache/documents/pollen.v1.json +++ b/googleapiclient/discovery_cache/documents/pollen.v1.json @@ -121,7 +121,7 @@ "type": "integer" }, "languageCode": { -"description": "Optional. Allows the client to choose the language for the response. If data cannot be provided for that language the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. Default value is \"en\".", +"description": "Optional. Allows the client to choose the language for the response. If data cannot be provided for that language, the API uses the closest match. Allowed values rely on the IETF BCP-47 standard. The default value is \"en\".", "location": "query", "type": "string" }, @@ -138,18 +138,18 @@ "type": "number" }, "pageSize": { -"description": "Optional. The maximum number of daily info records to return per page. The default and max value is 5 (5 days of data).", +"description": "Optional. The maximum number of daily info records to return per page. The default and max value is 5, indicating 5 days of data.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { -"description": "Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token all other request parameters provided must match the previous call that provided the page token.", +"description": "Optional. A page token received from a previous daily call. It is used to retrieve the subsequent page. Note that when providing a value for the page token, all other request parameters provided must match the previous call that provided the page token.", "location": "query", "type": "string" }, "plantsDescription": { -"description": "Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos.", +"description": "Optional. Contains general information about plants, including details on their seasonality, special shapes and colors, information about allergic cross-reactions, and plant photos. The default value is \"true\".", "location": "query", "type": "boolean" } @@ -192,7 +192,7 @@ "Unspecified map type.", "The heatmap type will represent a tree index graphical map.", "The heatmap type will represent a grass index graphical map.", -"The heatmap type will represent a weed index graphically map." +"The heatmap type will represent a weed index graphical map." ], "location": "path", "required": true, @@ -233,7 +233,7 @@ } } }, -"revision": "20240707", +"revision": "20240720", "rootUrl": "https://pollen.googleapis.com/", "schemas": { "Color": { @@ -294,14 +294,14 @@ "description": "The date in UTC at which the pollen forecast data is represented." }, "plantInfo": { -"description": "This list will include (up to) 15 pollen species affecting the location specified in the request.", +"description": "This list will include up to 15 pollen species affecting the location specified in the request.", "items": { "$ref": "PlantInfo" }, "type": "array" }, "pollenTypeInfo": { -"description": "This list will include (up to) three pollen types (grass, weed, tree) affecting the location specified in the request.", +"description": "This list will include up to three pollen types (GRASS, WEED, TREE) affecting the location specified in the request.", "items": { "$ref": "PollenTypeInfo" }, diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index 5a41fbb0731..c285e7ae463 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -694,7 +694,7 @@ } } }, -"revision": "20240630", +"revision": "20240713", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -1032,7 +1032,7 @@ true "type": "string" }, "express": { -"description": "Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference a SCORE key with WAF feature set to EXPRESS.", +"description": "Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, `site_key` must reference an Express site key.", "type": "boolean" }, "firewallPolicyEvaluation": { @@ -1105,6 +1105,12 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1ExpressKeySettings": { +"description": "Settings specific to keys that can be used for reCAPTCHA Express.", +"id": "GoogleCloudRecaptchaenterpriseV1ExpressKeySettings", +"properties": {}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1FirewallAction": { "description": "An individual action. Each action represents what to do if a policy matches.", "id": "GoogleCloudRecaptchaenterpriseV1FirewallAction", @@ -1403,6 +1409,10 @@ true "description": "Required. Human-readable display name of this key. Modifiable by user.", "type": "string" }, +"expressSettings": { +"$ref": "GoogleCloudRecaptchaenterpriseV1ExpressKeySettings", +"description": "Settings for keys that can be used by reCAPTCHA Express." +}, "iosSettings": { "$ref": "GoogleCloudRecaptchaenterpriseV1IOSKeySettings", "description": "Settings for keys that can be used by iOS apps." @@ -1411,7 +1421,7 @@ true "additionalProperties": { "type": "string" }, -"description": "Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha-enterprise/docs/labels).", +"description": "Optional. See [Creating and managing labels] (https://cloud.google.com/recaptcha/docs/labels).", "type": "object" }, "name": { @@ -1541,7 +1551,7 @@ true "id": "GoogleCloudRecaptchaenterpriseV1MigrateKeyRequest", "properties": { "skipBillingCheck": { -"description": "Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha-enterprise/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha-enterprise/docs/billing-information.", +"description": "Optional. If true, skips the billing check. A reCAPTCHA Enterprise key or migrated key behaves differently than a reCAPTCHA (non-Enterprise version) key when you reach a quota limit (see https://cloud.google.com/recaptcha/quotas#quota_limit). To avoid any disruption of your usage, we check that a billing account is present. If your usage of reCAPTCHA is under the free quota, you can safely skip the billing check and proceed with the migration. See https://cloud.google.com/recaptcha/docs/billing-information.", "type": "boolean" } }, diff --git a/googleapiclient/discovery_cache/documents/redis.v1.json b/googleapiclient/discovery_cache/documents/redis.v1.json index 47cbe760491..bd9743f2767 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240627", +"revision": "20240711", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1231,8 +1231,7 @@ "type": "string" }, "observabilityMetricData": { -"$ref": "ObservabilityMetricData", -"description": "More feed data would be added in subsequent CLs" +"$ref": "ObservabilityMetricData" }, "recommendationSignalData": { "$ref": "DatabaseResourceRecommendationSignalData" diff --git a/googleapiclient/discovery_cache/documents/redis.v1beta1.json b/googleapiclient/discovery_cache/documents/redis.v1beta1.json index e8cfdc05c00..ec5d28e2022 100644 --- a/googleapiclient/discovery_cache/documents/redis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/redis.v1beta1.json @@ -821,7 +821,7 @@ } } }, -"revision": "20240627", +"revision": "20240711", "rootUrl": "https://redis.googleapis.com/", "schemas": { "AOFConfig": { @@ -1231,8 +1231,7 @@ "type": "string" }, "observabilityMetricData": { -"$ref": "ObservabilityMetricData", -"description": "More feed data would be added in subsequent CLs" +"$ref": "ObservabilityMetricData" }, "recommendationSignalData": { "$ref": "DatabaseResourceRecommendationSignalData" diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json index 6dfefb6f379..3325597cd47 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2alpha.json +++ b/googleapiclient/discovery_cache/documents/retail.v2alpha.json @@ -2259,6 +2259,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"export": { +"description": "Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.", +"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:export", +"httpMethod": "POST", +"id": "retail.projects.locations.catalogs.userEvents.export", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2alpha/{+parent}/userEvents:export", +"request": { +"$ref": "GoogleCloudRetailV2alphaExportUserEventsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "import": { "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", "flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", @@ -2557,7 +2585,7 @@ } } }, -"revision": "20240702", +"revision": "20240711", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4483,6 +4511,21 @@ }, "type": "object" }, +"GoogleCloudRetailV2alphaExportUserEventsRequest": { +"description": "Request message for the `ExportUserEvents` method.", +"id": "GoogleCloudRetailV2alphaExportUserEventsRequest", +"properties": { +"filter": { +"description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `eventTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`", +"type": "string" +}, +"outputConfig": { +"$ref": "GoogleCloudRetailV2alphaOutputConfig", +"description": "Required. The output location of the data." +} +}, +"type": "object" +}, "GoogleCloudRetailV2alphaExportUserEventsResponse": { "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2alphaExportUserEventsResponse", diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json index 9658a0902e2..834fda6071e 100644 --- a/googleapiclient/discovery_cache/documents/retail.v2beta.json +++ b/googleapiclient/discovery_cache/documents/retail.v2beta.json @@ -1854,6 +1854,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"export": { +"description": "Exports user events. `Operation.response` is of type `ExportResponse`. `Operation.metadata` is of type `ExportMetadata`.", +"flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:export", +"httpMethod": "POST", +"id": "retail.projects.locations.catalogs.userEvents.export", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Resource name of a Catalog. For example `projects/1234/locations/global/catalogs/default_catalog`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/catalogs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta/{+parent}/userEvents:export", +"request": { +"$ref": "GoogleCloudRetailV2betaExportUserEventsRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "import": { "description": "Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. `Operation.response` is of type `ImportResponse`. Note that it is possible for a subset of the items to be successfully inserted. `Operation.metadata` is of type `ImportMetadata`.", "flatPath": "v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/userEvents:import", @@ -2120,7 +2148,7 @@ } } }, -"revision": "20240702", +"revision": "20240711", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4606,6 +4634,21 @@ }, "type": "object" }, +"GoogleCloudRetailV2betaExportUserEventsRequest": { +"description": "Request message for the `ExportUserEvents` method.", +"id": "GoogleCloudRetailV2betaExportUserEventsRequest", +"properties": { +"filter": { +"description": "A filtering expression to specify restrictions on returned events. The expression is a sequence of terms. Each term applies a restriction to the returned user events. Use this expression to restrict results to a specific time range or to filter events by eventType. For example, `eventTime > \"2012-04-23T18:25:43.511Z\" eventsMissingCatalogItems eventTime<\"2012-04-23T18:25:43.511Z\" eventType=search` We expect only three types of fields: * `eventTime`: This can be specified twice, once with a less than operator and once with a greater than operator. The `eventTime` restriction should result in one, contiguous, valid, `eventTime` range. * `eventType`: Boolean operators `OR` and `NOT` are supported if the expression is enclosed in parentheses and the operators are separated from the tag values by a space. * `eventsMissingCatalogItems`: This restricts results to events for which catalog items were not found in the catalog. The default behavior is to return only those events for which catalog items were found. Some examples of valid filters expressions: * Example 1: `eventTime > \"2012-04-23T18:25:43.511Z\" eventTime < \"2012-04-23T18:30:43.511Z\"` * Example 2: `eventTime > \"2012-04-23T18:25:43.511Z\" eventType = detail-page-view` * Example 3: `eventsMissingCatalogItems eventType = (NOT search) eventTime < \"2018-04-23T18:30:43.511Z\"` * Example 4: `eventTime > \"2012-04-23T18:25:43.511Z\"` * Example 5: `eventType = (detail-page-view OR search)` * Example 6: `eventsMissingCatalogItems`", +"type": "string" +}, +"outputConfig": { +"$ref": "GoogleCloudRetailV2betaOutputConfig", +"description": "Required. The output location of the data." +} +}, +"type": "object" +}, "GoogleCloudRetailV2betaExportUserEventsResponse": { "description": "Response of the ExportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.", "id": "GoogleCloudRetailV2betaExportUserEventsResponse", diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index dc86a4f86ad..b3e1b649cb7 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2614,7 +2614,7 @@ } } }, -"revision": "20240705", +"revision": "20240712", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -5674,7 +5674,7 @@ false "id": "RevisionSpec", "properties": { "containerConcurrency": { -"description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified, defaults to 80.", +"description": "ContainerConcurrency specifies the maximum allowed in-flight (concurrent) requests per container instance of the Revision. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/run.v2.json b/googleapiclient/discovery_cache/documents/run.v2.json index 7133b466bd1..c1fe43f5267 100644 --- a/googleapiclient/discovery_cache/documents/run.v2.json +++ b/googleapiclient/discovery_cache/documents/run.v2.json @@ -1494,7 +1494,7 @@ } } }, -"revision": "20240705", +"revision": "20240712", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2979,7 +2979,7 @@ "type": "object" }, "maxInstanceRequestConcurrency": { -"description": "Optional. Sets the maximum number of requests that each serving instance can receive.", +"description": "Optional. Sets the maximum number of requests that each serving instance can receive. If not specified or 0, defaults to 80 when requested CPU >= 1 and defaults to 1 when requested CPU < 1.", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1.json index 1864af9c9c6..d8d1fe17541 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1.json @@ -414,7 +414,7 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -446,7 +446,7 @@ ], "parameters": { "parent": { -"description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -474,7 +474,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -499,7 +499,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -535,7 +535,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -571,7 +571,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -634,7 +634,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", +"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -670,7 +670,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2190,7 +2190,7 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2222,7 +2222,7 @@ ], "parameters": { "parent": { -"description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2250,7 +2250,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2275,7 +2275,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -2311,7 +2311,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2347,7 +2347,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -2410,7 +2410,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", +"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -2446,7 +2446,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4649,7 +4649,7 @@ ], "parameters": { "parent": { -"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Resource name of the parent to validate the Custom Module under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4681,7 +4681,7 @@ ], "parameters": { "parent": { -"description": "Required. The new custom module's parent. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. The new custom module's parent. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4709,7 +4709,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to delete. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to delete. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4734,7 +4734,7 @@ ], "parameters": { "name": { -"description": "Required. Name of the custom module to get. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/customModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/customModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/customModules/{module}\".", +"description": "Required. Name of the custom module to get. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/customModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/customModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/customModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/customModules/[^/]+$", "required": true, @@ -4770,7 +4770,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4806,7 +4806,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules under. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules under. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -4869,7 +4869,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}\". * \"projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}\".", +"description": "Required. The resource name of the effective Event Threat Detection custom module. Its format is: * `organizations/{organization}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `folders/{folder}/eventThreatDetectionSettings/effectiveCustomModules/{module}`. * `projects/{project}/eventThreatDetectionSettings/effectiveCustomModules/{module}`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings/effectiveCustomModules/[^/]+$", "required": true, @@ -4905,7 +4905,7 @@ "type": "string" }, "parent": { -"description": "Required. Name of the parent to list custom modules for. Its format is: * \"organizations/{organization}/eventThreatDetectionSettings\". * \"folders/{folder}/eventThreatDetectionSettings\". * \"projects/{project}/eventThreatDetectionSettings\".", +"description": "Required. Name of the parent to list custom modules for. Its format is: * `organizations/{organization}/eventThreatDetectionSettings`. * `folders/{folder}/eventThreatDetectionSettings`. * `projects/{project}/eventThreatDetectionSettings`.", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -6027,7 +6027,7 @@ } } }, -"revision": "20240705", +"revision": "20240720", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -9178,7 +9178,7 @@ "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", +"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -9195,7 +9195,7 @@ "type": "string" }, "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", +"description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -10871,7 +10871,7 @@ "type": "string" }, "name": { -"description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", +"description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { @@ -11359,7 +11359,7 @@ "type": "string" }, "name": { -"description": "Name for the resource value configuration", +"description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { @@ -11374,7 +11374,7 @@ "type": "string" }, "resourceValue": { -"description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", +"description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -11392,7 +11392,7 @@ "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", +"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -11400,7 +11400,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { -"description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", +"description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -13375,7 +13375,7 @@ "description": "Provides the path to the resource within the resource hierarchy." }, "resourcePathString": { -"description": "A string representation of the resource path. For Google Cloud, it has the format of org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id} where there can be any number of folders. For AWS, it has the format of org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id} where there can be any number of organizational units. For Azure, it has the format of mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name} where there can be any number of management groups.", +"description": "A string representation of the resource path. For Google Cloud, it has the format of `org/{organization_id}/folder/{folder_id}/folder/{folder_id}/project/{project_id}` where there can be any number of folders. For AWS, it has the format of `org/{organization_id}/ou/{organizational_unit_id}/ou/{organizational_unit_id}/account/{account_id}` where there can be any number of organizational units. For Azure, it has the format of `mg/{management_group_id}/mg/{management_group_id}/subscription/{subscription_id}/rg/{resource_group_name}` where there can be any number of management groups.", "type": "string" }, "service": { diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json index fe1b83af845..d458e5df8cd 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta1.json @@ -896,7 +896,7 @@ } } }, -"revision": "20240705", +"revision": "20240720", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -3789,7 +3789,7 @@ "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", +"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -3806,7 +3806,7 @@ "type": "string" }, "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", +"description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -5482,7 +5482,7 @@ "type": "string" }, "name": { -"description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", +"description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { @@ -5970,7 +5970,7 @@ "type": "string" }, "name": { -"description": "Name for the resource value configuration", +"description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { @@ -5985,7 +5985,7 @@ "type": "string" }, "resourceValue": { -"description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", +"description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -6003,7 +6003,7 @@ "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", +"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -6011,7 +6011,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { -"description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", +"description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json index dfcbde00075..eb1d09b4912 100644 --- a/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/securitycenter.v1beta2.json @@ -292,7 +292,7 @@ ], "parameters": { "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -326,7 +326,7 @@ ], "parameters": { "name": { -"description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", +"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -394,7 +394,7 @@ ], "parameters": { "name": { -"description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", +"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^folders/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -428,7 +428,7 @@ ], "parameters": { "name": { -"description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", +"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^folders/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -462,7 +462,7 @@ ], "parameters": { "name": { -"description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", +"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^folders/[^/]+/webSecurityScannerSettings$", "required": true, @@ -876,7 +876,7 @@ ], "parameters": { "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -910,7 +910,7 @@ ], "parameters": { "name": { -"description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", +"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -978,7 +978,7 @@ ], "parameters": { "name": { -"description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", +"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^organizations/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1012,7 +1012,7 @@ ], "parameters": { "name": { -"description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", +"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^organizations/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -1046,7 +1046,7 @@ ], "parameters": { "name": { -"description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", +"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^organizations/[^/]+/webSecurityScannerSettings$", "required": true, @@ -1435,7 +1435,7 @@ ], "parameters": { "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1469,7 +1469,7 @@ ], "parameters": { "name": { -"description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", +"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/eventThreatDetectionSettings$", "required": true, @@ -1537,7 +1537,7 @@ ], "parameters": { "name": { -"description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", +"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "location": "path", "pattern": "^projects/[^/]+/securityHealthAnalyticsSettings$", "required": true, @@ -1571,7 +1571,7 @@ ], "parameters": { "name": { -"description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", +"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/virtualMachineThreatDetectionSettings$", "required": true, @@ -1605,7 +1605,7 @@ ], "parameters": { "name": { -"description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", +"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "location": "path", "pattern": "^projects/[^/]+/webSecurityScannerSettings$", "required": true, @@ -1728,7 +1728,7 @@ ], "parameters": { "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/containerThreatDetectionSettings$", "required": true, @@ -1906,7 +1906,7 @@ } } }, -"revision": "20240705", +"revision": "20240720", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2599,11 +2599,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", +"description": "Identifier. The resource name of the ContainerThreatDetectionSettings. Formats: * organizations/{organization}/containerThreatDetectionSettings * folders/{folder}/containerThreatDetectionSettings * projects/{project}/containerThreatDetectionSettings * projects/{project}/locations/{location}/clusters/{cluster}/containerThreatDetectionSettings", "type": "string" }, "serviceAccount": { @@ -2969,11 +2969,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", +"description": "Identifier. The resource name of the EventThreatDetectionSettings. Formats: * organizations/{organization}/eventThreatDetectionSettings * folders/{folder}/eventThreatDetectionSettings * projects/{project}/eventThreatDetectionSettings", "type": "string" }, "serviceEnablementState": { @@ -4702,7 +4702,7 @@ "type": "string" }, "dataset": { -"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery Dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", +"description": "The dataset to write findings' updates to. Its format is \"projects/[project_id]/datasets/[bigquery_dataset_id]\". BigQuery dataset unique ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_).", "type": "string" }, "description": { @@ -4719,7 +4719,7 @@ "type": "string" }, "name": { -"description": "The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", +"description": "Identifier. The relative resource name of this export. See: https://cloud.google.com/apis/design/resource_names#relative_resource_name. The following list shows some examples: + `organizations/{organization_id}/locations/{location_id}/bigQueryExports/{export_id}` + `folders/{folder_id}/locations/{location_id}/bigQueryExports/{export_id}` + `projects/{project_id}/locations/{location_id}/bigQueryExports/{export_id}` This field is provided in responses, and is ignored when provided in create requests.", "type": "string" }, "principal": { @@ -6395,7 +6395,7 @@ "type": "string" }, "name": { -"description": "This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", +"description": "Identifier. This field will be ignored if provided on config creation. The following list shows some examples of the format: + `organizations/{organization}/muteConfigs/{mute_config}` + `organizations/{organization}locations/{location}//muteConfigs/{mute_config}` + `folders/{folder}/muteConfigs/{mute_config}` + `folders/{folder}/locations/{location}/muteConfigs/{mute_config}` + `projects/{project}/muteConfigs/{mute_config}` + `projects/{project}/locations/{location}/muteConfigs/{mute_config}`", "type": "string" }, "type": { @@ -6883,7 +6883,7 @@ "type": "string" }, "name": { -"description": "Name for the resource value configuration", +"description": "Identifier. Name for the resource value configuration", "type": "string" }, "resourceLabelsSelector": { @@ -6898,7 +6898,7 @@ "type": "string" }, "resourceValue": { -"description": "Resource value level this expression represents Only required when there is no SDP mapping in the request", +"description": "Resource value level this expression represents Only required when there is no Sensitive Data Protection mapping in the request", "enum": [ "RESOURCE_VALUE_UNSPECIFIED", "HIGH", @@ -6916,7 +6916,7 @@ "type": "string" }, "scope": { -"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope will be checked with `AND` of other resources.", +"description": "Project or folder to scope this configuration to. For example, \"project/456\" would apply this configuration only to resources in \"project/456\" scope and will be checked with `AND` of other resources.", "type": "string" }, "sensitiveDataProtectionMapping": { @@ -6924,7 +6924,7 @@ "description": "A mapping of the sensitivity on Sensitive Data Protection finding to resource values. This mapping can only be used in combination with a resource_type that is related to BigQuery, e.g. \"bigquery.googleapis.com/Dataset\"." }, "tagValues": { -"description": "Required. Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", +"description": "Tag values combined with `AND` to check against. Values in the form \"tagValues/123\" Example: `[ \"tagValues/123\", \"tagValues/456\", \"tagValues/789\" ]` https://cloud.google.com/resource-manager/docs/tags/tags-creating-and-managing", "items": { "type": "string" }, @@ -8332,11 +8332,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", +"description": "Identifier. The resource name of the SecurityHealthAnalyticsSettings. Formats: * organizations/{organization}/securityHealthAnalyticsSettings * folders/{folder}/securityHealthAnalyticsSettings * projects/{project}/securityHealthAnalyticsSettings", "type": "string" }, "serviceAccount": { @@ -8590,11 +8590,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", +"description": "Identifier. The resource name of the VirtualMachineThreatDetectionSettings. Formats: * organizations/{organization}/virtualMachineThreatDetectionSettings * folders/{folder}/virtualMachineThreatDetectionSettings * projects/{project}/virtualMachineThreatDetectionSettings", "type": "string" }, "serviceAccount": { @@ -8709,11 +8709,11 @@ "additionalProperties": { "$ref": "Config" }, -"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's.", +"description": "The configurations including the state of enablement for the service's different modules. The absence of a module in the map implies its configuration is inherited from its parent's configuration.", "type": "object" }, "name": { -"description": "The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", +"description": "Identifier. The resource name of the WebSecurityScannerSettings. Formats: * organizations/{organization}/webSecurityScannerSettings * folders/{folder}/webSecurityScannerSettings * projects/{project}/webSecurityScannerSettings", "type": "string" }, "serviceEnablementState": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json index 9ad11d4aea6..f12d5a48a5f 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1.json @@ -542,7 +542,7 @@ } } }, -"revision": "20240707", +"revision": "20240712", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "AddTenantProjectRequest": { @@ -1003,14 +1003,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1126,7 +1126,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1495,7 +1495,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json index 8209ba2aa8e..f3d9e84a518 100644 --- a/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceconsumermanagement.v1beta1.json @@ -715,7 +715,7 @@ } } }, -"revision": "20240707", +"revision": "20240712", "rootUrl": "https://serviceconsumermanagement.googleapis.com/", "schemas": { "Api": { @@ -1110,14 +1110,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1211,7 +1211,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1580,7 +1580,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json index 6998b83a235..9c798284d8e 100644 --- a/googleapiclient/discovery_cache/documents/servicemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/servicemanagement.v1.json @@ -830,7 +830,7 @@ } } }, -"revision": "20240628", +"revision": "20240712", "rootUrl": "https://servicemanagement.googleapis.com/", "schemas": { "Advice": { @@ -1427,14 +1427,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1561,7 +1561,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -2043,7 +2043,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json index 8239a03d6de..d18d247b207 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1.json @@ -1029,7 +1029,7 @@ } } }, -"revision": "20240707", +"revision": "20240716", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -1765,14 +1765,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1957,7 +1957,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -2421,7 +2421,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json index b5451af2e9c..18bd3a50dc7 100644 --- a/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json +++ b/googleapiclient/discovery_cache/documents/servicenetworking.v1beta.json @@ -307,7 +307,7 @@ } } }, -"revision": "20240707", +"revision": "20240716", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { @@ -918,14 +918,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1073,7 +1073,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1505,7 +1505,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1.json index d945e35592a..8d1840f139a 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1.json @@ -426,7 +426,7 @@ } } }, -"revision": "20240707", +"revision": "20240712", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -998,14 +998,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1147,7 +1147,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -1971,7 +1971,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json index e7809f590ec..6037b5a29ed 100644 --- a/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/serviceusage.v1beta1.json @@ -964,7 +964,7 @@ } } }, -"revision": "20240707", +"revision": "20240712", "rootUrl": "https://serviceusage.googleapis.com/", "schemas": { "AddEnableRulesMetadata": { @@ -1594,14 +1594,14 @@ "type": "array" }, "provided": { -"description": "A list of full type names of provided contexts.", +"description": "A list of full type names of provided contexts. It is used to support propagating HTTP headers and ETags from the response extension.", "items": { "type": "string" }, "type": "array" }, "requested": { -"description": "A list of full type names of requested contexts.", +"description": "A list of full type names of requested contexts, only the requested context will be made available to the backend.", "items": { "type": "string" }, @@ -1724,7 +1724,7 @@ "type": "object" }, "Documentation": { -"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... code_snippet_rules: - selector: google.calendar.Calendar.Delete code_snippets: - includes: - github_include: region_tag: calendar_delete code_language: JAVA account: GoogleCloudPlatform project: java-docs-samples file: calendar/delete.java Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", +"description": "`Documentation` provides the information for describing a service. Example: documentation: summary: > The Google Calendar API gives access to most calendar features. pages: - name: Overview content: (== include google/foo/overview.md ==) - name: Tutorial content: (== include google/foo/tutorial.md ==) subpages: - name: Java content: (== include google/foo/tutorial_java.md ==) rules: - selector: google.calendar.Calendar.Get description: > ... - selector: google.calendar.Calendar.Put description: > ... Documentation is provided in markdown syntax. In addition to standard markdown features, definition lists, tables and fenced code blocks are supported. Section headers can be provided and are interpreted relative to the section nesting of the context where a documentation fragment is embedded. Documentation from the IDL is merged with documentation defined via the config at normalization time, where documentation provided by config rules overrides IDL provided. A number of constructs specific to the API platform are supported in documentation text. In order to reference a proto element, the following notation can be used: [fully.qualified.proto.name][] To override the display text used for the link, this can be used: [display text][fully.qualified.proto.name] Text can be excluded from doc using the following notation: (-- internal comment --) A few directives are available in documentation. Note that directives must appear on a single line to be properly identified. The `include` directive includes a markdown file from an external source: (== include path/to/file ==) The `resource_for` directive marks a message to be the resource of a collection in REST view. If it is not specified, tools attempt to infer the resource from the operations in a collection: (== resource_for v1.shelves.books ==) The directive `suppress_warning` does not directly affect documentation and is documented together with service config validation.", "id": "Documentation", "properties": { "documentationRootUrl": { @@ -2548,7 +2548,7 @@ "type": "object" }, "HttpRule": { -"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. Example below selects a gRPC method and applies HttpRule to it. http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", +"description": "gRPC Transcoding gRPC Transcoding is a feature for mapping between a gRPC method and one or more HTTP REST endpoints. It allows developers to build a single API service that supports both gRPC APIs and REST APIs. Many systems, including [Google APIs](https://github.com/googleapis/googleapis), [Cloud Endpoints](https://cloud.google.com/endpoints), [gRPC Gateway](https://github.com/grpc-ecosystem/grpc-gateway), and [Envoy](https://github.com/envoyproxy/envoy) proxy support this feature and use it for large scale production services. `HttpRule` defines the schema of the gRPC/REST mapping. The mapping specifies how different portions of the gRPC request message are mapped to the URL path, URL query parameters, and HTTP request body. It also controls how the gRPC response message is mapped to the HTTP response body. `HttpRule` is typically specified as an `google.api.http` annotation on the gRPC method. Each mapping specifies a URL path template and an HTTP method. The path template may refer to one or more fields in the gRPC request message, as long as each field is a non-repeated field with a primitive (non-message) type. The path template controls how fields of the request message are mapped to the URL path. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/{name=messages/*}\" }; } } message GetMessageRequest { string name = 1; // Mapped to URL path. } message Message { string text = 1; // The resource content. } This enables an HTTP REST to gRPC mapping as below: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(name: \"messages/123456\")` Any fields in the request message which are not bound by the path template automatically become HTTP query parameters if there is no HTTP request body. For example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get:\"/v1/messages/{message_id}\" }; } } message GetMessageRequest { message SubMessage { string subfield = 1; } string message_id = 1; // Mapped to URL path. int64 revision = 2; // Mapped to URL query parameter `revision`. SubMessage sub = 3; // Mapped to URL query parameter `sub.subfield`. } This enables a HTTP JSON to RPC mapping as below: - HTTP: `GET /v1/messages/123456?revision=2&sub.subfield=foo` - gRPC: `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))` Note that fields which are mapped to URL query parameters must have a primitive type or a repeated primitive type or a non-repeated message type. In the case of a repeated type, the parameter can be repeated in the URL as `...?param=A¶m=B`. In the case of a message type, each field of the message is mapped to a separate parameter, such as `...?foo.a=A&foo.b=B&foo.c=C`. For HTTP methods that allow a request body, the `body` field specifies the mapping. Consider a REST update method on the message resource collection: service Messaging { rpc UpdateMessage(UpdateMessageRequest) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"message\" }; } } message UpdateMessageRequest { string message_id = 1; // mapped to the URL Message message = 2; // mapped to the body } The following HTTP JSON to RPC mapping is enabled, where the representation of the JSON in the request body is determined by protos JSON encoding: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })` The special name `*` can be used in the body mapping to define that every field not bound by the path template should be mapped to the request body. This enables the following alternative definition of the update method: service Messaging { rpc UpdateMessage(Message) returns (Message) { option (google.api.http) = { patch: \"/v1/messages/{message_id}\" body: \"*\" }; } } message Message { string message_id = 1; string text = 2; } The following HTTP JSON to RPC mapping is enabled: - HTTP: `PATCH /v1/messages/123456 { \"text\": \"Hi!\" }` - gRPC: `UpdateMessage(message_id: \"123456\" text: \"Hi!\")` Note that when using `*` in the body mapping, it is not possible to have HTTP parameters, as all fields not bound by the path end in the body. This makes this option more rarely used in practice when defining REST APIs. The common usage of `*` is in custom methods which don't use the URL at all for transferring data. It is possible to define multiple HTTP methods for one RPC by using the `additional_bindings` option. Example: service Messaging { rpc GetMessage(GetMessageRequest) returns (Message) { option (google.api.http) = { get: \"/v1/messages/{message_id}\" additional_bindings { get: \"/v1/users/{user_id}/messages/{message_id}\" } }; } } message GetMessageRequest { string message_id = 1; string user_id = 2; } This enables the following two alternative HTTP JSON to RPC mappings: - HTTP: `GET /v1/messages/123456` - gRPC: `GetMessage(message_id: \"123456\")` - HTTP: `GET /v1/users/me/messages/123456` - gRPC: `GetMessage(user_id: \"me\" message_id: \"123456\")` Rules for HTTP mapping 1. Leaf request fields (recursive expansion nested messages in the request message) are classified into three categories: - Fields referred by the path template. They are passed via the URL path. - Fields referred by the HttpRule.body. They are passed via the HTTP request body. - All other fields are passed via the URL query parameters, and the parameter name is the field path in the request message. A repeated field can be represented as multiple query parameters under the same name. 2. If HttpRule.body is \"*\", there is no URL query parameter, all fields are passed via URL path and HTTP request body. 3. If HttpRule.body is omitted, there is no HTTP request body, all fields are passed via URL path and URL query parameters. Path template syntax Template = \"/\" Segments [ Verb ] ; Segments = Segment { \"/\" Segment } ; Segment = \"*\" | \"**\" | LITERAL | Variable ; Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ; FieldPath = IDENT { \".\" IDENT } ; Verb = \":\" LITERAL ; The syntax `*` matches a single URL path segment. The syntax `**` matches zero or more URL path segments, which must be the last part of the URL path except the `Verb`. The syntax `Variable` matches part of the URL path as specified by its template. A variable template must not contain other variables. If a variable matches a single path segment, its template may be omitted, e.g. `{var}` is equivalent to `{var=*}`. The syntax `LITERAL` matches literal text in the URL path. If the `LITERAL` contains any reserved character, such characters should be percent-encoded before the matching. If a variable contains exactly one path segment, such as `\"{var}\"` or `\"{var=*}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{var}`. If a variable contains multiple path segments, such as `\"{var=foo/*}\"` or `\"{var=**}\"`, when such a variable is expanded into a URL path on the client side, all characters except `[-_.~/0-9a-zA-Z]` are percent-encoded. The server side does the reverse decoding, except \"%2F\" and \"%2f\" are left unchanged. Such variables show up in the [Discovery Document](https://developers.google.com/discovery/v1/reference/apis) as `{+var}`. Using gRPC API Service Configuration gRPC API Service Configuration (service config) is a configuration language for configuring a gRPC service to become a user-facing product. The service config is simply the YAML representation of the `google.api.Service` proto message. As an alternative to annotating your proto file, you can configure gRPC transcoding in your service config YAML files. You do this by specifying a `HttpRule` that maps the gRPC method to a REST endpoint, achieving the same effect as the proto annotation. This can be particularly useful if you have a proto that is reused in multiple services. Note that any transcoding specified in the service config will override any matching transcoding configuration in the proto. The following example selects a gRPC method and applies an `HttpRule` to it: http: rules: - selector: example.v1.Messaging.GetMessage get: /v1/messages/{message_id}/{sub.subfield} Special notes When gRPC Transcoding is used to map a gRPC to JSON REST endpoints, the proto to JSON conversion must follow the [proto3 specification](https://developers.google.com/protocol-buffers/docs/proto3#json). While the single segment variable follows the semantics of [RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2 Simple String Expansion, the multi segment variable **does not** follow RFC 6570 Section 3.2.3 Reserved Expansion. The reason is that the Reserved Expansion does not expand special characters like `?` and `#`, which would lead to invalid URLs. As the result, gRPC Transcoding uses a custom encoding for multi segment variables. The path variables **must not** refer to any repeated or mapped field, because client libraries are not capable of handling such variable expansion. The path variables **must not** capture the leading \"/\" character. The reason is that the most common use case \"{var}\" does not capture the leading \"/\" character. For consistency, all path variables must share the same behavior. Repeated message fields must not be mapped to URL query parameters, because no client library can support such complicated mapping. If an API needs to use a JSON array for request or response body, it can map the request or response body to a repeated field. However, some gRPC Transcoding implementations may not support this feature.", "id": "HttpRule", "properties": { "additionalBindings": { diff --git a/googleapiclient/discovery_cache/documents/sheets.v4.json b/googleapiclient/discovery_cache/documents/sheets.v4.json index 82c73538f44..af821143257 100644 --- a/googleapiclient/discovery_cache/documents/sheets.v4.json +++ b/googleapiclient/discovery_cache/documents/sheets.v4.json @@ -870,7 +870,7 @@ } } }, -"revision": "20240708", +"revision": "20240716", "rootUrl": "https://sheets.googleapis.com/", "schemas": { "AddBandingRequest": { @@ -3699,6 +3699,10 @@ "$ref": "BigQueryDataSourceSpec", "description": "A BigQueryDataSourceSpec." }, +"looker": { +"$ref": "LookerDataSourceSpec", +"description": "A LookerDatasourceSpec." +}, "parameters": { "description": "The parameters of the data source, used when querying the data source.", "items": { @@ -5123,6 +5127,25 @@ }, "type": "object" }, +"LookerDataSourceSpec": { +"description": "The specification of a Looker data source.", +"id": "LookerDataSourceSpec", +"properties": { +"explore": { +"description": "Name of a LookerML model explore.", +"type": "string" +}, +"instanceUri": { +"description": "A Looker instance URL.", +"type": "string" +}, +"model": { +"description": "Name of a LookerML model.", +"type": "string" +} +}, +"type": "object" +}, "ManualRule": { "description": "Allows you to manually organize the values in a source data column into buckets with names of your choosing. For example, a pivot table that aggregates population by state: +-------+-------------------+ | State | SUM of Population | +-------+-------------------+ | AK | 0.7 | | AL | 4.8 | | AR | 2.9 | ... +-------+-------------------+ could be turned into a pivot table that aggregates population by time zone by providing a list of groups (for example, groupName = 'Central', items = ['AL', 'AR', 'IA', ...]) to a manual group rule. Note that a similar effect could be achieved by adding a time zone column to the source data and adjusting the pivot table. +-----------+-------------------+ | Time Zone | SUM of Population | +-----------+-------------------+ | Central | 106.3 | | Eastern | 151.9 | | Mountain | 17.4 | ... +-----------+-------------------+", "id": "ManualRule", diff --git a/googleapiclient/discovery_cache/documents/spanner.v1.json b/googleapiclient/discovery_cache/documents/spanner.v1.json index 46226e4ea87..e6a551a8c8e 100644 --- a/googleapiclient/discovery_cache/documents/spanner.v1.json +++ b/googleapiclient/discovery_cache/documents/spanner.v1.json @@ -1806,6 +1806,92 @@ "resources": { "backupSchedules": { "methods": { +"create": { +"description": "Creates a new backup schedule.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules", +"httpMethod": "POST", +"id": "spanner.projects.instances.databases.backupSchedules.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"backupScheduleId": { +"description": "Required. The Id to use for the backup schedule. The `backup_schedule_id` appended to `parent` forms the full backup schedule name of the form `projects//instances//databases//backupSchedules/`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The name of the database that this backup schedule applies to.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backupSchedules", +"request": { +"$ref": "BackupSchedule" +}, +"response": { +"$ref": "BackupSchedule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, +"delete": { +"description": "Deletes a backup schedule.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}", +"httpMethod": "DELETE", +"id": "spanner.projects.instances.databases.backupSchedules.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the schedule to delete. Values are of the form `projects//instances//databases//backupSchedules/`.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, +"get": { +"description": "Gets backup schedule for the input schedule name.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}", +"httpMethod": "GET", +"id": "spanner.projects.instances.databases.backupSchedules.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the schedule to retrieve. Values are of the form `projects//instances//databases//backupSchedules/`.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "BackupSchedule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, "getIamPolicy": { "description": "Gets the access control policy for a database or backup resource. Returns an empty policy if a database or backup exists but does not have a policy set. Authorization requires `spanner.databases.getIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.getIamPolicy` permission on resource.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:getIamPolicy", @@ -1835,6 +1921,78 @@ "https://www.googleapis.com/auth/spanner.admin" ] }, +"list": { +"description": "Lists all the backup schedules for the database.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules", +"httpMethod": "GET", +"id": "spanner.projects.instances.databases.backupSchedules.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"description": "Optional. Number of backup schedules to be returned in the response. If 0 or less, defaults to the server's maximum allowed page size.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. If non-empty, `page_token` should contain a next_page_token from a previous ListBackupSchedulesResponse to the same `parent`.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Database is the parent resource whose backup schedules should be listed. Values are of the form projects//instances//databases/", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/backupSchedules", +"response": { +"$ref": "ListBackupSchedulesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, +"patch": { +"description": "Updates a backup schedule.", +"flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}", +"httpMethod": "PATCH", +"id": "spanner.projects.instances.databases.backupSchedules.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"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.", +"location": "path", +"pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/backupSchedules/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"description": "Required. A mask specifying which fields in the BackupSchedule resource should be updated. This mask is relative to the BackupSchedule resource, not to the request message. The field mask must always be specified; this prevents any future fields from being erased accidentally.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1/{+name}", +"request": { +"$ref": "BackupSchedule" +}, +"response": { +"$ref": "BackupSchedule" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/spanner.admin" +] +}, "setIamPolicy": { "description": "Sets the access control policy on a database or backup resource. Replaces any existing policy. Authorization requires `spanner.databases.setIamPolicy` permission on resource. For backups, authorization requires `spanner.backups.setIamPolicy` permission on resource.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/backupSchedules/{backupSchedulesId}:setIamPolicy", @@ -3096,7 +3254,7 @@ } } }, -"revision": "20240711", +"revision": "20240719", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "AutoscalingConfig": { @@ -3162,6 +3320,14 @@ "description": "A backup of a Cloud Spanner database.", "id": "Backup", "properties": { +"backupSchedules": { +"description": "Output only. List of backup schedule URIs that are associated with creating this backup. This is only applicable for scheduled backups, and is empty for on-demand backups. To optimize for storage, whenever possible, multiple schedules are collapsed together to create one backup. In such cases, this field captures the list of all backup schedule URIs that are associated with creating this backup. If collapsing is not done, then this field captures the single backup schedule URI associated with creating this backup.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. The time the CreateBackup request is received. If the request does not specify `version_time`, the `version_time` of the backup will be equivalent to the `create_time`.", "format": "google-datetime", @@ -3285,6 +3451,51 @@ }, "type": "object" }, +"BackupSchedule": { +"description": "BackupSchedule expresses the automated backup creation specification for a Spanner database. Next ID: 10", +"id": "BackupSchedule", +"properties": { +"encryptionConfig": { +"$ref": "CreateBackupEncryptionConfig", +"description": "Optional. The encryption configuration that will be used to encrypt the backup. If this field is not specified, the backup will use the same encryption configuration as the database." +}, +"fullBackupSpec": { +"$ref": "FullBackupSpec", +"description": "The schedule creates only full backups." +}, +"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" +}, +"retentionDuration": { +"description": "Optional. The retention duration of a backup that must be at least 6 hours and at most 366 days. The backup is eligible to be automatically deleted once the retention period has elapsed.", +"format": "google-duration", +"type": "string" +}, +"spec": { +"$ref": "BackupScheduleSpec", +"description": "Optional. The schedule specification based on which the backup creations are triggered." +}, +"updateTime": { +"description": "Output only. The timestamp at which the schedule was last updated. If the schedule has never been updated, this field contains the timestamp when the schedule was first created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"BackupScheduleSpec": { +"description": "Defines specifications of the backup schedule.", +"id": "BackupScheduleSpec", +"properties": { +"cronSpec": { +"$ref": "CrontabSpec", +"description": "Cron style schedule specification." +} +}, +"type": "object" +}, "BatchCreateSessionsRequest": { "description": "The request for BatchCreateSessions.", "id": "BatchCreateSessionsRequest", @@ -3642,6 +3853,40 @@ }, "type": "object" }, +"CreateBackupEncryptionConfig": { +"description": "Encryption configuration for the backup to create.", +"id": "CreateBackupEncryptionConfig", +"properties": { +"encryptionType": { +"description": "Required. The encryption type of the backup.", +"enum": [ +"ENCRYPTION_TYPE_UNSPECIFIED", +"USE_DATABASE_ENCRYPTION", +"GOOGLE_DEFAULT_ENCRYPTION", +"CUSTOMER_MANAGED_ENCRYPTION" +], +"enumDescriptions": [ +"Unspecified. Do not use.", +"Use the same encryption configuration as the database. This is the default option when encryption_config is empty. For example, if the database is using `Customer_Managed_Encryption`, the backup will be using the same Cloud KMS key as the database.", +"Use Google default encryption.", +"Use customer managed encryption. If specified, `kms_key_name` must contain a valid Cloud KMS key." +], +"type": "string" +}, +"kmsKeyName": { +"description": "Optional. The Cloud KMS key that will be used to protect the backup. This field should be set only when encryption_type is `CUSTOMER_MANAGED_ENCRYPTION`. Values are of the form `projects//locations//keyRings//cryptoKeys/`.", +"type": "string" +}, +"kmsKeyNames": { +"description": "Optional. Specifies the KMS configuration for the one or more keys used to protect the backup. Values are of the form `projects//locations//keyRings//cryptoKeys/`. The keys referenced by kms_key_names must fully cover all regions of the backup's instance configuration. Some examples: * For single region instance configs, specify a single regional location KMS key. * For multi-regional instance configs of type GOOGLE_MANAGED, either specify a multi-regional location KMS key or multiple regional location KMS keys that cover all regions in the instance config. * For an instance config of type USER_MANAGED, please specify only regional location KMS keys to cover each region in the instance config. Multi-regional location KMS keys are not supported for USER_MANAGED instance configs.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "CreateBackupMetadata": { "description": "Metadata type for the operation returned by CreateBackup.", "id": "CreateBackupMetadata", @@ -3864,6 +4109,28 @@ }, "type": "object" }, +"CrontabSpec": { +"description": "CrontabSpec can be used to specify the version time and frequency at which the backup should be created.", +"id": "CrontabSpec", +"properties": { +"creationWindow": { +"description": "Output only. Schedule backups will contain an externally consistent copy of the database at the version time specified in `schedule_spec.cron_spec`. However, Spanner may not initiate the creation of the scheduled backups at that version time. Spanner will initiate the creation of scheduled backups within the time window bounded by the version_time specified in `schedule_spec.cron_spec` and version_time + `creation_window`.", +"format": "google-duration", +"readOnly": true, +"type": "string" +}, +"text": { +"description": "Required. Textual representation of the crontab. User can customize the backup frequency and the backup version time using the cron expression. The version time must be in UTC timzeone. The backup will contain an externally consistent copy of the database at the version time. Allowed frequencies are 12 hour, 1 day, 1 week and 1 month. Examples of valid cron specifications: * `0 2/12 * * * ` : every 12 hours at (2, 14) hours past midnight in UTC. * `0 2,14 * * * ` : every 12 hours at (2,14) hours past midnight in UTC. * `0 2 * * * ` : once a day at 2 past midnight in UTC. * `0 2 * * 0 ` : once a week every Sunday at 2 past midnight in UTC. * `0 2 8 * * ` : once a month on 8th day at 2 past midnight in UTC.", +"type": "string" +}, +"timeZone": { +"description": "Output only. The time zone of the times in `CrontabSpec.text`. Currently only UTC is supported.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "Database": { "description": "A Cloud Spanner database.", "id": "Database", @@ -4347,6 +4614,12 @@ }, "type": "object" }, +"FullBackupSpec": { +"description": "The specification for full backups. A full backup stores the entire contents of the database at a given version time.", +"id": "FullBackupSpec", +"properties": {}, +"type": "object" +}, "GetDatabaseDdlResponse": { "description": "The response for GetDatabaseDdl.", "id": "GetDatabaseDdlResponse", @@ -4925,6 +5198,24 @@ }, "type": "object" }, +"ListBackupSchedulesResponse": { +"description": "The response for ListBackupSchedules.", +"id": "ListBackupSchedulesResponse", +"properties": { +"backupSchedules": { +"description": "The list of backup schedules for a database.", +"items": { +"$ref": "BackupSchedule" +}, +"type": "array" +}, +"nextPageToken": { +"description": "`next_page_token` can be sent in a subsequent ListBackupSchedules call to fetch more of the schedules.", +"type": "string" +} +}, +"type": "object" +}, "ListBackupsResponse": { "description": "The response for ListBackups.", "id": "ListBackupsResponse", diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index a687fd07d88..24837b3673f 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -644,7 +644,7 @@ ] }, "addServerCa": { -"description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", +"description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.", "flatPath": "v1/projects/{project}/instances/{instance}/addServerCa", "httpMethod": "POST", "id": "sql.instances.addServerCa", @@ -1287,7 +1287,7 @@ ] }, "rotateServerCa": { -"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.", +"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.", "flatPath": "v1/projects/{project}/instances/{instance}/rotateServerCa", "httpMethod": "POST", "id": "sql.instances.rotateServerCa", @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240622", +"revision": "20240711", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2915,6 +2915,20 @@ false "serverCaCert": { "$ref": "SslCert", "description": "SSL configuration." +}, +"serverCaMode": { +"description": "Specify what type of CA is used for the server certificate.", +"enum": [ +"CA_MODE_UNSPECIFIED", +"GOOGLE_MANAGED_INTERNAL_CA", +"GOOGLE_MANAGED_CAS_CA" +], +"enumDescriptions": [ +"CA mode is unknown.", +"Google-managed self-signed internal CA.", +"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." +], +"type": "string" } }, "type": "object" @@ -3415,6 +3429,10 @@ true }, "type": "array" }, +"switchTransactionLogsToCloudStorageEnabled": { +"description": "Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.", +"type": "boolean" +}, "upgradableDatabaseVersions": { "description": "Output only. All database versions that are available for upgrade.", "items": { @@ -4490,6 +4508,20 @@ false "description": "Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the `require_ssl` flag.", "type": "boolean" }, +"serverCaMode": { +"description": "Specify what type of CA is used for the server certificate.", +"enum": [ +"CA_MODE_UNSPECIFIED", +"GOOGLE_MANAGED_INTERNAL_CA", +"GOOGLE_MANAGED_CAS_CA" +], +"enumDescriptions": [ +"CA mode is unknown.", +"Google-managed self-signed internal CA.", +"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." +], +"type": "string" +}, "sslMode": { "description": "Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.", "enum": [ @@ -4807,7 +4839,8 @@ false "RECONFIGURE_OLD_PRIMARY", "CLUSTER_MAINTENANCE", "SELF_SERVICE_MAINTENANCE", -"SWITCHOVER_TO_REPLICA" +"SWITCHOVER_TO_REPLICA", +"MAJOR_VERSION_UPGRADE" ], "enumDeprecated": [ false, @@ -4854,6 +4887,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4901,7 +4935,8 @@ false "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", "Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", -"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance." +"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.", +"Updates the major version of a Cloud SQL instance." ], "type": "string" }, @@ -5579,7 +5614,8 @@ true "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", "PG_CRON_FLAG_ENABLED_IN_REPLICA", -"EXTENSIONS_NOT_ENABLED_IN_REPLICA" +"EXTENSIONS_NOT_ENABLED_IN_REPLICA", +"UNSUPPORTED_COLUMNS" ], "enumDescriptions": [ "", @@ -5630,7 +5666,8 @@ true "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", "The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", -"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." +"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", +"The source database has generated columns that can't be migrated. Please change them to regular columns before migration." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json index 4ca895ae430..acc6d6950ac 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1beta4.json @@ -644,7 +644,7 @@ ] }, "addServerCa": { -"description": "Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in.", +"description": "Add a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use AddServerCertificate to add a new server certificate.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/addServerCa", "httpMethod": "POST", "id": "sql.instances.addServerCa", @@ -1287,7 +1287,7 @@ ] }, "rotateServerCa": { -"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method.", +"description": "Rotates the server certificate to one signed by the Certificate Authority (CA) version previously added with the addServerCA method. For instances that have enabled Certificate Authority Service (CAS) based server CA, please use RotateServerCertificate to rotate the server certificate.", "flatPath": "sql/v1beta4/projects/{project}/instances/{instance}/rotateServerCa", "httpMethod": "POST", "id": "sql.instances.rotateServerCa", @@ -2267,7 +2267,7 @@ } } }, -"revision": "20240622", +"revision": "20240711", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -2915,6 +2915,20 @@ false "serverCaCert": { "$ref": "SslCert", "description": "SSL configuration." +}, +"serverCaMode": { +"description": "Specify what type of CA is used for the server certificate.", +"enum": [ +"CA_MODE_UNSPECIFIED", +"GOOGLE_MANAGED_INTERNAL_CA", +"GOOGLE_MANAGED_CAS_CA" +], +"enumDescriptions": [ +"CA mode is unknown.", +"Google-managed self-signed internal CA.", +"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." +], +"type": "string" } }, "type": "object" @@ -3416,6 +3430,10 @@ true }, "type": "array" }, +"switchTransactionLogsToCloudStorageEnabled": { +"description": "Input only. Whether Cloud SQL is enabled to switch storing point-in-time recovery log files from a data disk to Cloud Storage.", +"type": "boolean" +}, "upgradableDatabaseVersions": { "description": "Output only. All database versions that are available for upgrade.", "items": { @@ -4491,6 +4509,20 @@ false "description": "Use `ssl_mode` instead. Whether SSL/TLS connections over IP are enforced. If set to false, then allow both non-SSL/non-TLS and SSL/TLS connections. For SSL/TLS connections, the client certificate won't be verified. If set to true, then only allow connections encrypted with SSL/TLS and with valid client certificates. If you want to enforce SSL/TLS without enforcing the requirement for valid client certificates, then use the `ssl_mode` flag instead of the legacy `require_ssl` flag.", "type": "boolean" }, +"serverCaMode": { +"description": "Specify what type of CA is used for the server certificate.", +"enum": [ +"CA_MODE_UNSPECIFIED", +"GOOGLE_MANAGED_INTERNAL_CA", +"GOOGLE_MANAGED_CAS_CA" +], +"enumDescriptions": [ +"CA mode is unknown.", +"Google-managed self-signed internal CA.", +"Google-managed regional CA part of root CA hierarchy hosted on Google Cloud's Certificate Authority Service (CAS)." +], +"type": "string" +}, "sslMode": { "description": "Specify how SSL/TLS is enforced in database connections. If you must use the `require_ssl` flag for backward compatibility, then only the following value pairs are valid: For PostgreSQL and MySQL: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false` * `ssl_mode=TRUSTED_CLIENT_CERTIFICATE_REQUIRED` and `require_ssl=true` For SQL Server: * `ssl_mode=ALLOW_UNENCRYPTED_AND_ENCRYPTED` and `require_ssl=false` * `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=true` The value of `ssl_mode` has priority over the value of `require_ssl`. For example, for the pair `ssl_mode=ENCRYPTED_ONLY` and `require_ssl=false`, `ssl_mode=ENCRYPTED_ONLY` means accept only SSL connections, while `require_ssl=false` means accept both non-SSL and SSL connections. In this case, MySQL and PostgreSQL databases respect `ssl_mode` and accepts only SSL connections.", "enum": [ @@ -4808,7 +4840,8 @@ false "RECONFIGURE_OLD_PRIMARY", "CLUSTER_MAINTENANCE", "SELF_SERVICE_MAINTENANCE", -"SWITCHOVER_TO_REPLICA" +"SWITCHOVER_TO_REPLICA", +"MAJOR_VERSION_UPGRADE" ], "enumDeprecated": [ false, @@ -4855,6 +4888,7 @@ false, false, false, false, +false, false ], "enumDescriptions": [ @@ -4902,7 +4936,8 @@ false "Reconfigures old primary after a promote replica operation. Effect of a promote operation to the old primary is executed in this operation, asynchronously from the promote replica operation executed to the replica.", "Indicates that the instance, its read replicas, and its cascading replicas are in maintenance. Maintenance typically gets initiated on groups of replicas first, followed by the primary instance. For each instance, maintenance typically causes the instance to be unavailable for 1-3 minutes.", "Indicates that the instance (and any of its replicas) are currently in maintenance. This is initiated as a self-service request by using SSM. Maintenance typically causes the instance to be unavailable for 1-3 minutes.", -"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance." +"Switches a primary instance to a replica. This operation runs as part of a switchover operation to the original primary instance.", +"Updates the major version of a Cloud SQL instance." ], "type": "string" }, @@ -5580,7 +5615,8 @@ true "UNSUPPORTED_EXTENSIONS_NOT_MIGRATED", "EXTENSIONS_NOT_MIGRATED", "PG_CRON_FLAG_ENABLED_IN_REPLICA", -"EXTENSIONS_NOT_ENABLED_IN_REPLICA" +"EXTENSIONS_NOT_ENABLED_IN_REPLICA", +"UNSUPPORTED_COLUMNS" ], "enumDescriptions": [ "", @@ -5631,7 +5667,8 @@ true "The warning message indicates the unsupported extensions will not be migrated to the destination.", "The warning message indicates the pg_cron extension and settings will not be migrated to the destination.", "The error message indicates that pg_cron flags are enabled on the destination which is not supported during the migration.", -"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance." +"This error message indicates that the specified extensions are not enabled on destination instance. For example, before you can migrate data to the destination instance, you must enable the PGAudit extension on the instance.", +"The source database has generated columns that can't be migrated. Please change them to regular columns before migration." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/translate.v3.json b/googleapiclient/discovery_cache/documents/translate.v3.json index 70e8060f012..57fae60cd57 100644 --- a/googleapiclient/discovery_cache/documents/translate.v3.json +++ b/googleapiclient/discovery_cache/documents/translate.v3.json @@ -1260,7 +1260,8 @@ "$ref": "Operation" }, "scopes": [ -"https://www.googleapis.com/auth/cloud-platform" +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-translation" ] } }, @@ -1395,7 +1396,7 @@ ], "parameters": { "name": { -"description": "Required. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", +"description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/glossaries/[^/]+/glossaryEntries/[^/]+$", "required": true, @@ -1706,7 +1707,7 @@ } } }, -"revision": "20240301", +"revision": "20240718", "rootUrl": "https://translation.googleapis.com/", "schemas": { "AdaptiveMtDataset": { @@ -1817,7 +1818,7 @@ "id": "AdaptiveMtTranslateRequest", "properties": { "content": { -"description": "Required. The content of the input in string format. For now only one sentence per request is supported.", +"description": "Required. The content of the input in string format.", "items": { "type": "string" }, @@ -1826,6 +1827,14 @@ "dataset": { "description": "Required. The resource name for the dataset to use for adaptive MT. `projects/{project}/locations/{location-id}/adaptiveMtDatasets/{dataset}`", "type": "string" +}, +"glossaryConfig": { +"$ref": "TranslateTextGlossaryConfig", +"description": "Optional. Glossary to be applied. The glossary must be within the same region (have the same location-id) as the model, otherwise an INVALID_ARGUMENT (400) error is returned." +}, +"referenceSentenceConfig": { +"$ref": "ReferenceSentenceConfig", +"description": "Configuration for caller provided reference sentences." } }, "type": "object" @@ -1834,6 +1843,13 @@ "description": "An AdaptiveMtTranslate response.", "id": "AdaptiveMtTranslateResponse", "properties": { +"glossaryTranslations": { +"description": "Text translation response if a glossary is provided in the request. This could be the same as 'translation' above if no terms apply.", +"items": { +"$ref": "AdaptiveMtTranslation" +}, +"type": "array" +}, "languageCode": { "description": "Output only. The translation's language code.", "readOnly": true, @@ -2360,7 +2376,7 @@ "type": "string" }, "name": { -"description": "Required. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", +"description": "Identifier. The resource name of the entry. Format: \"projects/*/locations/*/glossaries/*/glossaryEntries/*\"", "type": "string" }, "termsPair": { @@ -2848,6 +2864,57 @@ }, "type": "object" }, +"ReferenceSentenceConfig": { +"description": "Message of caller-provided reference configuration.", +"id": "ReferenceSentenceConfig", +"properties": { +"referenceSentencePairLists": { +"description": "Reference sentences pair lists. Each list will be used as the references to translate the sentence under \"content\" field at the corresponding index. Length of the list is required to be equal to the length of \"content\" field.", +"items": { +"$ref": "ReferenceSentencePairList" +}, +"type": "array" +}, +"sourceLanguageCode": { +"description": "Source language code.", +"type": "string" +}, +"targetLanguageCode": { +"description": "Target language code.", +"type": "string" +} +}, +"type": "object" +}, +"ReferenceSentencePair": { +"description": "A pair of sentences used as reference in source and target languages.", +"id": "ReferenceSentencePair", +"properties": { +"sourceSentence": { +"description": "Source sentence in the sentence pair.", +"type": "string" +}, +"targetSentence": { +"description": "Target sentence in the sentence pair.", +"type": "string" +} +}, +"type": "object" +}, +"ReferenceSentencePairList": { +"description": "A list of reference sentence pairs.", +"id": "ReferenceSentencePairList", +"properties": { +"referenceSentencePairs": { +"description": "Reference sentence pairs.", +"items": { +"$ref": "ReferenceSentencePair" +}, +"type": "array" +} +}, +"type": "object" +}, "Romanization": { "description": "A single romanization response.", "id": "Romanization", @@ -3078,7 +3145,7 @@ "type": "string" }, "model": { -"description": "Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used", +"description": "Optional. The `model` type requested for this translation. The format depends on model type: - AutoML Translation models: `projects/{project-number-or-id}/locations/{location-id}/models/{model-id}` - General (built-in) models: `projects/{project-number-or-id}/locations/{location-id}/models/general/nmt`, - Translation LLM models: `projects/{project-number-or-id}/locations/{location-id}/models/general/translation-llm`, For global (non-regionalized) requests, use `location-id` `global`. For example, `projects/{project-number-or-id}/locations/global/models/general/nmt`. If not provided, the default Google model (NMT) will be used", "type": "string" }, "sourceLanguageCode": { diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1.json index 07fa8a94517..4473bd21aca 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1.json @@ -2280,7 +2280,7 @@ } } }, -"revision": "20240704", +"revision": "20240712", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4056,6 +4056,10 @@ "$ref": "Encryption", "description": "Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine." }, +"machineImageTargetDefaults": { +"$ref": "MachineImageTargetDetails", +"description": "Immutable. Target details for importing a machine image, will be used by ImageImportJob." +}, "name": { "description": "Output only. The resource path of the ImageImport.", "readOnly": true, @@ -4114,6 +4118,11 @@ "readOnly": true, "type": "array" }, +"machineImageTargetDetails": { +"$ref": "MachineImageTargetDetails", +"description": "Output only. Target details used to import a machine image.", +"readOnly": true +}, "name": { "description": "Output only. The resource path of the ImageImportJob.", "readOnly": true, @@ -4653,6 +4662,92 @@ }, "type": "object" }, +"MachineImageParametersOverrides": { +"description": "Parameters overriding decisions based on the source machine image configurations.", +"id": "MachineImageParametersOverrides", +"properties": { +"machineType": { +"description": "Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource.", +"type": "string" +} +}, +"type": "object" +}, +"MachineImageTargetDetails": { +"description": "The target details of the machine image resource that will be created by the image import job.", +"id": "MachineImageTargetDetails", +"properties": { +"additionalLicenses": { +"description": "Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", +"items": { +"type": "string" +}, +"type": "array" +}, +"description": { +"description": "Optional. An optional description of the machine image.", +"type": "string" +}, +"encryption": { +"$ref": "Encryption", +"description": "Immutable. The encryption to apply to the machine image." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels to apply to the instance created by the machine image.", +"type": "object" +}, +"machineImageName": { +"description": "Required. The name of the machine image to be created.", +"type": "string" +}, +"machineImageParametersOverrides": { +"$ref": "MachineImageParametersOverrides", +"description": "Optional. Parameters overriding decisions based on the source machine image configurations." +}, +"networkInterfaces": { +"description": "Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import.", +"items": { +"$ref": "NetworkInterface" +}, +"type": "array" +}, +"osAdaptationParameters": { +"$ref": "ImageImportOsAdaptationParameters", +"description": "Optional. Use to set the parameters relevant for the OS adaptation process." +}, +"serviceAccount": { +"$ref": "ServiceAccount", +"description": "Optional. The service account to assign to the instance created by the machine image." +}, +"shieldedInstanceConfig": { +"$ref": "ShieldedInstanceConfig", +"description": "Optional. Shielded instance configuration." +}, +"singleRegionStorage": { +"description": "Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected.", +"type": "boolean" +}, +"skipOsAdaptation": { +"$ref": "SkipOsAdaptation", +"description": "Optional. Use to skip OS adaptation process." +}, +"tags": { +"description": "Optional. The tags to apply to the instance created by the machine image.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetProject": { +"description": "Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created.", +"type": "string" +} +}, +"type": "object" +}, "MigratingVm": { "description": "MigratingVm describes the VM that will be migrated from a Source environment and its replication state.", "id": "MigratingVm", @@ -4945,6 +5040,20 @@ "description": "The network to connect the NIC to.", "type": "string" }, +"networkTier": { +"description": "Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM.", +"enum": [ +"COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED", +"NETWORK_TIER_STANDARD", +"NETWORK_TIER_PREMIUM" +], +"enumDescriptions": [ +"An unspecified network tier. Will be used as PREMIUM.", +"A standard network tier.", +"A premium network tier." +], +"type": "string" +}, "subnetwork": { "description": "Optional. The subnetwork to connect the NIC to.", "type": "string" @@ -5342,12 +5451,65 @@ }, "type": "object" }, +"ServiceAccount": { +"description": "Service account to assign to the instance created by the machine image.", +"id": "ServiceAccount", +"properties": { +"email": { +"description": "Required. The email address of the service account.", +"type": "string" +}, +"scopes": { +"description": "Optional. The list of scopes to be made available for this service account.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ShieldedInstanceConfig": { +"description": "Shielded instance configuration.", +"id": "ShieldedInstanceConfig", +"properties": { +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI.", +"type": "boolean" +}, +"secureBoot": { +"description": "Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI.", +"enum": [ +"SECURE_BOOT_UNSPECIFIED", +"TRUE", +"FALSE" +], +"enumDescriptions": [ +"No explicit value is selected. Will use the configuration of the source (if exists, otherwise the default will be false).", +"Use secure boot. This can be set to true only if the image boot option is EFI.", +"Do not use secure boot." +], +"type": "string" +} +}, +"type": "object" +}, "ShuttingDownSourceVMStep": { "description": "ShuttingDownSourceVMStep contains specific step details.", "id": "ShuttingDownSourceVMStep", "properties": {}, "type": "object" }, +"SkipOsAdaptation": { +"description": "Mentions that the machine image import is not using OS adaptation process.", +"id": "SkipOsAdaptation", +"properties": {}, +"type": "object" +}, "Source": { "description": "Source message describes a specific vm migration Source resource. It contains the source environment information.", "id": "Source", diff --git a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json index 405791e82e9..59fa75be3ab 100644 --- a/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/vmmigration.v1alpha1.json @@ -2280,7 +2280,7 @@ } } }, -"revision": "20240704", +"revision": "20240712", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4091,6 +4091,10 @@ "$ref": "Encryption", "description": "Immutable. The encryption details used by the image import process during the image adaptation for Compute Engine." }, +"machineImageTargetDefaults": { +"$ref": "MachineImageTargetDetails", +"description": "Immutable. Target details for importing a machine image, will be used by ImageImportJob." +}, "name": { "description": "Output only. The resource path of the ImageImport.", "readOnly": true, @@ -4149,6 +4153,11 @@ "readOnly": true, "type": "array" }, +"machineImageTargetDetails": { +"$ref": "MachineImageTargetDetails", +"description": "Output only. Target details used to import a machine image.", +"readOnly": true +}, "name": { "description": "Output only. The resource path of the ImageImportJob.", "readOnly": true, @@ -4688,6 +4697,92 @@ }, "type": "object" }, +"MachineImageParametersOverrides": { +"description": "Parameters overriding decisions based on the source machine image configurations.", +"id": "MachineImageParametersOverrides", +"properties": { +"machineType": { +"description": "Optional. The machine type to create the MachineImage with. If empty, the service will choose a relevant machine type based on the information from the source image. For more information about machine types, please refer to https://cloud.google.com/compute/docs/machine-resource.", +"type": "string" +} +}, +"type": "object" +}, +"MachineImageTargetDetails": { +"description": "The target details of the machine image resource that will be created by the image import job.", +"id": "MachineImageTargetDetails", +"properties": { +"additionalLicenses": { +"description": "Optional. Additional licenses to assign to the instance created by the machine image. Format: https://www.googleapis.com/compute/v1/projects/PROJECT_ID/global/licenses/LICENSE_NAME Or https://www.googleapis.com/compute/beta/projects/PROJECT_ID/global/licenses/LICENSE_NAME", +"items": { +"type": "string" +}, +"type": "array" +}, +"description": { +"description": "Optional. An optional description of the machine image.", +"type": "string" +}, +"encryption": { +"$ref": "Encryption", +"description": "Immutable. The encryption to apply to the machine image." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. The labels to apply to the instance created by the machine image.", +"type": "object" +}, +"machineImageName": { +"description": "Required. The name of the machine image to be created.", +"type": "string" +}, +"machineImageParametersOverrides": { +"$ref": "MachineImageParametersOverrides", +"description": "Optional. Parameters overriding decisions based on the source machine image configurations." +}, +"networkInterfaces": { +"description": "Optional. The network interfaces to create with the instance created by the machine image. Internal and external IP addresses are ignored for machine image import.", +"items": { +"$ref": "NetworkInterface" +}, +"type": "array" +}, +"osAdaptationParameters": { +"$ref": "ImageImportOsAdaptationParameters", +"description": "Optional. Use to set the parameters relevant for the OS adaptation process." +}, +"serviceAccount": { +"$ref": "ServiceAccount", +"description": "Optional. The service account to assign to the instance created by the machine image." +}, +"shieldedInstanceConfig": { +"$ref": "ShieldedInstanceConfig", +"description": "Optional. Shielded instance configuration." +}, +"singleRegionStorage": { +"description": "Optional. Set to true to set the machine image storageLocations to the single region of the import job. When false, the closest multi-region is selected.", +"type": "boolean" +}, +"skipOsAdaptation": { +"$ref": "SkipOsAdaptation", +"description": "Optional. Use to skip OS adaptation process." +}, +"tags": { +"description": "Optional. The tags to apply to the instance created by the machine image.", +"items": { +"type": "string" +}, +"type": "array" +}, +"targetProject": { +"description": "Required. Reference to the TargetProject resource that represents the target project in which the imported machine image will be created.", +"type": "string" +} +}, +"type": "object" +}, "MigratingVm": { "description": "MigratingVm describes the VM that will be migrated from a Source environment and its replication state.", "id": "MigratingVm", @@ -4990,6 +5085,20 @@ "description": "The network to connect the NIC to.", "type": "string" }, +"networkTier": { +"description": "Optional. The networking tier used for configuring network access configuration. If left empty, will default to PREMIUM.", +"enum": [ +"COMPUTE_ENGINE_NETWORK_TIER_UNSPECIFIED", +"NETWORK_TIER_STANDARD", +"NETWORK_TIER_PREMIUM" +], +"enumDescriptions": [ +"An unspecified network tier. Will be used as PREMIUM.", +"A standard network tier.", +"A premium network tier." +], +"type": "string" +}, "subnetwork": { "description": "Optional. The subnetwork to connect the NIC to.", "type": "string" @@ -5393,12 +5502,65 @@ }, "type": "object" }, +"ServiceAccount": { +"description": "Service account to assign to the instance created by the machine image.", +"id": "ServiceAccount", +"properties": { +"email": { +"description": "Required. The email address of the service account.", +"type": "string" +}, +"scopes": { +"description": "Optional. The list of scopes to be made available for this service account.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"ShieldedInstanceConfig": { +"description": "Shielded instance configuration.", +"id": "ShieldedInstanceConfig", +"properties": { +"enableIntegrityMonitoring": { +"description": "Optional. Defines whether the instance created by the machine image has integrity monitoring enabled. This can be set to true only if the image boot option is EFI, and vTPM is enabled.", +"type": "boolean" +}, +"enableVtpm": { +"description": "Optional. Defines whether the instance created by the machine image has vTPM enabled. This can be set to true only if the image boot option is EFI.", +"type": "boolean" +}, +"secureBoot": { +"description": "Optional. Defines whether the instance created by the machine image has Secure Boot enabled. This can be set to true only if the image boot option is EFI.", +"enum": [ +"SECURE_BOOT_UNSPECIFIED", +"TRUE", +"FALSE" +], +"enumDescriptions": [ +"No explicit value is selected. Will use the configuration of the source (if exists, otherwise the default will be false).", +"Use secure boot. This can be set to true only if the image boot option is EFI.", +"Do not use secure boot." +], +"type": "string" +} +}, +"type": "object" +}, "ShuttingDownSourceVMStep": { "description": "ShuttingDownSourceVMStep contains specific step details.", "id": "ShuttingDownSourceVMStep", "properties": {}, "type": "object" }, +"SkipOsAdaptation": { +"description": "Mentions that the machine image import is not using OS adaptation process.", +"id": "SkipOsAdaptation", +"properties": {}, +"type": "object" +}, "Source": { "description": "Source message describes a specific vm migration Source resource. It contains the source environment information.", "id": "Source", diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index dd026c6a9cf..1986fab15e8 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2681,7 +2681,7 @@ } } }, -"revision": "20240708", +"revision": "20240723", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -4244,6 +4244,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "seatInfo": { "$ref": "EventSeat", "description": "Seating details for this ticket." @@ -4662,15 +4666,15 @@ true "description": "Links module data. If links module data is also defined on the object, both will be displayed." }, "localBoardingDateTime": { -"description": "The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.", +"description": "The boarding time as it would be printed on the boarding pass. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.", "type": "string" }, "localEstimatedOrActualArrivalDateTime": { -"description": "The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.", +"description": "The estimated time the aircraft plans to reach the destination gate (not the runway) or the actual time it reached the gate. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already arrived at the gate. Google will use it to inform the user that the flight has arrived at the gate. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.", "type": "string" }, "localEstimatedOrActualDepartureDateTime": { -"description": "The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport. If this is not set, Google will set it based on data from other sources.", +"description": "The estimated time the aircraft plans to pull from the gate or the actual time the aircraft already pulled from the gate. Note: This is not the runway time. This field should be set if at least one of the below is true: - It differs from the scheduled time. Google will use it to calculate the delay. - The aircraft already pulled from the gate. Google will use it to inform the user when the flight actually departed. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on departure airport.", "type": "string" }, "localGateClosingDateTime": { @@ -4678,7 +4682,7 @@ true "type": "string" }, "localScheduledArrivalDateTime": { -"description": "The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport. If this is not set, Google will set it based on data from other sources.", +"description": "The scheduled time the aircraft plans to reach the destination gate (not the runway). Note: This field should not change too close to the flight time. For updates to departure times (delays, etc), please set `localEstimatedOrActualArrivalDateTime`. This is an ISO 8601 extended format date/time without an offset. Time may be specified up to millisecond precision. eg: `2027-03-05T06:30:00` This should be the local date/time at the airport (not a UTC time). Google will reject the request if UTC offset is provided. Time zones will be calculated by Google based on arrival airport.", "type": "string" }, "localScheduledDepartureDateTime": { @@ -4985,6 +4989,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "securityProgramLogo": { "$ref": "Image", "description": "An image for the security program that applies to the passenger." @@ -5339,6 +5347,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode settings/details." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" @@ -5813,6 +5825,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" @@ -6637,6 +6653,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "secondaryLoyaltyPoints": { "$ref": "LoyaltyPoints", "description": "The secondary loyalty reward points label, balance, and type. Shown in addition to the primary loyalty points." @@ -7563,6 +7583,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" @@ -8132,6 +8156,17 @@ true }, "type": "object" }, +"SaveRestrictions": { +"description": "Defines restrictions on the object that will be verified during save. Note: this is an advanced feature, please contact Google for implementation support.", +"id": "SaveRestrictions", +"properties": { +"restrictToEmailSha256": { +"description": "Restrict the save of the referencing object to the given email address only. This is the hex output of SHA256 sum of the email address, all lowercase and without any notations like \".\" or \"+\", except \"@\". For example, for example@example.com, this value will be 31c5543c1734d25c7206f5fd591525d0295bec6fe84ff82f946a34fe970a1e66 and for Example@example.com, this value will be bc34f262c93ad7122763684ccea6f07fb7f5d8a2d11e60ce15a6f43fe70ce632 If email address of the logged-in user who tries to save this pass does not match with the defined value here, users won't be allowed to save this pass. They will instead be prompted with an error to contact the issuer. This information should be gathered from the user with an explicit consent via Sign in with Google integration https://developers.google.com/identity/authentication. Please contact with support before using Save Restrictions.", +"type": "string" +} +}, +"type": "object" +}, "SecurityAnimation": { "id": "SecurityAnimation", "properties": { @@ -8994,6 +9029,10 @@ true "$ref": "RotatingBarcode", "description": "The rotating barcode type and value." }, +"saveRestrictions": { +"$ref": "SaveRestrictions", +"description": "Restrictions on the object that needs to be verified before the user tries to save the pass. Note that this restrictions will only be applied during save time. If the restrictions changed after a user saves the pass, the new restrictions will not be applied to an already saved pass." +}, "smartTapRedemptionValue": { "description": "The value that will be transmitted to a Smart Tap certified terminal over NFC for this object. The class level fields `enableSmartTap` and `redemptionIssuers` must also be set up correctly in order for the pass to support Smart Tap. Only ASCII characters are supported.", "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json index e3373cbed58..b47dd7445f0 100644 --- a/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json +++ b/googleapiclient/discovery_cache/documents/workflowexecutions.v1.json @@ -457,7 +457,7 @@ } } }, -"revision": "20240625", +"revision": "20240715", "rootUrl": "https://workflowexecutions.googleapis.com/", "schemas": { "Callback": { @@ -578,6 +578,20 @@ "description": "Output only. The error which caused the execution to finish prematurely. The value is only present if the execution's state is `FAILED` or `CANCELLED`.", "readOnly": true }, +"executionHistoryLevel": { +"description": "Optional. Describes the level of the execution history feature to apply to this execution. If not specified, the level of the execution history feature will be determined by its workflow's execution history level. If the value is different from its workflow's value, it will override the workflow's execution history level for this exeuction.", +"enum": [ +"EXECUTION_HISTORY_LEVEL_UNSPECIFIED", +"EXECUTION_HISTORY_BASIC", +"EXECUTION_HISTORY_DETAILED" +], +"enumDescriptions": [ +"The default/unset value.", +"Enable execution history basic feature for this execution.", +"Enable execution history detailed feature for this execution." +], +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" diff --git a/googleapiclient/discovery_cache/documents/workflows.v1.json b/googleapiclient/discovery_cache/documents/workflows.v1.json index d57c0eeb70c..adae901dbf5 100644 --- a/googleapiclient/discovery_cache/documents/workflows.v1.json +++ b/googleapiclient/discovery_cache/documents/workflows.v1.json @@ -485,7 +485,7 @@ } } }, -"revision": "20240619", +"revision": "20240710", "rootUrl": "https://workflows.googleapis.com/", "schemas": { "Empty": { @@ -722,7 +722,7 @@ "type": "object" }, "Workflow": { -"description": "Workflow program to be executed by Workflows.", +"description": "LINT.IfChange Workflow program to be executed by Workflows.", "id": "Workflow", "properties": { "allKmsKeys": { diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index 8c77a7140ec..9b055ec85bb 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -1195,7 +1195,7 @@ } } }, -"revision": "20240709", +"revision": "20240716", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1435,7 +1435,7 @@ "type": "boolean" }, "enableNestedVirtualization": { -"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", +"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, "machineType": { @@ -2356,7 +2356,7 @@ "type": "string" }, "enableAuditAgent": { -"description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).", +"description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", "type": "boolean" }, "encryptionKey": { diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index 8dc060a1552..b6e1f3181b5 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -1127,7 +1127,7 @@ } } }, -"revision": "20240709", +"revision": "20240716", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1233,7 +1233,7 @@ "type": "integer" }, "enableNestedVirtualization": { -"description": "Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on boost configurations with accelerators. * **Operating System**: Because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image. Defaults to false.", +"description": "Optional. Whether to enable nested virtualization on boosted Cloud Workstations VMs running using this boost configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on boost configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, "id": { @@ -1410,7 +1410,7 @@ "type": "boolean" }, "enableNestedVirtualization": { -"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. * **GPUs**: nested virtualization may not be enabled on workstation configurations with accelerators. * **Operating System**: because [Container-Optimized OS](https://cloud.google.com/compute/docs/images/os-details#container-optimized_os_cos) does not support nested virtualization, when nested virtualization is enabled, the underlying Compute Engine VM instances boot from an [Ubuntu LTS](https://cloud.google.com/compute/docs/images/os-details#ubuntu_lts) image.", +"description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, "machineType": { @@ -2051,6 +2051,14 @@ "description": "Optional. Client-specified annotations.", "type": "object" }, +"boostConfigs": { +"description": "Output only. List of available boost configuration ids that this workstation can be boosted up to", +"items": { +"$ref": "WorkstationBoostConfig" +}, +"readOnly": true, +"type": "array" +}, "createTime": { "description": "Output only. Time when this workstation was created.", "format": "google-datetime", @@ -2157,6 +2165,18 @@ }, "type": "object" }, +"WorkstationBoostConfig": { +"description": "Boost config for this workstation. This object is populated from the parent workstation config.", +"id": "WorkstationBoostConfig", +"properties": { +"id": { +"description": "Output only. Boost config id.", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "WorkstationCluster": { "description": "A workstation cluster resource in the Cloud Workstations API. Defines a group of workstations in a particular region and the VPC network they're attached to.", "id": "WorkstationCluster", @@ -2318,7 +2338,7 @@ "type": "string" }, "enableAuditAgent": { -"description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service account must also be specified that has `logging.buckets.write` permission on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging).", +"description": "Optional. Whether to enable Linux `auditd` logging on the workstation. When enabled, a service_account must also be specified that has `roles/logging.logWriter` and `roles/monitoring.metricWriter` on the project. Operating system audit logging is distinct from [Cloud Audit Logs](https://cloud.google.com/workstations/docs/audit-logging) and [Container output logging](http://cloud/workstations/docs/container-output-logging#overview). Operating system audit logs are available in the [Cloud Logging](https://cloud.google.com/logging/docs) console by querying: resource.type=\"gce_instance\" log_name:\"/logs/linux-auditd\"", "type": "boolean" }, "encryptionKey": { From 9b23021335e933c7483217e9439949eb6ece3f42 Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Thu, 25 Jul 2024 09:24:05 -0700 Subject: [PATCH 6/8] chore(main): release 2.138.0 (#2439) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- CHANGELOG.md | 98 ++++++++++++++++++++++++++++++++++++++ googleapiclient/version.py | 2 +- 2 files changed, 99 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index a37bfd71a63..46a639a7a36 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,103 @@ # Changelog +## [2.138.0](https://github.com/googleapis/google-api-python-client/compare/v2.137.0...v2.138.0) (2024-07-25) + + +### Features + +* Add support for reading apiVersion in discovery artifacts ([#2380](https://github.com/googleapis/google-api-python-client/issues/2380)) ([4192262](https://github.com/googleapis/google-api-python-client/commit/4192262a6edcffde7582051f985ef607d7486ccd)) +* **aiplatform:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/747f957e058ba26859b638cb58d4813604d2bca2 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **aiplatform:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/9523ff7565225adc678c3690b71da789ef006929 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **analyticsadmin:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/346d03880330c4a73a84d33de4772000121a06ed ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **analyticsadmin:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/642222f040c25320b0948a29c8cb1ffe7aaa12d8 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **androidpublisher:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/d8088838d4a85401ea2c6e2c4011f1738d95415a ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **androidpublisher:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f17bf425f4dff226f95d0f647e5767eecfc0afa0 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **apim:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f4f6f4c760f5ecbd785bc84dda38e43168fb6395 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **artifactregistry:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/0f44c614ec222f004f43a40901e5408376eb7817 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **artifactregistry:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/94b103b199d5c4ce07ac02f7bc9c5e4c31bc1938 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **artifactregistry:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/dbfa6d3f09b9f857e5e0eb1148396d1ebe701569 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **backupdr:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/94e533dd77c9920aaf61cf16f22843316deca6f6 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **cloudbuild:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/c7adb18aa5ffcb8177701bb260f55888d49ed370 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **cloudbuild:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/d815f693b155fa169ef626508dba7c002b1d2551 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **cloudcontrolspartner:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/49a06b974fb44620539ce66df5927125b777d471 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **cloudsearch:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/db5afffc03a78cf28175074b802e2348890b4a2a ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **composer:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/df463d0039933b07bd5434aaf577dee9ee3bee8e ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **compute:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/1b16ec82c1084d3834d4c2376f0707d1c42ab4fc ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **compute:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/1b4591acef05b112d0a8539de78720cba355701c ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **compute:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/4b4761e4d4110942b72a0a85c293dcfa4e4bb6e7 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **connectors:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/10f72a36c1a834691be4dbd52f8d37d4e4e22132 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **connectors:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/6daffd59b88155f25d4fffd4c94dfcc53dc19996 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **connectors:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/74af8403ef2bcb4a787f2d5426713a666d1f8c98 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **container:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/92f07f9106ca51dbe8fad9eefcad1a02f36e8b6a ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **content:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/187dccd6e9d0ba5d2c2d230b54ba1b8971368608 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **dialogflow:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/4511a8f51e3088a0c3ce31ebaaab9b7ce2eec769 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **dialogflow:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f95bb057d15673818e3254a1af0f4e32cad0eeee ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **discoveryengine:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/68cbf8de8b28a166cc03139c40d37a3bec9495f8 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **discoveryengine:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/b42be08a05f967124c9c65cf08b0e7f230b53978 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **discoveryengine:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ba150f23302f316a1a711970129288c71846aaa5 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **discovery:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/d80d9cd0bf6ebcc3fa8bc5ec0eef0a423c3bb139 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **displayvideo:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/53bc0c31b3a166f4950f7971d7941f4e8bb4dbb0 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **docs:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7e0a2285275f52daeb5d0f1587f44070ef46cf38 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **documentai:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/0e0445b53217eb350348f4cf1f141299397f1e99 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **essentialcontacts:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/6787614b030ac625957cdb66875df8337dabf38f ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **essentialcontacts:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/6fdb5256bda7490ab990d3601e567f80656a565b ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **file:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/9463ea6e04a11b3930109ceb8dc8044ed1e52dd4 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **file:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a15ab2a5e8d5b9c871beee867f74d796d6e73a5b ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **firebaseappdistribution:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/4ac8d11d01ee3cbc7cec7f33bf95677fed1f1879 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **firebaseappdistribution:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a25ee1c4219c51e53c9f1e2fb765fcbdbbd18396 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **firebaseml:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/18f788f8034f124173ea8f3ed0029f66039e2441 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **firestore:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7528377e42be5bf2fdfe16c9e864c3559ce2ab87 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **gkehub:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5e696b23025351c3be82c60704f8149c6addc3ab ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **gkehub:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/740ff2a6c7465794926feac8978ef584ec99d1ff ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **healthcare:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/3eab6456742fb5d3c61ce1b6043508b8e4e4e5be ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **iam:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/0b7098e661f3656a44000082d21cc2ded3c9bcc0 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **iam:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/423b0b0a3ba707fc463bd6d38a76efc7aa7acf65 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **integrations:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/2bfeb423edfe6192d6f0c8cc7b9d8320d9e92043 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **integrations:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/921a566c52f732b02ca7377a725695e5200b6633 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **logging:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/28cb98923cd3825f0273ee1bad33d46c85b43fe7 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **logging:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/b41557efc6638f2c2ddfa4a2005b82390039bd6b ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **manufacturers:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/886359d58a6971f3fc31ac5e6f1374c1e9f0c786 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **merchantapi:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/17e8f11b0ef80e3366129b74d2b8c73dfbe44754 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **merchantapi:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ae1693e179fc9f317ddf948a1396d58317ee5061 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **merchantapi:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/eca619a5691645c84789ee584d40b1752ca49b8b ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **metastore:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/649fdb02ef3dcda2a7958394e0d1761cb68e85d8 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **metastore:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/99970bb458b0b536c840d8fc877ebdf7f511936f ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **migrationcenter:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/aea73cc28f734bf25064285eedbd86efbfc57f2b ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **networkservices:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/8039bd07bbded95c1333c1118bc221ae12833a0c ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **networkservices:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f83072f9661b012d0fa903152a36fdc4ec8cc117 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **ondemandscanning:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/4ac1795cbcd77227376695f17545ef5b02793567 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **ondemandscanning:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/83553a24aad1ebe0c425acc6f6265ff913ad6639 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **playintegrity:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7e689d069fd879d7cf74e2203f41077e0700f0f0 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **playintegrity:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f05a31375b87e293841996c04fb1d97a537a88c7 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **recaptchaenterprise:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/4763dcb75a3b510496173997a2ff9493cb61a2de ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **retail:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/457f8275d3d34a4ef6e49dc703ae0cd9b6d0ffae ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **retail:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/bd8333231525112c3518fbc208adb1087a29440e ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **retail:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/e01a97afee104c9e115bb8692c404f75402b15ac ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **sheets:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/145e031a5c691e761b2ea7e47ec6785bffeedbf5 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **spanner:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/0b4779866edda58077354ac12bb5ce7e65c528ad ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **spanner:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/3308e5e5f33d0d6f425a5e14a7811c2dc48dbda8 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **spanner:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/6694eb58dfc87da5c909fe9f31a36443bd269caa ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **sqladmin:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ba212b8c76588499737a2fbbd7bfdcac9ce27671 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **sqladmin:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ef3c9b728101f16846d8bb2fbc2d26252cabba50 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **sts:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5b0969ca4df1fa82ac24e65760575640539410b3 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **sts:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a82289a44c9fe757bf81c168a5e3a9c0ec562ce2 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **translate:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/8fa1081d40f233074b9fc861c040d1bd7c0d3ae7 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **vmmigration:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5dce2c4fba203ab7a7d26e85d37023f5064212dd ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **walletobjects:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/a7863fd9a639ac124fb2223e5b8ebeca801ab21c ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **workflowexecutions:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7a87be857aeb57dd542db3ed76550351461150b0 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **workloadmanager:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/c082d29a9c2db35c9afa306768881b51d2a4776e ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **workloadmanager:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/d0ea2ac7f001240238c8b619d207fc37975789cd ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **workstations:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/5a10b67fee7f5d0424bade31870d6716496f1369 ([11b2317](https://github.com/googleapis/google-api-python-client/commit/11b23179dde21a41e94e7b8de8d82ab2d35c95b3)) +* **workstations:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/6edb73ab14740057bfd9289a92e4e62600e65ab8 ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) +* **workstations:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/e40169320a9ffc88b81b6e62c9edd837480fe591 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) + + +### Bug Fixes + +* **dataflow:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/d301ebfa182786cebe8523c0e286588079dcee75 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **dlp:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/115b54599a19319aaf3569fc715b6694a37e1b80 ([611e168](https://github.com/googleapis/google-api-python-client/commit/611e168e5117e86e96406974218b46415d0efbae)) +* **dlp:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/8182edc65b8ff34a399e6a1b471a92214fae918a ([375e439](https://github.com/googleapis/google-api-python-client/commit/375e4397b1d4894dc9f97c2e6b7113c8e00222ab)) + ## [2.137.0](https://github.com/googleapis/google-api-python-client/compare/v2.136.0...v2.137.0) (2024-07-09) diff --git a/googleapiclient/version.py b/googleapiclient/version.py index 548c7fdb6be..281bc2e9b62 100644 --- a/googleapiclient/version.py +++ b/googleapiclient/version.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "2.137.0" +__version__ = "2.138.0" From 330a3541b9850e6df370ea15b24ca1e8e901d5d5 Mon Sep 17 00:00:00 2001 From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com> Date: Tue, 30 Jul 2024 00:32:19 -0700 Subject: [PATCH 7/8] chore: Update discovery artifacts (#2454) ## Deleted keys were detected in the following stable discovery artifacts: cloudbuild v2 https://togithub.com/googleapis/google-api-python-client/commit/ad5f56d082ea3251d6da647566435d166fd6b6e7 file v1 https://togithub.com/googleapis/google-api-python-client/commit/24b685a269a6ebf5bb4d35b3fa4f92c6018eb71a ## Deleted keys were detected in the following pre-stable discovery artifacts: file v1beta1 https://togithub.com/googleapis/google-api-python-client/commit/24b685a269a6ebf5bb4d35b3fa4f92c6018eb71a merchantapi accounts_v1beta https://togithub.com/googleapis/google-api-python-client/commit/f70a393a94baccb4bb2cf534a84013371683ebdd ## Discovery Artifact Change Summary: feat(appengine): update the api https://togithub.com/googleapis/google-api-python-client/commit/17887bc99c42a827a837c887d47f76d75748de0d feat(bigquery): update the api https://togithub.com/googleapis/google-api-python-client/commit/ad010606ac5dd1b0468b25a4a66898de4e857d3b feat(bigtableadmin): update the api https://togithub.com/googleapis/google-api-python-client/commit/544d82ff49b5995208a1739d5274bfe123c59444 feat(cloudbuild): update the api https://togithub.com/googleapis/google-api-python-client/commit/ad5f56d082ea3251d6da647566435d166fd6b6e7 feat(contactcenterinsights): update the api https://togithub.com/googleapis/google-api-python-client/commit/1a732f0eb101f373e7a2ae6c91156e05fb7d65ce feat(contentwarehouse): update the api https://togithub.com/googleapis/google-api-python-client/commit/48e2b3bd0ed4dd26633d4a1c81e1f63e046514d3 feat(datamigration): update the api https://togithub.com/googleapis/google-api-python-client/commit/46af1b605a6a84847f00dd25708777f51676c3c8 feat(dataplex): update the api https://togithub.com/googleapis/google-api-python-client/commit/78f49d8b1b7929fb76834d50d6e9285dbfc05f00 feat(dialogflow): update the api https://togithub.com/googleapis/google-api-python-client/commit/7c8c3eb783538965b78d588b95e440aeb060842e feat(discovery): update the api https://togithub.com/googleapis/google-api-python-client/commit/c6a49d6d465ebb567889ad7d5e7bbaa0d59076fd feat(dlp): update the api https://togithub.com/googleapis/google-api-python-client/commit/0187753309059d672007baafdbe6033370cd8598 feat(dns): update the api https://togithub.com/googleapis/google-api-python-client/commit/7edc7a13a310904a3912aff8b30b1e491bfa76de feat(file): update the api https://togithub.com/googleapis/google-api-python-client/commit/24b685a269a6ebf5bb4d35b3fa4f92c6018eb71a feat(firebaseappdistribution): update the api https://togithub.com/googleapis/google-api-python-client/commit/29dbaafedd1cc3fe417f700e4cc883f49e6c75e4 feat(firebaseml): update the api https://togithub.com/googleapis/google-api-python-client/commit/bb97577f13ea9ad9fed314741b8971d989238cec feat(merchantapi): update the api https://togithub.com/googleapis/google-api-python-client/commit/f70a393a94baccb4bb2cf534a84013371683ebdd feat(monitoring): update the api https://togithub.com/googleapis/google-api-python-client/commit/20233307f9bd544588117cd3e044f309192cbc8b feat(networkmanagement): update the api https://togithub.com/googleapis/google-api-python-client/commit/1ed9d8d4a96aded469f9e50ce303b17df52652fb feat(networksecurity): update the api https://togithub.com/googleapis/google-api-python-client/commit/9a8591a851f4655711d87ebfaa3f9a52776059ed feat(playintegrity): update the api https://togithub.com/googleapis/google-api-python-client/commit/b1c1442954e110a4394581977d6f26b6604b3777 feat(recaptchaenterprise): update the api https://togithub.com/googleapis/google-api-python-client/commit/0e18da83fa98124bcc19f1692bacc9673d24f538 feat(walletobjects): update the api https://togithub.com/googleapis/google-api-python-client/commit/1c16a89a726c1ea26b78672c2b61aab0379209fd feat(workloadmanager): update the api https://togithub.com/googleapis/google-api-python-client/commit/20736dd7325eed4ff35c2ea69f6d21eacbe4ab86 --- ...b_v1.projects.locations.dataExchanges.html | 4 +- docs/dyn/appengine_v1.apps.services.html | 12 +- .../appengine_v1.apps.services.versions.html | 32 +- docs/dyn/appengine_v1beta.apps.services.html | 12 +- ...pengine_v1beta.apps.services.versions.html | 32 +- ....locations.repositories.packages.tags.html | 2 +- ....locations.repositories.packages.tags.html | 2 +- ....locations.repositories.packages.tags.html | 2 +- docs/dyn/bigquery_v2.datasets.html | 32 +- docs/dyn/bigquery_v2.jobs.html | 5 + ...bleadmin_v2.projects.instances.tables.html | 32 +- ..._v1.projects.locations.encryptionSpec.html | 134 +++ ...tcenterinsights_v1.projects.locations.html | 28 + ...house_v1.projects.locations.documents.html | 630 ++++++++++++ ...jects.locations.documents.referenceId.html | 270 +++++ ...n_v1.projects.locations.migrationJobs.html | 5 + docs/dyn/dataplex_v1.html | 5 + docs/dyn/dataplex_v1.organizations.html | 91 ++ ...nizations.locations.encryptionConfigs.html | 258 +++++ .../dataplex_v1.organizations.locations.html | 91 ++ ...aplex_v1.projects.locations.dataScans.html | 31 +- ..._v1.projects.locations.dataScans.jobs.html | 13 +- ...rojects.locations.entryGroups.entries.html | 296 +++--- ...lex_v1.projects.locations.entryGroups.html | 10 +- ...plex_v1.projects.locations.glossaries.html | 258 +++++ docs/dyn/dataplex_v1.projects.locations.html | 136 +-- ...ex_v1.projects.locations.metadataJobs.html | 349 +++++++ ...ocations.agents.environments.sessions.html | 35 + ...ow_v3.projects.locations.agents.flows.html | 24 + ...projects.locations.agents.flows.pages.html | 48 + ...ns.agents.flows.transitionRouteGroups.html | 6 + ...alogflow_v3.projects.locations.agents.html | 6 + ...v3.projects.locations.agents.sessions.html | 35 + ...3.projects.locations.agents.testCases.html | 124 +++ ...ts.locations.agents.testCases.results.html | 16 + ...ocations.agents.transitionRouteGroups.html | 6 + ...ojects.locations.agents.conversations.html | 76 ++ ...ocations.agents.environments.sessions.html | 47 + ...beta1.projects.locations.agents.flows.html | 24 + ...projects.locations.agents.flows.pages.html | 48 + ...ns.agents.flows.transitionRouteGroups.html | 6 + ...low_v3beta1.projects.locations.agents.html | 6 + ...a1.projects.locations.agents.sessions.html | 47 + ...1.projects.locations.agents.testCases.html | 124 +++ ...ts.locations.agents.testCases.results.html | 16 + ...beta1.projects.locations.agents.tools.html | 18 + ...ocations.agents.transitionRouteGroups.html | 6 + docs/dyn/discovery_v1.apis.html | 29 + ...2.organizations.locations.connections.html | 78 +- ...anizations.locations.discoveryConfigs.html | 6 + ...tions.locations.fileStoreDataProfiles.html | 2 + ...nizations.locations.tableDataProfiles.html | 2 + ...dlp_v2.projects.locations.connections.html | 8 +- ...2.projects.locations.discoveryConfigs.html | 6 + ...jects.locations.fileStoreDataProfiles.html | 2 + ....projects.locations.tableDataProfiles.html | 2 + docs/dyn/dns_v1.changes.html | 104 ++ docs/dyn/dns_v1.projects.html | 1 + docs/dyn/dns_v1.resourceRecordSets.html | 78 ++ docs/dyn/dns_v1.responsePolicyRules.html | 104 ++ docs/dyn/dns_v1beta2.changes.html | 152 +++ docs/dyn/dns_v1beta2.projects.html | 1 + docs/dyn/dns_v1beta2.resourceRecordSets.html | 114 +++ docs/dyn/dns_v1beta2.responsePolicyRules.html | 152 +++ docs/dyn/drive_v2.files.html | 6 +- docs/dyn/drive_v3.files.html | 6 +- docs/dyn/drive_v3.revisions.html | 4 +- .../file_v1.projects.locations.instances.html | 60 -- ..._v1beta1.projects.locations.instances.html | 60 -- ..._v1alpha.projects.apps.releases.tests.html | 224 +++- ....projects.locations.publishers.models.html | 16 + docs/dyn/index.md | 1 - ...i_accounts_v1beta.accounts.accounttax.html | 64 -- .../monitoring_v1.projects.dashboards.html | 606 ++++++++++- ...1.projects.location.prometheus.api.v1.html | 8 +- ...ects.location.prometheus.api.v1.label.html | 2 +- .../dyn/monitoring_v3.folders.timeSeries.html | 3 +- ...onitoring_v3.organizations.timeSeries.html | 3 +- .../monitoring_v3.projects.alertPolicies.html | 12 +- .../monitoring_v3.projects.timeSeries.html | 9 +- ...s.locations.serviceConnectionPolicies.html | 8 +- ...s.locations.global_.connectivityTests.html | 4 + ...s.locations.global_.connectivityTests.html | 4 + ...eta1.projects.locations.authzPolicies.html | 960 ++++++++++++++++++ ...rksecurity_v1beta1.projects.locations.html | 5 + docs/dyn/playintegrity_v1.v1.html | 12 + .../recaptchaenterprise_v1.projects.keys.html | 31 + .../dyn/run_v1.namespaces.configurations.html | 8 +- .../dyn/run_v1.namespaces.domainmappings.html | 8 +- docs/dyn/run_v1.namespaces.executions.html | 6 +- docs/dyn/run_v1.namespaces.jobs.html | 26 +- docs/dyn/run_v1.namespaces.revisions.html | 4 +- docs/dyn/run_v1.namespaces.routes.html | 4 +- docs/dyn/run_v1.namespaces.services.html | 24 +- docs/dyn/run_v1.namespaces.tasks.html | 4 +- ..._v1.projects.locations.configurations.html | 8 +- ..._v1.projects.locations.domainmappings.html | 8 +- .../run_v1.projects.locations.revisions.html | 4 +- .../dyn/run_v1.projects.locations.routes.html | 4 +- .../run_v1.projects.locations.services.html | 24 +- docs/dyn/walletobjects_v1.genericobject.html | 432 ++++++++ docs/dyn/walletobjects_v1.jwt.html | 48 + ...ects.locations.evaluations.executions.html | 6 +- .../documents/analyticshub.v1.json | 4 +- .../documents/appengine.v1.json | 20 +- .../documents/appengine.v1beta.json | 20 +- .../documents/artifactregistry.v1.json | 4 +- .../documents/artifactregistry.v1beta1.json | 4 +- .../documents/artifactregistry.v1beta2.json | 4 +- .../documents/bigquery.v2.json | 24 +- .../documents/bigtableadmin.v2.json | 14 +- .../discovery_cache/documents/chat.v1.json | 18 +- .../documents/cloudbuild.v2.json | 6 +- .../documents/contactcenterinsights.v1.json | 185 +++- .../documents/contentwarehouse.v1.json | 286 +++++- .../documents/datamigration.v1.json | 8 +- .../documents/dataplex.v1.json | 685 ++++++++++++- .../documents/dialogflow.v2.json | 10 +- .../documents/dialogflow.v2beta1.json | 10 +- .../documents/dialogflow.v3.json | 10 +- .../documents/dialogflow.v3beta1.json | 25 +- .../documents/discovery.v1.json | 49 + .../discovery_cache/documents/dlp.v2.json | 67 +- .../discovery_cache/documents/dns.v1.json | 17 +- .../documents/dns.v1beta2.json | 17 +- .../discovery_cache/documents/drive.v2.json | 6 +- .../discovery_cache/documents/drive.v3.json | 8 +- .../discovery_cache/documents/file.v1.json | 85 +- .../documents/file.v1beta1.json | 85 +- .../firebaseappdistribution.v1alpha.json | 221 +++- .../documents/firebaseml.v2beta.json | 55 +- .../merchantapi.accounts_v1beta.json | 56 +- .../documents/monitoring.v1.json | 62 +- .../documents/monitoring.v3.json | 10 +- .../documents/networkconnectivity.v1.json | 4 +- .../documents/networkmanagement.v1.json | 6 +- .../documents/networkmanagement.v1beta1.json | 6 +- .../documents/networksecurity.v1beta1.json | 539 +++++++++- .../documents/playintegrity.v1.json | 43 +- .../documents/recaptchaenterprise.v1.json | 70 +- .../discovery_cache/documents/run.v1.json | 4 +- .../documents/walletobjects.v1.json | 9 +- .../documents/workloadmanager.v1.json | 72 +- .../documents/workspaceevents.v1.json | 12 +- 144 files changed, 8943 insertions(+), 954 deletions(-) create mode 100644 docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html create mode 100644 docs/dyn/dataplex_v1.organizations.html create mode 100644 docs/dyn/dataplex_v1.organizations.locations.encryptionConfigs.html create mode 100644 docs/dyn/dataplex_v1.organizations.locations.html create mode 100644 docs/dyn/dataplex_v1.projects.locations.glossaries.html create mode 100644 docs/dyn/dataplex_v1.projects.locations.metadataJobs.html create mode 100644 docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html index b8872a9b411..24b8bd34281 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html @@ -114,7 +114,7 @@

Instance Methods

Sets the IAM policy.

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

-

Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.

+

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.

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

Returns the permissions that a caller has.

@@ -552,7 +552,7 @@

Method Details

subscribe(name, body=None, x__xgafv=None) -
Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.
+  
Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.
 
 Args:
   name: string, Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123` (required)
diff --git a/docs/dyn/appengine_v1.apps.services.html b/docs/dyn/appengine_v1.apps.services.html
index 1c690d7fcf0..0bb7c7d5c39 100644
--- a/docs/dyn/appengine_v1.apps.services.html
+++ b/docs/dyn/appengine_v1.apps.services.html
@@ -158,11 +158,11 @@ 

Method Details

"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest "a_key": "", # Properties of the object. Contains field @type with type URL. }, - "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly + "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly "labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels. "a_key": "A String", }, - "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly + "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly "networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions. "ingressTrafficAllowed": "A String", # The ingress settings for version or service. }, @@ -198,11 +198,11 @@

Method Details

"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest "a_key": "", # Properties of the object. Contains field @type with type URL. }, - "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly + "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly "labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels. "a_key": "A String", }, - "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly + "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly "networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions. "ingressTrafficAllowed": "A String", # The ingress settings for version or service. }, @@ -245,11 +245,11 @@

Method Details

"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest "a_key": "", # Properties of the object. Contains field @type with type URL. }, - "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly + "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly "labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels. "a_key": "A String", }, - "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly + "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly "networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions. "ingressTrafficAllowed": "A String", # The ingress settings for version or service. }, diff --git a/docs/dyn/appengine_v1.apps.services.versions.html b/docs/dyn/appengine_v1.apps.services.versions.html index 331b993d366..586d897c199 100644 --- a/docs/dyn/appengine_v1.apps.services.versions.html +++ b/docs/dyn/appengine_v1.apps.services.versions.html @@ -172,7 +172,7 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Time that this version was created.@OutputOnly - "createdBy": "A String", # Email address of the user who created this version.@OutputOnly + "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. @@ -194,7 +194,7 @@

Method Details

"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'. }, }, - "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly "endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. @@ -280,7 +280,7 @@

Method Details

"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends". "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. }, - "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. "A String", @@ -321,7 +321,7 @@

Method Details

"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. "servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. - "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. @@ -474,7 +474,7 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Time that this version was created.@OutputOnly - "createdBy": "A String", # Email address of the user who created this version.@OutputOnly + "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. @@ -496,7 +496,7 @@

Method Details

"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'. }, }, - "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly "endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. @@ -582,7 +582,7 @@

Method Details

"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends". "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. }, - "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. "A String", @@ -623,7 +623,7 @@

Method Details

"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. "servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. - "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. @@ -715,7 +715,7 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Time that this version was created.@OutputOnly - "createdBy": "A String", # Email address of the user who created this version.@OutputOnly + "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. @@ -737,7 +737,7 @@

Method Details

"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'. }, }, - "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly "endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. @@ -823,7 +823,7 @@

Method Details

"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends". "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. }, - "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. "A String", @@ -864,7 +864,7 @@

Method Details

"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. "servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. - "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. @@ -959,7 +959,7 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Time that this version was created.@OutputOnly - "createdBy": "A String", # Email address of the user who created this version.@OutputOnly + "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. "cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip. @@ -981,7 +981,7 @@

Method Details

"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'. }, }, - "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly "endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. @@ -1067,7 +1067,7 @@

Method Details

"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends". "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. }, - "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. "A String", @@ -1108,7 +1108,7 @@

Method Details

"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. "servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. - "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. diff --git a/docs/dyn/appengine_v1beta.apps.services.html b/docs/dyn/appengine_v1beta.apps.services.html index 234387a72ad..97ddc0d7179 100644 --- a/docs/dyn/appengine_v1beta.apps.services.html +++ b/docs/dyn/appengine_v1beta.apps.services.html @@ -163,11 +163,11 @@

Method Details

"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest "a_key": "", # Properties of the object. Contains field @type with type URL. }, - "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly + "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly "labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels. "a_key": "A String", }, - "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly + "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly "networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions. "ingressTrafficAllowed": "A String", # The ingress settings for version or service. }, @@ -203,11 +203,11 @@

Method Details

"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest "a_key": "", # Properties of the object. Contains field @type with type URL. }, - "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly + "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly "labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels. "a_key": "A String", }, - "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly + "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly "networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions. "ingressTrafficAllowed": "A String", # The ingress settings for version or service. }, @@ -250,11 +250,11 @@

Method Details

"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest "a_key": "", # Properties of the object. Contains field @type with type URL. }, - "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly + "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly "labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels. "a_key": "A String", }, - "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly + "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly "networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions. "ingressTrafficAllowed": "A String", # The ingress settings for version or service. }, diff --git a/docs/dyn/appengine_v1beta.apps.services.versions.html b/docs/dyn/appengine_v1beta.apps.services.versions.html index 1ff75a9a68d..50bde5b5b09 100644 --- a/docs/dyn/appengine_v1beta.apps.services.versions.html +++ b/docs/dyn/appengine_v1beta.apps.services.versions.html @@ -181,7 +181,7 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Time that this version was created.@OutputOnly - "createdBy": "A String", # Email address of the user who created this version.@OutputOnly + "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. "build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment. @@ -206,7 +206,7 @@

Method Details

"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'. }, }, - "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly "endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. @@ -292,7 +292,7 @@

Method Details

"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends". "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. }, - "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. "A String", @@ -333,7 +333,7 @@

Method Details

"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. "servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. - "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. @@ -500,7 +500,7 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Time that this version was created.@OutputOnly - "createdBy": "A String", # Email address of the user who created this version.@OutputOnly + "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. "build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment. @@ -525,7 +525,7 @@

Method Details

"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'. }, }, - "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly "endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. @@ -611,7 +611,7 @@

Method Details

"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends". "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. }, - "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. "A String", @@ -652,7 +652,7 @@

Method Details

"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. "servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. - "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. @@ -753,7 +753,7 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Time that this version was created.@OutputOnly - "createdBy": "A String", # Email address of the user who created this version.@OutputOnly + "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. "build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment. @@ -778,7 +778,7 @@

Method Details

"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'. }, }, - "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly "endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. @@ -864,7 +864,7 @@

Method Details

"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends". "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. }, - "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. "A String", @@ -905,7 +905,7 @@

Method Details

"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. "servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. - "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. @@ -1009,7 +1009,7 @@

Method Details

"a_key": "A String", }, "createTime": "A String", # Time that this version was created.@OutputOnly - "createdBy": "A String", # Email address of the user who created this version.@OutputOnly + "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly "defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set. "deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set. "build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment. @@ -1034,7 +1034,7 @@

Method Details

"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'. }, }, - "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly + "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly "endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app. "configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted. "disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled. @@ -1120,7 +1120,7 @@

Method Details

"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends". "instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function. }, - "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly + "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly "network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment. "forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment. "A String", @@ -1161,7 +1161,7 @@

Method Details

"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag. "servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING. "threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once. - "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly + "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly "vm": True or False, # Whether to deploy this version in a container on a virtual machine. "vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps. "egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it. 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 3cc9134b797..1521c991c93 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`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc"` --> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*"` --> tags with an ID containing "/b/". + 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`. 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.packages.tags.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html index 4b0a215dc27..1196c545954 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`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc"` --> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*"` --> tags with an ID containing "/b/". + 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`. 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.packages.tags.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html index 3863f6760ef..eb11fde56e6 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`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc"` --> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*"` --> tags with an ID containing "/b/". + 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`. 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/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html index 6a341c28e0d..c52ead555ab 100644 --- a/docs/dyn/bigquery_v2.datasets.html +++ b/docs/dyn/bigquery_v2.datasets.html @@ -144,7 +144,7 @@

Method Details

An object of the form: { # Represents a BigQuery dataset. - "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; + "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to @@ -226,7 +226,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. "storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset. - "tags": [ # Output only. Tags for the Dataset. + "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. { # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions "tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. "tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". @@ -246,7 +246,7 @@

Method Details

The object takes the form of: { # Represents a BigQuery dataset. - "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; + "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to @@ -328,7 +328,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. "storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset. - "tags": [ # Output only. Tags for the Dataset. + "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. { # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions "tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. "tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". @@ -346,7 +346,7 @@

Method Details

An object of the form: { # Represents a BigQuery dataset. - "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; + "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to @@ -428,7 +428,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. "storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset. - "tags": [ # Output only. Tags for the Dataset. + "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. { # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions "tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. "tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". @@ -506,7 +506,7 @@

Method Details

The object takes the form of: { # Represents a BigQuery dataset. - "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; + "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to @@ -588,7 +588,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. "storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset. - "tags": [ # Output only. Tags for the Dataset. + "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. { # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions "tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. "tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". @@ -606,7 +606,7 @@

Method Details

An object of the form: { # Represents a BigQuery dataset. - "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; + "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to @@ -688,7 +688,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. "storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset. - "tags": [ # Output only. Tags for the Dataset. + "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. { # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions "tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. "tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". @@ -721,7 +721,7 @@

Method Details

An object of the form: { # Represents a BigQuery dataset. - "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; + "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to @@ -803,7 +803,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. "storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset. - "tags": [ # Output only. Tags for the Dataset. + "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. { # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions "tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. "tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". @@ -824,7 +824,7 @@

Method Details

The object takes the form of: { # Represents a BigQuery dataset. - "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; + "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to @@ -906,7 +906,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. "storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset. - "tags": [ # Output only. Tags for the Dataset. + "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. { # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions "tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. "tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". @@ -924,7 +924,7 @@

Method Details

An object of the form: { # Represents a BigQuery dataset. - "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; + "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add. { # An object that defines dataset access for an entity. "dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation. "dataset": { # Identifier for a dataset. # The dataset this entry applies to @@ -1006,7 +1006,7 @@

Method Details

"satisfiesPzs": True or False, # Output only. Reserved for future use. "selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource. "storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset. - "tags": [ # Output only. Tags for the Dataset. + "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field. { # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions "tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id. "tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production". diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index 72773ff7108..b4ee3177c07 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -561,6 +561,7 @@

Method Details

"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. "dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking. }, + "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update. "endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # Statistics for an extract job. # Output only. Statistics for an extract job. "destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. @@ -1959,6 +1960,7 @@

Method Details

"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. "dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking. }, + "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update. "endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # Statistics for an extract job. # Output only. Statistics for an extract job. "destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. @@ -3433,6 +3435,7 @@

Method Details

"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. "dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking. }, + "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update. "endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # Statistics for an extract job. # Output only. Statistics for an extract job. "destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. @@ -4802,6 +4805,7 @@

Method Details

"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. "dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking. }, + "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update. "endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # Statistics for an extract job. # Output only. Statistics for an extract job. "destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. @@ -6196,6 +6200,7 @@

Method Details

"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs. "dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking. }, + "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update. "endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state. "extract": { # Statistics for an extract job. # Output only. Statistics for an extract job. "destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field. diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html index 0929888f0a9..0034491c9b0 100644 --- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html +++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html @@ -227,7 +227,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -277,6 +277,8 @@

Method Details

"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, + "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. + }, }, }, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct @@ -372,7 +374,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -422,6 +424,8 @@

Method Details

"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, + "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. + }, }, }, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct @@ -600,7 +604,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -650,6 +654,8 @@

Method Details

"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, + "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. + }, }, }, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct @@ -820,7 +826,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -870,6 +876,8 @@

Method Details

"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, + "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. + }, }, }, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct @@ -956,7 +964,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1006,6 +1014,8 @@

Method Details

"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, + "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. + }, }, }, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct @@ -1042,7 +1052,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1092,6 +1102,8 @@

Method Details

"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, + "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. + }, }, }, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct @@ -1168,7 +1180,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1218,6 +1230,8 @@

Method Details

"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, + "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. + }, }, }, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct @@ -1313,7 +1327,7 @@

Method Details

"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field. "logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out). }, - "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations + "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations "aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate "hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator. }, @@ -1363,6 +1377,8 @@

Method Details

"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types. "utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding. }, + "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`. + }, }, }, "structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html b/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html new file mode 100644 index 00000000000..f874c27c39f --- /dev/null +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html @@ -0,0 +1,134 @@ + + + +

Contact Center AI Insights API . projects . locations . encryptionSpec

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ initialize(name, body=None, x__xgafv=None) +
Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
+
+Args:
+  name: string, Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The request to initialize a location-level encryption specification.
+  "encryptionSpec": { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). # Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced.
+    "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
+    "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
+  },
+}
+
+  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/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index c702c0ed4fa..5df61e2297b 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -79,6 +79,11 @@

Instance Methods

Returns the conversations Resource.

+

+ encryptionSpec() +

+

Returns the encryptionSpec Resource.

+

insightsdata()

@@ -107,6 +112,9 @@

Instance Methods

close()

Close httplib2 connections.

+

+ getEncryptionSpec(name, x__xgafv=None)

+

Gets location-level encryption key specification.

getSettings(name, x__xgafv=None)

Gets project-level settings.

@@ -119,6 +127,26 @@

Method Details

Close httplib2 connections.
+
+ getEncryptionSpec(name, x__xgafv=None) +
Gets location-level encryption key specification.
+
+Args:
+  name: string, Required. The name of the encryption spec resource to get. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
+  "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
+  "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
+}
+
+
getSettings(name, x__xgafv=None)
Gets project-level settings.
diff --git a/docs/dyn/contentwarehouse_v1.projects.locations.documents.html b/docs/dyn/contentwarehouse_v1.projects.locations.documents.html
index dd1b23c784c..82f447a895b 100644
--- a/docs/dyn/contentwarehouse_v1.projects.locations.documents.html
+++ b/docs/dyn/contentwarehouse_v1.projects.locations.documents.html
@@ -148,7 +148,97 @@ 

Method Details

"createMask": "A String", # Field mask for creating Document fields. If mask path is empty, it means all fields are masked. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask. "document": { # Defines the structure for content warehouse document proto. # Required. The document to create. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. @@ -1152,7 +1242,97 @@

Method Details

{ # Response message for DocumentService.CreateDocument. "document": { # Defines the structure for content warehouse document proto. # Document created after executing create request. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. @@ -2579,7 +2759,97 @@

Method Details

{ # Defines the structure for content warehouse document proto. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. @@ -3706,7 +3976,97 @@

Method Details

{ # Defines the structure for content warehouse document proto. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. @@ -4678,7 +5038,97 @@

Method Details

}, "document": { # Defines the structure for content warehouse document proto. # Required. The document to update. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. @@ -5659,7 +6109,97 @@

Method Details

{ # Response message for DocumentService.UpdateDocument. "document": { # Defines the structure for content warehouse document proto. # Updated document after executing update request. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. @@ -7045,7 +7585,97 @@

Method Details

{ # Document entry with metadata inside SearchDocumentsResponse "document": { # Defines the structure for content warehouse document proto. # Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. diff --git a/docs/dyn/contentwarehouse_v1.projects.locations.documents.referenceId.html b/docs/dyn/contentwarehouse_v1.projects.locations.documents.referenceId.html index 2eb659eb969..dcd4287d570 100644 --- a/docs/dyn/contentwarehouse_v1.projects.locations.documents.referenceId.html +++ b/docs/dyn/contentwarehouse_v1.projects.locations.documents.referenceId.html @@ -154,7 +154,97 @@

Method Details

{ # Defines the structure for content warehouse document proto. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. @@ -1126,7 +1216,97 @@

Method Details

}, "document": { # Defines the structure for content warehouse document proto. # Required. The document to update. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. @@ -2107,7 +2287,97 @@

Method Details

{ # Response message for DocumentService.UpdateDocument. "document": { # Defines the structure for content warehouse document proto. # Updated document after executing update request. "cloudAiDocument": { # 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. # Document AI format to save the structured content, including OCR. + "chunkedDocument": { # Represents the chunks that the document is divided into. # Document chunked based on chunking config. + "chunks": [ # List of chunks. + { # Represents a chunk. + "chunkId": "A String", # ID of the chunk. + "content": "A String", # Text content of the chunk. + "pageFooters": [ # Page footers associated with the chunk. + { # Represents the page footer associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the footer. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Footer in text format. + }, + ], + "pageHeaders": [ # Page headers associated with the chunk. + { # Represents the page header associated with the chunk. + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the header. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "text": "A String", # Header in text format. + }, + ], + "pageSpan": { # Represents where the chunk starts and ends in the document. # Page span of the chunk. + "pageEnd": 42, # Page where chunk ends in the document. + "pageStart": 42, # Page where chunk starts in the document. + }, + "sourceBlockIds": [ # Unused. + "A String", + ], + }, + ], + }, "content": "A String", # Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64. + "documentLayout": { # Represents the parsed layout of a document as a collection of blocks that the document is divided into. # Parsed layout of the document. + "blocks": [ # List of blocks in the document. + { # Represents a block. A block could be one of the various types (text, table, list) supported. + "blockId": "A String", # ID of the block. + "listBlock": { # Represents a list type block. # Block consisting of list content/structure. + "listEntries": [ # List entries that constitute a list block. + { # Represents an entry in the list. + "blocks": [ # A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + }, + ], + "type": "A String", # Type of the list_entries (if exist). Available options are `ordered` and `unordered`. + }, + "pageSpan": { # Represents where the block starts and ends in the document. # Page span of the block. + "pageEnd": 42, # Page where block ends in the document. + "pageStart": 42, # Page where block starts in the document. + }, + "tableBlock": { # Represents a table type block. # Block consisting of table content/structure. + "bodyRows": [ # Body rows containing main table content. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + "caption": "A String", # Table caption/title. + "headerRows": [ # Header rows at the top of the table. + { # Represents a row in a table. + "cells": [ # A table row is a list of table cells. + { # Represents a cell in a table row. + "blocks": [ # A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "colSpan": 42, # How many columns this cell spans. + "rowSpan": 42, # How many rows this cell spans. + }, + ], + }, + ], + }, + "textBlock": { # Represents a text type block. # Block consisting of text content. + "blocks": [ # A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks. + # Object with schema name: GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock + ], + "text": "A String", # Text content stored in the block. + "type": "A String", # Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`. + }, + }, + ], + }, "entities": [ # A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries. { # An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location. "confidence": 3.14, # Optional. Confidence of detected Schema entity. Range `[0, 1]`. diff --git a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html index a0b02dcdae9..d043d2c775d 100644 --- a/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html +++ b/docs/dyn/datamigration_v1.projects.locations.migrationJobs.html @@ -212,6 +212,7 @@

Method Details

}, }, ], + "promoteWhenReady": True or False, # Optional. Promote databases when ready. "useDiffBackup": True or False, # Optional. Enable differential backups. }, "state": "A String", # The current migration job state. @@ -477,6 +478,7 @@

Method Details

}, }, ], + "promoteWhenReady": True or False, # Optional. Promote databases when ready. "useDiffBackup": True or False, # Optional. Enable differential backups. }, "state": "A String", # The current migration job state. @@ -624,6 +626,7 @@

Method Details

}, }, ], + "promoteWhenReady": True or False, # Optional. Promote databases when ready. "useDiffBackup": True or False, # Optional. Enable differential backups. }, "state": "A String", # The current migration job state. @@ -732,6 +735,7 @@

Method Details

}, }, ], + "promoteWhenReady": True or False, # Optional. Promote databases when ready. "useDiffBackup": True or False, # Optional. Enable differential backups. }, "state": "A String", # The current migration job state. @@ -1174,6 +1178,7 @@

Method Details

}, }, ], + "promoteWhenReady": True or False, # Optional. Promote databases when ready. "useDiffBackup": True or False, # Optional. Enable differential backups. }, "state": "A String", # The current migration job state. diff --git a/docs/dyn/dataplex_v1.html b/docs/dyn/dataplex_v1.html index bdab1d3cb00..88defc43e49 100644 --- a/docs/dyn/dataplex_v1.html +++ b/docs/dyn/dataplex_v1.html @@ -74,6 +74,11 @@

Cloud Dataplex API

Instance Methods

+

+ organizations() +

+

Returns the organizations Resource.

+

projects()

diff --git a/docs/dyn/dataplex_v1.organizations.html b/docs/dyn/dataplex_v1.organizations.html new file mode 100644 index 00000000000..6291692ce3e --- /dev/null +++ b/docs/dyn/dataplex_v1.organizations.html @@ -0,0 +1,91 @@ + + + +

Cloud Dataplex API . organizations

+

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/dataplex_v1.organizations.locations.encryptionConfigs.html b/docs/dyn/dataplex_v1.organizations.locations.encryptionConfigs.html new file mode 100644 index 00000000000..8683337a42a --- /dev/null +++ b/docs/dyn/dataplex_v1.organizations.locations.encryptionConfigs.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . organizations . locations . encryptionConfigs

+

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 conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ 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 conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "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 conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ 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/dataplex_v1.organizations.locations.html b/docs/dyn/dataplex_v1.organizations.locations.html new file mode 100644 index 00000000000..2dd62931cca --- /dev/null +++ b/docs/dyn/dataplex_v1.organizations.locations.html @@ -0,0 +1,91 @@ + + + +

Cloud Dataplex API . organizations . locations

+

Instance Methods

+

+ encryptionConfigs() +

+

Returns the encryptionConfigs Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.html index c919ec51bb4..9bc2d895b8b 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.html @@ -149,7 +149,7 @@

Method Details

"mode": "A String", # The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field. "name": "A String", # The name of the field. "profile": { # The profile information for each field type. # Profile information for the corresponding field. - "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. "doubleProfile": { # The profile information for a double type field. # Double type field information. "average": 3.14, # Average of non-null values in the scanned data. NaN, if the field has a NaN. "max": 3.14, # Maximum of non-null values in the scanned data. NaN, if the field has a NaN. @@ -174,7 +174,7 @@

Method Details

"maxLength": "A String", # Maximum length of non-null values in the scanned data. "minLength": "A String", # Minimum length of non-null values in the scanned data. }, - "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. { # Top N non-null values in the scanned data. "count": "A String", # Count of the corresponding value in the scanned data. "ratio": 3.14, # Ratio of the corresponding value in the field against the total number of rows in the scanned data. @@ -282,6 +282,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -357,6 +358,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -517,6 +519,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -566,7 +569,7 @@

Method Details

"mode": "A String", # The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field. "name": "A String", # The name of the field. "profile": { # The profile information for each field type. # Profile information for the corresponding field. - "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. "doubleProfile": { # The profile information for a double type field. # Double type field information. "average": 3.14, # Average of non-null values in the scanned data. NaN, if the field has a NaN. "max": 3.14, # Maximum of non-null values in the scanned data. NaN, if the field has a NaN. @@ -591,7 +594,7 @@

Method Details

"maxLength": "A String", # Maximum length of non-null values in the scanned data. "minLength": "A String", # Minimum length of non-null values in the scanned data. }, - "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. { # Top N non-null values in the scanned data. "count": "A String", # Count of the corresponding value in the scanned data. "ratio": 3.14, # Ratio of the corresponding value in the field against the total number of rows in the scanned data. @@ -699,6 +702,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -774,6 +778,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -899,7 +904,7 @@

Method Details

"mode": "A String", # The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field. "name": "A String", # The name of the field. "profile": { # The profile information for each field type. # Profile information for the corresponding field. - "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. "doubleProfile": { # The profile information for a double type field. # Double type field information. "average": 3.14, # Average of non-null values in the scanned data. NaN, if the field has a NaN. "max": 3.14, # Maximum of non-null values in the scanned data. NaN, if the field has a NaN. @@ -924,7 +929,7 @@

Method Details

"maxLength": "A String", # Maximum length of non-null values in the scanned data. "minLength": "A String", # Minimum length of non-null values in the scanned data. }, - "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. { # Top N non-null values in the scanned data. "count": "A String", # Count of the corresponding value in the scanned data. "ratio": 3.14, # Ratio of the corresponding value in the field against the total number of rows in the scanned data. @@ -1032,6 +1037,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -1107,6 +1113,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -1193,7 +1200,7 @@

Method Details

"mode": "A String", # The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field. "name": "A String", # The name of the field. "profile": { # The profile information for each field type. # Profile information for the corresponding field. - "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. "doubleProfile": { # The profile information for a double type field. # Double type field information. "average": 3.14, # Average of non-null values in the scanned data. NaN, if the field has a NaN. "max": 3.14, # Maximum of non-null values in the scanned data. NaN, if the field has a NaN. @@ -1218,7 +1225,7 @@

Method Details

"maxLength": "A String", # Maximum length of non-null values in the scanned data. "minLength": "A String", # Minimum length of non-null values in the scanned data. }, - "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. { # Top N non-null values in the scanned data. "count": "A String", # Count of the corresponding value in the scanned data. "ratio": 3.14, # Ratio of the corresponding value in the field against the total number of rows in the scanned data. @@ -1326,6 +1333,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -1401,6 +1409,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -1505,7 +1514,7 @@

Method Details

"mode": "A String", # The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field. "name": "A String", # The name of the field. "profile": { # The profile information for each field type. # Profile information for the corresponding field. - "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. "doubleProfile": { # The profile information for a double type field. # Double type field information. "average": 3.14, # Average of non-null values in the scanned data. NaN, if the field has a NaN. "max": 3.14, # Maximum of non-null values in the scanned data. NaN, if the field has a NaN. @@ -1530,7 +1539,7 @@

Method Details

"maxLength": "A String", # Maximum length of non-null values in the scanned data. "minLength": "A String", # Minimum length of non-null values in the scanned data. }, - "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. { # Top N non-null values in the scanned data. "count": "A String", # Count of the corresponding value in the scanned data. "ratio": 3.14, # Ratio of the corresponding value in the field against the total number of rows in the scanned data. @@ -1638,6 +1647,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -1713,6 +1723,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, diff --git a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html index 5f3cab57b4d..0dc79175bb9 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataScans.jobs.html @@ -152,6 +152,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -197,7 +198,7 @@

Method Details

"mode": "A String", # The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field. "name": "A String", # The name of the field. "profile": { # The profile information for each field type. # Profile information for the corresponding field. - "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. "doubleProfile": { # The profile information for a double type field. # Double type field information. "average": 3.14, # Average of non-null values in the scanned data. NaN, if the field has a NaN. "max": 3.14, # Maximum of non-null values in the scanned data. NaN, if the field has a NaN. @@ -222,7 +223,7 @@

Method Details

"maxLength": "A String", # Maximum length of non-null values in the scanned data. "minLength": "A String", # Minimum length of non-null values in the scanned data. }, - "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. { # Top N non-null values in the scanned data. "count": "A String", # Count of the corresponding value in the scanned data. "ratio": 3.14, # Ratio of the corresponding value in the field against the total number of rows in the scanned data. @@ -330,6 +331,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -405,6 +407,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -459,7 +462,7 @@

Method Details

"mode": "A String", # The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field. "name": "A String", # The name of the field. "profile": { # The profile information for each field type. # Profile information for the corresponding field. - "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "distinctRatio": 3.14, # Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. "doubleProfile": { # The profile information for a double type field. # Double type field information. "average": 3.14, # Average of non-null values in the scanned data. NaN, if the field has a NaN. "max": 3.14, # Maximum of non-null values in the scanned data. NaN, if the field has a NaN. @@ -484,7 +487,7 @@

Method Details

"maxLength": "A String", # Maximum length of non-null values in the scanned data. "minLength": "A String", # Minimum length of non-null values in the scanned data. }, - "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode. + "topNValues": [ # The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode. { # Top N non-null values in the scanned data. "count": "A String", # Count of the corresponding value in the scanned data. "ratio": 3.14, # Ratio of the corresponding value in the field against the total number of rows in the scanned data. @@ -592,6 +595,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, @@ -667,6 +671,7 @@

Method Details

"strictMaxEnabled": True or False, # Optional. Whether column statistic needs to be strictly lesser than ('<') the maximum, or if equality is allowed.Only relevant if a max_value has been defined. Default = false. "strictMinEnabled": True or False, # Optional. Whether column statistic needs to be strictly greater than ('>') the minimum, or if equality is allowed.Only relevant if a min_value has been defined. Default = false. }, + "suspended": True or False, # Optional. Whether the Rule is active or suspended. Default is false. "tableConditionExpectation": { # Evaluates whether the provided expression is true.The SQL expression needs to use BigQuery standard SQL syntax and should produce a scalar boolean result.Example: MIN(col1) >= 0 # Aggregate rule which evaluates whether the provided expression is true for a table. "sqlExpression": "A String", # Optional. The SQL expression. }, diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html index a117eb4cab5..bb1473f7d02 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.entries.html @@ -110,12 +110,12 @@

Method Details

body: object, The request body. The object takes the form of: -{ # An entry is a representation of a data asset which can be described by various metadata. - "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path) +{ # An entry is a representation of a data resource that can be described by various metadata. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} "a_key": { # An aspect is a single piece of metadata describing an entry. - "aspectSource": { # AspectSource contains information related to the source system of the Aspect. - "createTime": "A String", # The create time of the aspect in the source system. - "updateTime": "A String", # The update time of the aspect in the source system. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. "createTime": "A String", # Output only. The time when the Aspect was created. @@ -126,31 +126,31 @@

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. } entryId: string, Required. Entry identifier. It has to be unique within an Entry Group.Entries corresponding to Google Cloud resources use an Entry ID format based on full resource names (https://cloud.google.com/apis/design/resource_names#full_resource_name). The format is a full resource name of the resource without the prefix double slashes in the API service name part of the full resource name. This allows retrieval of entries using their associated resource name.For example, if the full resource name of a resource is //library.googleapis.com/shelves/shelf1/books/book2, then the suggested entry_id is library.googleapis.com/shelves/shelf1/books/book2.It is also suggested to follow the same convention for entries corresponding to resources from providers or systems other than Google Cloud.The maximum size of the field is 4000 characters. @@ -162,12 +162,12 @@

Method Details

Returns: An object of the form: - { # An entry is a representation of a data asset which can be described by various metadata. - "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path) + { # An entry is a representation of a data resource that can be described by various metadata. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} "a_key": { # An aspect is a single piece of metadata describing an entry. - "aspectSource": { # AspectSource contains information related to the source system of the Aspect. - "createTime": "A String", # The create time of the aspect in the source system. - "updateTime": "A String", # The update time of the aspect in the source system. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. "createTime": "A String", # Output only. The time when the Aspect was created. @@ -178,31 +178,31 @@

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }
@@ -220,12 +220,12 @@

Method Details

Returns: An object of the form: - { # An entry is a representation of a data asset which can be described by various metadata. - "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path) + { # An entry is a representation of a data resource that can be described by various metadata. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} "a_key": { # An aspect is a single piece of metadata describing an entry. - "aspectSource": { # AspectSource contains information related to the source system of the Aspect. - "createTime": "A String", # The create time of the aspect in the source system. - "updateTime": "A String", # The update time of the aspect in the source system. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. "createTime": "A String", # Output only. The time when the Aspect was created. @@ -236,31 +236,31 @@

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }
@@ -287,12 +287,12 @@

Method Details

Returns: An object of the form: - { # An entry is a representation of a data asset which can be described by various metadata. - "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path) + { # An entry is a representation of a data resource that can be described by various metadata. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} "a_key": { # An aspect is a single piece of metadata describing an entry. - "aspectSource": { # AspectSource contains information related to the source system of the Aspect. - "createTime": "A String", # The create time of the aspect in the source system. - "updateTime": "A String", # The update time of the aspect in the source system. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. "createTime": "A String", # Output only. The time when the Aspect was created. @@ -303,31 +303,31 @@

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }
@@ -350,12 +350,12 @@

Method Details

{ # List Entries response. "entries": [ # The list of entries under the given parent location. - { # An entry is a representation of a data asset which can be described by various metadata. - "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path) + { # An entry is a representation of a data resource that can be described by various metadata. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} "a_key": { # An aspect is a single piece of metadata describing an entry. - "aspectSource": { # AspectSource contains information related to the source system of the Aspect. - "createTime": "A String", # The create time of the aspect in the source system. - "updateTime": "A String", # The update time of the aspect in the source system. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. "createTime": "A String", # Output only. The time when the Aspect was created. @@ -366,31 +366,31 @@

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }, ], "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. @@ -416,16 +416,16 @@

Method Details

Updates an Entry.
 
 Args:
-  name: string, Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. (required)
+  name: string, Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. (required)
   body: object, The request body.
     The object takes the form of:
 
-{ # An entry is a representation of a data asset which can be described by various metadata.
-  "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)
+{ # An entry is a representation of a data resource that can be described by various metadata.
+  "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
     "a_key": { # An aspect is a single piece of metadata describing an entry.
-      "aspectSource": { # AspectSource contains information related to the source system of the Aspect.
-        "createTime": "A String", # The create time of the aspect in the source system.
-        "updateTime": "A String", # The update time of the aspect in the source system.
+      "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+        "createTime": "A String", # The time the aspect was created in the source system.
+        "updateTime": "A String", # The time the aspect was last updated in the source system.
       },
       "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
       "createTime": "A String", # Output only. The time when the Aspect was created.
@@ -436,31 +436,31 @@ 

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. } allowMissing: boolean, Optional. If set to true and the entry doesn't exist, the service will create it. @@ -475,12 +475,12 @@

Method Details

Returns: An object of the form: - { # An entry is a representation of a data asset which can be described by various metadata. - "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path) + { # An entry is a representation of a data resource that can be described by various metadata. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} "a_key": { # An aspect is a single piece of metadata describing an entry. - "aspectSource": { # AspectSource contains information related to the source system of the Aspect. - "createTime": "A String", # The create time of the aspect in the source system. - "updateTime": "A String", # The update time of the aspect in the source system. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. "createTime": "A String", # Output only. The time when the Aspect was created. @@ -491,31 +491,31 @@

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }
diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.html index 6b749d83fed..55d4294c5dc 100644 --- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.html +++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.html @@ -132,7 +132,7 @@

Method Details

"labels": { # Optional. User-defined labels for the EntryGroup. "a_key": "A String", }, - "name": "A String", # Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. + "name": "A String", # Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. "uid": "A String", # Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different. "updateTime": "A String", # Output only. The time when the EntryGroup was last updated. } @@ -226,7 +226,7 @@

Method Details

"labels": { # Optional. User-defined labels for the EntryGroup. "a_key": "A String", }, - "name": "A String", # Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. + "name": "A String", # Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. "uid": "A String", # Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different. "updateTime": "A String", # Output only. The time when the EntryGroup was last updated. }
@@ -308,7 +308,7 @@

Method Details

"labels": { # Optional. User-defined labels for the EntryGroup. "a_key": "A String", }, - "name": "A String", # Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. + "name": "A String", # Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. "uid": "A String", # Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different. "updateTime": "A String", # Output only. The time when the EntryGroup was last updated. }, @@ -339,7 +339,7 @@

Method Details

Updates an EntryGroup.
 
 Args:
-  name: string, Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. (required)
+  name: string, Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. (required)
   body: object, The request body.
     The object takes the form of:
 
@@ -351,7 +351,7 @@ 

Method Details

"labels": { # Optional. User-defined labels for the EntryGroup. "a_key": "A String", }, - "name": "A String", # Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. + "name": "A String", # Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. "uid": "A String", # Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different. "updateTime": "A String", # Output only. The time when the EntryGroup was last updated. } diff --git a/docs/dyn/dataplex_v1.projects.locations.glossaries.html b/docs/dyn/dataplex_v1.projects.locations.glossaries.html new file mode 100644 index 00000000000..ee78e79fada --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.glossaries.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . projects . locations . glossaries

+

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 conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ 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 conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+  },
+  "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 conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+ +
+ 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/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html index ff23ad9057c..e89f7bfd0fb 100644 --- a/docs/dyn/dataplex_v1.projects.locations.html +++ b/docs/dyn/dataplex_v1.projects.locations.html @@ -104,6 +104,11 @@

Instance Methods

Returns the entryTypes Resource.

+

+ glossaries() +

+

Returns the glossaries Resource.

+

governanceRules()

@@ -114,6 +119,11 @@

Instance Methods

Returns the lakes Resource.

+

+ metadataJobs() +

+

Returns the metadataJobs Resource.

+

operations()

@@ -246,12 +256,12 @@

Method Details

Returns: An object of the form: - { # An entry is a representation of a data asset which can be described by various metadata. - "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path) + { # An entry is a representation of a data resource that can be described by various metadata. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} "a_key": { # An aspect is a single piece of metadata describing an entry. - "aspectSource": { # AspectSource contains information related to the source system of the Aspect. - "createTime": "A String", # The create time of the aspect in the source system. - "updateTime": "A String", # The update time of the aspect in the source system. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. "createTime": "A String", # Output only. The time when the Aspect was created. @@ -262,31 +272,31 @@

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }
@@ -313,12 +323,12 @@

Method Details

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list. "results": [ # The results matching the search query. { # A single result of a SearchEntries request. - "dataplexEntry": { # An entry is a representation of a data asset which can be described by various metadata. - "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path) + "dataplexEntry": { # An entry is a representation of a data resource that can be described by various metadata. + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} "a_key": { # An aspect is a single piece of metadata describing an entry. - "aspectSource": { # AspectSource contains information related to the source system of the Aspect. - "createTime": "A String", # The create time of the aspect in the source system. - "updateTime": "A String", # The update time of the aspect in the source system. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. "createTime": "A String", # Output only. The time when the Aspect was created. @@ -329,40 +339,40 @@

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }, "linkedResource": "A String", # Linked resource name. "snippets": { # Snippets for the entry, contains HTML-style highlighting for matched tokens, will be used in UI. # Snippets. - "dataplexEntry": { # An entry is a representation of a data asset which can be described by various metadata. # Entry - "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path) + "dataplexEntry": { # An entry is a representation of a data resource that can be described by various metadata. # Entry + "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path} "a_key": { # An aspect is a single piece of metadata describing an entry. - "aspectSource": { # AspectSource contains information related to the source system of the Aspect. - "createTime": "A String", # The create time of the aspect in the source system. - "updateTime": "A String", # The update time of the aspect in the source system. + "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect. + "createTime": "A String", # The time the aspect was created in the source system. + "updateTime": "A String", # The time the aspect was last updated in the source system. }, "aspectType": "A String", # Output only. The resource name of the type used to create this Aspect. "createTime": "A String", # Output only. The time when the Aspect was created. @@ -373,31 +383,31 @@

Method Details

"updateTime": "A String", # Output only. The time when the Aspect was last updated. }, }, - "createTime": "A String", # Output only. The time when the Entry was created. - "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry. - "ancestors": [ # Immutable. The ancestors of the Entry in the source system. - { # Ancestor contains information about individual items in the hierarchy of an Entry. + "createTime": "A String", # Output only. The time when the entry was created in Dataplex. + "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry. + "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system. + { # Information about individual items in the hierarchy that is associated with the data resource. "name": "A String", # Optional. The name of the ancestor resource. "type": "A String", # Optional. The type of the ancestor resource. }, ], - "createTime": "A String", # The create time of the resource in the source system. - "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters. - "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters. + "createTime": "A String", # The time when the resource was created in the source system. + "description": "A String", # A description of the data resource. Maximum length is 2,000 characters. + "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters. "labels": { # User-defined labels. The maximum size of keys and values is 128 characters each. "a_key": "A String", }, - "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud. - "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters. - "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters. - "system": "A String", # The name of the source system. The maximum size of the field is 64 characters. - "updateTime": "A String", # The update time of the resource in the source system. + "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud. + "platform": "A String", # The platform containing the source system. Maximum length is 64 characters. + "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters. + "system": "A String", # The name of the source system. Maximum length is 64 characters. + "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time. }, - "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry. - "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters. - "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. + "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}. + "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters. + "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. "parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry. - "updateTime": "A String", # Output only. The time when the Entry was last updated. + "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex. }, }, }, diff --git a/docs/dyn/dataplex_v1.projects.locations.metadataJobs.html b/docs/dyn/dataplex_v1.projects.locations.metadataJobs.html new file mode 100644 index 00000000000..e60536aec5b --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.metadataJobs.html @@ -0,0 +1,349 @@ + + + +

Cloud Dataplex API . projects . locations . metadataJobs

+

Instance Methods

+

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

+

Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.

+

+ get(name, x__xgafv=None)

+

Gets a metadata job.

+

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

+

Lists metadata jobs.

+

+ list_next()

+

Retrieves the next page of results.

+

Method Details

+
+ cancel(name, body=None, x__xgafv=None) +
Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.
+
+Args:
+  name: string, Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Cancel metadata job request.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+
+ +
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, metadataJobId=None, x__xgafv=None) +
Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.
+
+Args:
+  parent: string, Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # A metadata job resource.
+  "createTime": "A String", # Output only. The time when the metadata job was created.
+  "importResult": { # Results from a metadata import job. # Output only. Import job result.
+    "createdEntries": "A String", # Output only. The total number of entries that were created.
+    "deletedEntries": "A String", # Output only. The total number of entries that were deleted.
+    "recreatedEntries": "A String", # Output only. The total number of entries that were recreated.
+    "unchangedEntries": "A String", # Output only. The total number of entries that were unchanged.
+    "updateTime": "A String", # Output only. The time when the status was updated.
+    "updatedEntries": "A String", # Output only. The total number of entries that were updated.
+  },
+  "importSpec": { # Job specification for a metadata import job # Import job specification.
+    "aspectSyncMode": "A String", # Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.
+    "entrySyncMode": "A String", # Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.
+    "logLevel": "A String", # Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO.
+    "scope": { # A boundary on the scope of impact that the metadata import job can have. # Required. A boundary on the scope of impact that the metadata import job can have.
+      "aspectTypes": [ # Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.
+        "A String",
+      ],
+      "entryGroups": [ # Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.
+        "A String",
+      ],
+      "entryTypes": [ # Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. The job modifies only the entries that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global.
+        "A String",
+      ],
+    },
+    "sourceCreateTime": "A String", # Optional. The time when the process that created the metadata import files began.
+    "sourceStorageUri": "A String", # Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.
+  },
+  "labels": { # Optional. User-defined labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.
+  "status": { # Metadata job status.
+    "completionPercent": 42, # Output only. Progress tracking.
+    "message": "A String", # Output only. Message relating to the progression of a metadata job.
+    "state": "A String", # Output only. State of the metadata job.
+    "updateTime": "A String", # Output only. The time when the status was updated.
+  },
+  "type": "A String",
+  "uid": "A String", # Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.
+  "updateTime": "A String", # Output only. The time when the metadata job was updated.
+}
+
+  metadataJobId: string, Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # This resource represents a long-running operation that is the result of a network API call.
+  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
+  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+      {
+        "a_key": "", # Properties of the object. Contains field @type with type URL.
+      },
+    ],
+    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+  },
+  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
+  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a metadata job.
+
+Args:
+  name: string, Required. The resource name of the metadata job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_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 metadata job resource.
+  "createTime": "A String", # Output only. The time when the metadata job was created.
+  "importResult": { # Results from a metadata import job. # Output only. Import job result.
+    "createdEntries": "A String", # Output only. The total number of entries that were created.
+    "deletedEntries": "A String", # Output only. The total number of entries that were deleted.
+    "recreatedEntries": "A String", # Output only. The total number of entries that were recreated.
+    "unchangedEntries": "A String", # Output only. The total number of entries that were unchanged.
+    "updateTime": "A String", # Output only. The time when the status was updated.
+    "updatedEntries": "A String", # Output only. The total number of entries that were updated.
+  },
+  "importSpec": { # Job specification for a metadata import job # Import job specification.
+    "aspectSyncMode": "A String", # Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.
+    "entrySyncMode": "A String", # Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.
+    "logLevel": "A String", # Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO.
+    "scope": { # A boundary on the scope of impact that the metadata import job can have. # Required. A boundary on the scope of impact that the metadata import job can have.
+      "aspectTypes": [ # Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.
+        "A String",
+      ],
+      "entryGroups": [ # Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.
+        "A String",
+      ],
+      "entryTypes": [ # Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. The job modifies only the entries that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global.
+        "A String",
+      ],
+    },
+    "sourceCreateTime": "A String", # Optional. The time when the process that created the metadata import files began.
+    "sourceStorageUri": "A String", # Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.
+  },
+  "labels": { # Optional. User-defined labels.
+    "a_key": "A String",
+  },
+  "name": "A String", # Output only. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.
+  "status": { # Metadata job status.
+    "completionPercent": 42, # Output only. Progress tracking.
+    "message": "A String", # Output only. Message relating to the progression of a metadata job.
+    "state": "A String", # Output only. State of the metadata job.
+    "updateTime": "A String", # Output only. The time when the status was updated.
+  },
+  "type": "A String",
+  "uid": "A String", # Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.
+  "updateTime": "A String", # Output only. The time when the metadata job was updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists metadata jobs.
+
+Args:
+  parent: string, Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} (required)
+  filter: string, Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"You can combine filters with AND, OR, and NOT operators.
+  orderBy: string, Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.
+  pageSize: integer, Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.
+  pageToken: string, Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # List metadata jobs response.
+  "metadataJobs": [ # Metadata jobs under the specified parent location.
+    { # A metadata job resource.
+      "createTime": "A String", # Output only. The time when the metadata job was created.
+      "importResult": { # Results from a metadata import job. # Output only. Import job result.
+        "createdEntries": "A String", # Output only. The total number of entries that were created.
+        "deletedEntries": "A String", # Output only. The total number of entries that were deleted.
+        "recreatedEntries": "A String", # Output only. The total number of entries that were recreated.
+        "unchangedEntries": "A String", # Output only. The total number of entries that were unchanged.
+        "updateTime": "A String", # Output only. The time when the status was updated.
+        "updatedEntries": "A String", # Output only. The total number of entries that were updated.
+      },
+      "importSpec": { # Job specification for a metadata import job # Import job specification.
+        "aspectSyncMode": "A String", # Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.
+        "entrySyncMode": "A String", # Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.
+        "logLevel": "A String", # Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO.
+        "scope": { # A boundary on the scope of impact that the metadata import job can have. # Required. A boundary on the scope of impact that the metadata import job can have.
+          "aspectTypes": [ # Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.
+            "A String",
+          ],
+          "entryGroups": [ # Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.
+            "A String",
+          ],
+          "entryTypes": [ # Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. The job modifies only the entries that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global.
+            "A String",
+          ],
+        },
+        "sourceCreateTime": "A String", # Optional. The time when the process that created the metadata import files began.
+        "sourceStorageUri": "A String", # Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.
+      },
+      "labels": { # Optional. User-defined labels.
+        "a_key": "A String",
+      },
+      "name": "A String", # Output only. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.
+      "status": { # Metadata job status.
+        "completionPercent": 42, # Output only. Progress tracking.
+        "message": "A String", # Output only. Message relating to the progression of a metadata job.
+        "state": "A String", # Output only. State of the metadata job.
+        "updateTime": "A String", # Output only. The time when the status was updated.
+      },
+      "type": "A String",
+      "uid": "A String", # Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.
+      "updateTime": "A String", # Output only. The time when the metadata job was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token to retrieve the next page of results. If there are no more results in the list, the value is empty.
+  "unreachableLocations": [ # Locations that the service couldn't reach.
+    "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/dialogflow_v3.projects.locations.agents.environments.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html index 9b21237cb8f..8686c0dcd1a 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.environments.sessions.html @@ -272,6 +272,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -298,6 +299,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -325,6 +327,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -480,6 +483,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -632,6 +636,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -661,6 +666,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -816,6 +822,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -983,6 +990,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1144,6 +1152,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1704,6 +1713,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1730,6 +1740,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1757,6 +1768,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1912,6 +1924,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2064,6 +2077,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2093,6 +2107,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2248,6 +2263,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2415,6 +2431,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2576,6 +2593,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3061,6 +3079,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3088,6 +3107,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3243,6 +3263,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3395,6 +3416,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3424,6 +3446,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3579,6 +3602,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3746,6 +3770,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3907,6 +3932,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4265,6 +4291,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4291,6 +4318,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4318,6 +4346,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4473,6 +4502,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4625,6 +4655,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4654,6 +4685,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4809,6 +4841,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4976,6 +5009,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5137,6 +5171,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html index 88a395ec5d5..da893b0d314 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.html @@ -153,6 +153,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -187,6 +188,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -347,6 +349,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -519,6 +522,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -680,6 +684,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -714,6 +719,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -874,6 +880,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1046,6 +1053,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1276,6 +1284,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1310,6 +1319,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1470,6 +1480,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1642,6 +1653,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1898,6 +1910,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1932,6 +1945,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2092,6 +2106,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2264,6 +2279,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2443,6 +2459,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2477,6 +2494,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2637,6 +2655,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2809,6 +2828,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2971,6 +2991,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3005,6 +3026,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3165,6 +3187,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3337,6 +3360,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, 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 a92bfda41d8..02b5238cc40 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.pages.html @@ -123,6 +123,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -150,6 +151,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -305,6 +307,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -457,6 +460,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -486,6 +490,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -641,6 +646,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -808,6 +814,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -969,6 +976,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1130,6 +1138,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1157,6 +1166,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1312,6 +1322,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1464,6 +1475,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1493,6 +1505,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1648,6 +1661,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1815,6 +1829,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1976,6 +1991,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2163,6 +2179,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2190,6 +2207,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2345,6 +2363,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2497,6 +2516,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2526,6 +2546,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2681,6 +2702,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2848,6 +2870,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3009,6 +3032,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3182,6 +3206,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3209,6 +3234,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3364,6 +3390,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3516,6 +3543,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3545,6 +3573,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3700,6 +3729,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3867,6 +3897,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4028,6 +4059,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4206,6 +4238,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4233,6 +4266,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4388,6 +4422,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4540,6 +4575,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4569,6 +4605,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4724,6 +4761,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4891,6 +4929,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5052,6 +5091,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5214,6 +5254,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5241,6 +5282,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5396,6 +5438,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5548,6 +5591,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5577,6 +5621,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5732,6 +5777,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5899,6 +5945,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6060,6 +6107,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, 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 3eaeaa77c6c..62bceffd84f 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.flows.transitionRouteGroups.html @@ -134,6 +134,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -306,6 +307,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -504,6 +506,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -688,6 +691,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -877,6 +881,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1050,6 +1055,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.html b/docs/dyn/dialogflow_v3.projects.locations.agents.html index c3a58cc1362..b770025a9a3 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.html @@ -191,6 +191,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -282,6 +283,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -447,6 +449,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -638,6 +641,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -748,6 +752,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -840,6 +845,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html index f2442a1d2ed..30d6b4b09d7 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.sessions.html @@ -275,6 +275,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -301,6 +302,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -328,6 +330,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -483,6 +486,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -635,6 +639,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -664,6 +669,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -819,6 +825,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -986,6 +993,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1147,6 +1155,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1707,6 +1716,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1733,6 +1743,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1760,6 +1771,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1915,6 +1927,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2067,6 +2080,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2096,6 +2110,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2251,6 +2266,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2418,6 +2434,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2579,6 +2596,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3064,6 +3082,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3091,6 +3110,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3246,6 +3266,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3398,6 +3419,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3427,6 +3449,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3582,6 +3605,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3749,6 +3773,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3910,6 +3935,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4268,6 +4294,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4294,6 +4321,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4321,6 +4349,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4476,6 +4505,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4628,6 +4658,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4657,6 +4688,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4812,6 +4844,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4979,6 +5012,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5140,6 +5174,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html index 233cef3cda8..46a77e55ccb 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.html @@ -248,6 +248,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -409,6 +410,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -574,6 +576,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -725,6 +728,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -759,6 +763,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -919,6 +924,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1091,6 +1097,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1242,6 +1249,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1269,6 +1277,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1424,6 +1433,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1576,6 +1586,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1605,6 +1616,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1760,6 +1772,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1927,6 +1940,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2088,6 +2102,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2241,6 +2256,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2275,6 +2291,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2435,6 +2452,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2607,6 +2625,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2758,6 +2777,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2785,6 +2805,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2940,6 +2961,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3092,6 +3114,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3121,6 +3144,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3276,6 +3300,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3443,6 +3468,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3604,6 +3630,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3763,6 +3790,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3981,6 +4009,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4008,6 +4037,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4163,6 +4193,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4315,6 +4346,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4344,6 +4376,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4499,6 +4532,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4666,6 +4700,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4827,6 +4862,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5095,6 +5131,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5122,6 +5159,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5277,6 +5315,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5429,6 +5468,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5458,6 +5498,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5613,6 +5654,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5780,6 +5822,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5941,6 +5984,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6220,6 +6264,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6247,6 +6292,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6402,6 +6448,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6554,6 +6601,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6583,6 +6631,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6738,6 +6787,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6905,6 +6955,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7066,6 +7117,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7334,6 +7386,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7361,6 +7414,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7516,6 +7570,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7668,6 +7723,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7697,6 +7753,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7852,6 +7909,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8019,6 +8077,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8180,6 +8239,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8510,6 +8570,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8537,6 +8598,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8692,6 +8754,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8844,6 +8907,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8873,6 +8937,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9028,6 +9093,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9195,6 +9261,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9356,6 +9423,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9624,6 +9692,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9651,6 +9720,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9806,6 +9876,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9958,6 +10029,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9987,6 +10059,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10142,6 +10215,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10309,6 +10383,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10470,6 +10545,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10809,6 +10885,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10836,6 +10913,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10991,6 +11069,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11143,6 +11222,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11172,6 +11252,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11327,6 +11408,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11494,6 +11576,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11655,6 +11738,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11923,6 +12007,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11950,6 +12035,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12105,6 +12191,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12257,6 +12344,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12286,6 +12374,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12441,6 +12530,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12608,6 +12698,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12769,6 +12860,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13066,6 +13158,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13093,6 +13186,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13248,6 +13342,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13400,6 +13495,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13429,6 +13525,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13584,6 +13681,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13751,6 +13849,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13912,6 +14011,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14180,6 +14280,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14207,6 +14308,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14362,6 +14464,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14514,6 +14617,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14543,6 +14647,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14698,6 +14803,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14865,6 +14971,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15026,6 +15133,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15306,6 +15414,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15333,6 +15442,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15488,6 +15598,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15640,6 +15751,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15669,6 +15781,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15824,6 +15937,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15991,6 +16105,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16152,6 +16267,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16420,6 +16536,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16447,6 +16564,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16602,6 +16720,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16754,6 +16873,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16783,6 +16903,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16938,6 +17059,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -17105,6 +17227,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -17266,6 +17389,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, 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 ad02f8d0928..fe7a302daf2 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.testCases.results.html @@ -165,6 +165,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -192,6 +193,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -347,6 +349,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -499,6 +502,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -528,6 +532,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -683,6 +688,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -850,6 +856,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1011,6 +1018,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1297,6 +1305,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1324,6 +1333,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1479,6 +1489,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1631,6 +1642,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1660,6 +1672,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1815,6 +1828,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1982,6 +1996,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2143,6 +2158,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html b/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html index 8277a93481a..1ab3dd4d07d 100644 --- a/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3.projects.locations.agents.transitionRouteGroups.html @@ -134,6 +134,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -306,6 +307,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -504,6 +506,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -688,6 +691,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -877,6 +881,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1050,6 +1055,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html index f25beb9569b..9f556d802e6 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.conversations.html @@ -229,6 +229,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -263,6 +264,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -435,6 +437,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -619,6 +622,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -842,6 +846,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -868,6 +873,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -902,6 +908,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1074,6 +1081,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1258,6 +1266,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1421,6 +1430,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1448,6 +1458,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1615,6 +1626,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1779,6 +1791,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1808,6 +1821,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1975,6 +1989,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2154,6 +2169,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2327,6 +2343,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2947,6 +2964,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2973,6 +2991,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3007,6 +3026,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3179,6 +3199,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3363,6 +3384,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3526,6 +3548,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3553,6 +3576,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3720,6 +3744,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3884,6 +3909,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3913,6 +3939,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4080,6 +4107,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4259,6 +4287,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4432,6 +4461,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4924,6 +4954,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4951,6 +4982,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5118,6 +5150,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5282,6 +5315,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5311,6 +5345,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5478,6 +5513,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5657,6 +5693,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5830,6 +5867,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6107,6 +6145,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6141,6 +6180,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6313,6 +6353,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6497,6 +6538,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6720,6 +6762,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6746,6 +6789,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6780,6 +6824,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6952,6 +6997,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7136,6 +7182,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7299,6 +7346,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7326,6 +7374,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7493,6 +7542,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7657,6 +7707,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7686,6 +7737,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7853,6 +7905,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8032,6 +8085,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8205,6 +8259,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8825,6 +8880,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8851,6 +8907,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8885,6 +8942,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9057,6 +9115,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9241,6 +9300,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9404,6 +9464,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9431,6 +9492,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9598,6 +9660,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9762,6 +9825,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9791,6 +9855,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9958,6 +10023,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10137,6 +10203,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10310,6 +10377,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10802,6 +10870,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10829,6 +10898,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10996,6 +11066,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11160,6 +11231,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11189,6 +11261,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11356,6 +11429,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11535,6 +11609,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11708,6 +11783,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, 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 f00406f9338..1cc6016b4c9 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.environments.sessions.html @@ -288,6 +288,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -314,6 +315,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -348,6 +350,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -520,6 +523,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -704,6 +708,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -867,6 +872,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -894,6 +900,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1061,6 +1068,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1225,6 +1233,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1254,6 +1263,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1421,6 +1431,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1600,6 +1611,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1773,6 +1785,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2451,6 +2464,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2477,6 +2491,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2511,6 +2526,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2683,6 +2699,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2867,6 +2884,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3030,6 +3048,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3057,6 +3076,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3224,6 +3244,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3388,6 +3409,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3417,6 +3439,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3584,6 +3607,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3763,6 +3787,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3936,6 +3961,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4539,6 +4565,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4566,6 +4593,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4733,6 +4761,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4897,6 +4926,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4926,6 +4956,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5093,6 +5124,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5272,6 +5304,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5445,6 +5478,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5831,6 +5865,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5857,6 +5892,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5891,6 +5927,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6063,6 +6100,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6247,6 +6285,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6410,6 +6449,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6437,6 +6477,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6604,6 +6645,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6768,6 +6810,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6797,6 +6840,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6964,6 +7008,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7143,6 +7188,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7316,6 +7362,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html index c2fced11d96..b9ee2953154 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.html @@ -153,6 +153,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -187,6 +188,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -359,6 +361,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -543,6 +546,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -716,6 +720,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -750,6 +755,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -922,6 +928,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1106,6 +1113,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1348,6 +1356,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1382,6 +1391,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1554,6 +1564,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1738,6 +1749,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2006,6 +2018,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2040,6 +2053,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2212,6 +2226,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2396,6 +2411,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2587,6 +2603,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2621,6 +2638,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2793,6 +2811,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2977,6 +2996,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3151,6 +3171,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3185,6 +3206,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3357,6 +3379,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3541,6 +3564,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, 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 5ab69e0a597..03c446adab9 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.pages.html @@ -123,6 +123,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -150,6 +151,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -317,6 +319,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -481,6 +484,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -510,6 +514,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -677,6 +682,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -856,6 +862,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1029,6 +1036,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1202,6 +1210,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1229,6 +1238,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1396,6 +1406,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1560,6 +1571,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1589,6 +1601,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1756,6 +1769,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1935,6 +1949,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2108,6 +2123,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2307,6 +2323,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2334,6 +2351,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2501,6 +2519,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2665,6 +2684,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2694,6 +2714,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2861,6 +2882,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3040,6 +3062,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3213,6 +3236,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3398,6 +3422,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3425,6 +3450,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3592,6 +3618,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3756,6 +3783,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3785,6 +3813,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3952,6 +3981,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4131,6 +4161,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4304,6 +4335,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4494,6 +4526,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4521,6 +4554,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4688,6 +4722,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4852,6 +4887,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4881,6 +4917,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5048,6 +5085,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5227,6 +5265,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5400,6 +5439,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5574,6 +5614,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5601,6 +5642,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5768,6 +5810,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5932,6 +5975,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5961,6 +6005,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6128,6 +6173,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6307,6 +6353,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6480,6 +6527,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, 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 863245bfa34..3dc760ec55f 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.flows.transitionRouteGroups.html @@ -134,6 +134,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -318,6 +319,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -528,6 +530,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -724,6 +727,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -925,6 +929,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1110,6 +1115,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html index 48ab29c382e..7aee45ab5df 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.html @@ -206,6 +206,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -298,6 +299,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -464,6 +466,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -660,6 +663,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -771,6 +775,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -864,6 +869,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html index 09a57263bdf..df93eb14b66 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.sessions.html @@ -291,6 +291,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -317,6 +318,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -351,6 +353,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -523,6 +526,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -707,6 +711,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -870,6 +875,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -897,6 +903,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1064,6 +1071,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1228,6 +1236,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1257,6 +1266,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1424,6 +1434,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1603,6 +1614,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1776,6 +1788,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2454,6 +2467,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2480,6 +2494,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2514,6 +2529,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2686,6 +2702,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2870,6 +2887,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3033,6 +3051,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3060,6 +3079,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3227,6 +3247,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3391,6 +3412,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3420,6 +3442,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3587,6 +3610,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3766,6 +3790,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3939,6 +3964,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4542,6 +4568,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4569,6 +4596,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4736,6 +4764,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4900,6 +4929,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4929,6 +4959,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5096,6 +5127,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5275,6 +5307,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5448,6 +5481,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5834,6 +5868,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5860,6 +5895,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5894,6 +5930,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6066,6 +6103,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6250,6 +6288,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6413,6 +6452,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6440,6 +6480,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6607,6 +6648,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6771,6 +6813,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6800,6 +6843,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6967,6 +7011,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7146,6 +7191,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7319,6 +7365,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html index 1a60d6b5b28..f93911b0f89 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.html @@ -248,6 +248,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -421,6 +422,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -598,6 +600,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -761,6 +764,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -795,6 +799,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -967,6 +972,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1151,6 +1157,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1314,6 +1321,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1341,6 +1349,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1508,6 +1517,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1672,6 +1682,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1701,6 +1712,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1868,6 +1880,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2047,6 +2060,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2220,6 +2234,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2385,6 +2400,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2419,6 +2435,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2591,6 +2608,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2775,6 +2793,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2938,6 +2957,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2965,6 +2985,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3132,6 +3153,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3296,6 +3318,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3325,6 +3348,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3492,6 +3516,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3671,6 +3696,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -3844,6 +3870,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4015,6 +4042,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4255,6 +4283,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4282,6 +4311,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4449,6 +4479,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4613,6 +4644,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4642,6 +4674,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4809,6 +4842,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -4988,6 +5022,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5161,6 +5196,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5451,6 +5487,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5478,6 +5515,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5645,6 +5683,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5809,6 +5848,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -5838,6 +5878,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6005,6 +6046,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6184,6 +6226,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6357,6 +6400,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6658,6 +6702,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6685,6 +6730,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -6852,6 +6898,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7016,6 +7063,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7045,6 +7093,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7212,6 +7261,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7391,6 +7441,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7564,6 +7615,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7854,6 +7906,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -7881,6 +7934,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8048,6 +8102,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8212,6 +8267,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8241,6 +8297,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8408,6 +8465,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8587,6 +8645,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -8760,6 +8819,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9112,6 +9172,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9139,6 +9200,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9306,6 +9368,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9470,6 +9533,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9499,6 +9563,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9666,6 +9731,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -9845,6 +9911,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10018,6 +10085,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10308,6 +10376,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10335,6 +10404,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10502,6 +10572,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10666,6 +10737,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10695,6 +10767,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -10862,6 +10935,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11041,6 +11115,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11214,6 +11289,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11575,6 +11651,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11602,6 +11679,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11769,6 +11847,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11933,6 +12012,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -11962,6 +12042,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12129,6 +12210,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12308,6 +12390,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12481,6 +12564,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12771,6 +12855,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12798,6 +12883,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -12965,6 +13051,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13129,6 +13216,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13158,6 +13246,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13325,6 +13414,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13504,6 +13594,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13677,6 +13768,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -13996,6 +14088,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14023,6 +14116,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14190,6 +14284,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14354,6 +14449,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14383,6 +14479,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14550,6 +14647,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14729,6 +14827,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -14902,6 +15001,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15192,6 +15292,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15219,6 +15320,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15386,6 +15488,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15550,6 +15653,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15579,6 +15683,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15746,6 +15851,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -15925,6 +16031,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16098,6 +16205,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16400,6 +16508,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16427,6 +16536,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16594,6 +16704,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16758,6 +16869,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16787,6 +16899,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -16954,6 +17067,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -17133,6 +17247,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -17306,6 +17421,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -17596,6 +17712,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -17623,6 +17740,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -17790,6 +17908,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -17954,6 +18073,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -17983,6 +18103,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -18150,6 +18271,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -18329,6 +18451,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -18502,6 +18625,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, 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 eca1910f4d4..b12bd18bbb9 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.testCases.results.html @@ -175,6 +175,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -202,6 +203,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -369,6 +371,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -533,6 +536,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -562,6 +566,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -729,6 +734,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -908,6 +914,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1081,6 +1088,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1389,6 +1397,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1416,6 +1425,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1583,6 +1593,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1747,6 +1758,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1776,6 +1788,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1943,6 +1956,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2122,6 +2136,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -2295,6 +2310,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html index e91c56c8369..3b2131a688f 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.tools.html @@ -154,6 +154,9 @@

Method Details

"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. }, }, + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent. + }, "textSchema": "A String", # Required. The OpenAPI schema specified as a text. "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. @@ -216,6 +219,9 @@

Method Details

"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. }, }, + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent. + }, "textSchema": "A String", # Required. The OpenAPI schema specified as a text. "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. @@ -351,6 +357,9 @@

Method Details

"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. }, }, + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent. + }, "textSchema": "A String", # Required. The OpenAPI schema specified as a text. "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. @@ -425,6 +434,9 @@

Method Details

"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. }, }, + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent. + }, "textSchema": "A String", # Required. The OpenAPI schema specified as a text. "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. @@ -505,6 +517,9 @@

Method Details

"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. }, }, + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent. + }, "textSchema": "A String", # Required. The OpenAPI schema specified as a text. "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. @@ -568,6 +583,9 @@

Method Details

"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. }, }, + "serviceDirectoryConfig": { # Configuration for tools using Service Directory. # Optional. Service Directory configuration. + "service": "A String", # Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent. + }, "textSchema": "A String", # Required. The OpenAPI schema specified as a text. "tlsConfig": { # The TLS configuration. # Optional. TLS configuration for the HTTPS verification. "caCerts": [ # Required. Specifies a list of allowed custom CA certificates for HTTPS verification. diff --git a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html index 55291d62bde..54471038a6f 100644 --- a/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html +++ b/docs/dyn/dialogflow_v3beta1.projects.locations.agents.transitionRouteGroups.html @@ -134,6 +134,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -318,6 +319,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -528,6 +530,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -724,6 +727,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -925,6 +929,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, @@ -1110,6 +1115,7 @@

Method Details

"maxDigits": 42, # Max length of DTMF digits. }, "loggingSettings": { # Define behaviors on logging. # Settings for logging. Settings for Dialogflow History, Contact Center messages, StackDriver logs, and speech logging. Exposed at the following levels: - Agent level. + "enableConsentBasedRedaction": True or False, # Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted. "enableInteractionLogging": True or False, # Enables DF Interaction logging. "enableStackdriverLogging": True or False, # Enables StackDriver logging. }, diff --git a/docs/dyn/discovery_v1.apis.html b/docs/dyn/discovery_v1.apis.html index 093b67e18be..09281a9f25d 100644 --- a/docs/dyn/discovery_v1.apis.html +++ b/docs/dyn/discovery_v1.apis.html @@ -117,6 +117,14 @@

Method Details

"description": "A String", # The description of this API. "discoveryVersion": "v1", # Indicate the version of the Discovery API used to generate this doc. "documentationLink": "A String", # A link to human readable documentation for the API. + "endpoints": [ # A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status. + { # A single endpoint object + "deprecated": True or False, # Whether this endpoint is deprecated + "description": "A String", # A string describing the host designated by the URL + "endpointUrl": "A String", # The URL of the endpoint target host + "location": "A String", # The location of the endpoint + }, + ], "etag": "A String", # The ETag for this response. "exponentialBackoffDefault": True or False, # Enable exponential backoff for suitable methods in the generated clients. "features": [ # A list of supported features for this API. @@ -133,6 +141,8 @@

Method Details

], "methods": { # API-level methods for this API. "a_key": { # An individual method description. + "apiVersion": "A String", # The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter. + "deprecated": True or False, # Whether this method is deprecated. "description": "A String", # Description of this method. "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. "flatPath": "A String", # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property. @@ -167,10 +177,14 @@

Method Details

], }, "default": "A String", # The default value of this property (if one exists). + "deprecated": True or False, # Whether the parameter is deprecated. "description": "A String", # A description of this object. "enum": [ # Values this parameter may take (if it is an enum). "A String", ], + "enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. + True or False, + ], "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. "A String", ], @@ -230,10 +244,14 @@

Method Details

], }, "default": "A String", # The default value of this property (if one exists). + "deprecated": True or False, # Whether the parameter is deprecated. "description": "A String", # A description of this object. "enum": [ # Values this parameter may take (if it is an enum). "A String", ], + "enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. + True or False, + ], "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. "A String", ], @@ -265,8 +283,11 @@

Method Details

"protocol": "rest", # The protocol described by this document. "resources": { # The resources in this API. "a_key": { # An individual resource description. Contains methods and sub-resources related to this resource. + "deprecated": True or False, # Whether this resource is deprecated. "methods": { # Methods on this resource. "a_key": { # Description for any methods on this resource. + "apiVersion": "A String", # The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter. + "deprecated": True or False, # Whether this method is deprecated. "description": "A String", # Description of this method. "etagRequired": True or False, # Whether this method requires an ETag to be specified. The ETag is sent as an HTTP If-Match or If-None-Match header. "flatPath": "A String", # The URI path of this REST method in (RFC 6570) format without level 2 features ({+var}). Supplementary to the path property. @@ -301,10 +322,14 @@

Method Details

], }, "default": "A String", # The default value of this property (if one exists). + "deprecated": True or False, # Whether the parameter is deprecated. "description": "A String", # A description of this object. "enum": [ # Values this parameter may take (if it is an enum). "A String", ], + "enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. + True or False, + ], "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. "A String", ], @@ -367,10 +392,14 @@

Method Details

], }, "default": "A String", # The default value of this property (if one exists). + "deprecated": True or False, # Whether the parameter is deprecated. "description": "A String", # A description of this object. "enum": [ # Values this parameter may take (if it is an enum). "A String", ], + "enumDeprecated": [ # The deprecation status for the enums. Each position maps to the corresponding value in the "enum" array. + True or False, + ], "enumDescriptions": [ # The descriptions for the enums. Each position maps to the corresponding value in the "enum" array. "A String", ], diff --git a/docs/dyn/dlp_v2.organizations.locations.connections.html b/docs/dyn/dlp_v2.organizations.locations.connections.html index ff93682b8eb..f1524e4f49f 100644 --- a/docs/dyn/dlp_v2.organizations.locations.connections.html +++ b/docs/dyn/dlp_v2.organizations.locations.connections.html @@ -86,6 +86,12 @@

Instance Methods

get(name, x__xgafv=None)

Get a Connection by name.

+

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

+

Lists Connections in a parent. Use SearchConnections to see all connections within an organization.

+

+ list_next()

+

Retrieves the next page of results.

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

Update a Connection.

@@ -253,6 +259,76 @@

Method Details

} +
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists Connections in a parent. Use SearchConnections to see all connections within an organization.
+
+Args:
+  parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required)
+  filter: string, Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR
+  pageSize: integer, Optional. Number of results per page, max 1000.
+  pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response message for ListConnections.
+  "connections": [ # List of connections.
+    { # A data connection to allow DLP to profile data in locations that require additional configuration.
+      "cloudSql": { # Cloud SQL connection properties. # Connect to a Cloud SQL instance.
+        "cloudSqlIam": { # Use IAM authentication to connect. This requires the Cloud SQL IAM feature to be enabled on the instance, which is not the default for Cloud SQL. See https://cloud.google.com/sql/docs/postgres/authentication and https://cloud.google.com/sql/docs/mysql/authentication. # Built-in IAM authentication (must be configured in Cloud SQL).
+        },
+        "connectionName": "A String", # Optional. Immutable. The Cloud SQL instance for which the connection is defined. Only one connection per instance is allowed. This can only be set at creation time, and cannot be updated. It is an error to use a connection_name from different project or region than the one that holds the connection. For example, a Connection resource for Cloud SQL connection_name `project-id:us-central1:sql-instance` must be created under the parent `projects/project-id/locations/us-central1`
+        "databaseEngine": "A String", # Required. The database engine used by the Cloud SQL instance that this connection configures.
+        "maxConnections": 42, # Required. DLP will limit its connections to max_connections. Must be 2 or greater.
+        "usernamePassword": { # A credential consisting of a username and password, where the password is stored in a Secret Manager resource. Note: Secret Manager [charges apply](https://cloud.google.com/secret-manager/pricing). # A username and password stored in Secret Manager.
+          "passwordSecretVersionName": "A String", # Required. The name of the Secret Manager resource that stores the password, in the form `projects/project-id/secrets/secret-name/versions/version`.
+          "username": "A String", # Required. The username.
+        },
+      },
+      "errors": [ # Output only. Set if status == ERROR, to provide additional details. Will store the last 10 errors sorted with the most recent first.
+        { # Details information about an error encountered during job execution or the results of an unsuccessful activation of the JobTrigger.
+          "details": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Detailed error codes and messages.
+            "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+            "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+              {
+                "a_key": "", # Properties of the object. Contains field @type with type URL.
+              },
+            ],
+            "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+          },
+          "extraInfo": "A String", # Additional information about the error.
+          "timestamps": [ # The times the error occurred. List includes the oldest timestamp and the last 9 timestamps.
+            "A String",
+          ],
+        },
+      ],
+      "name": "A String", # Output only. Name of the connection: `projects/{project}/locations/{location}/connections/{name}`.
+      "state": "A String", # Required. The connection's state in its lifecycle.
+    },
+  ],
+  "nextPageToken": "A String", # Token to retrieve the next page of results. An empty value means there are no more results.
+}
+
+ +
+ list_next() +
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+        
+
+
patch(name, body=None, x__xgafv=None)
Update a Connection.
@@ -345,7 +421,7 @@ 

Method Details

Searches for Connections in a parent.
 
 Args:
-  parent: string, Required. Parent name, typically an organization, without location. For example: `organizations/12345678`. (required)
+  parent: string, Required. Resource name of the organization or project with a wildcard location, for example `organizations/433245324/locations/-` or `projects/project-id/locations/-`. (required)
   filter: string, Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR
   pageSize: integer, Optional. Number of results per page, max 1000.
   pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
diff --git a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html
index 271ff97d6d1..1a97ee48fd9 100644
--- a/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html
+++ b/docs/dyn/dlp_v2.organizations.locations.discoveryConfigs.html
@@ -179,6 +179,7 @@ 

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -395,6 +396,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -635,6 +637,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -862,6 +865,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -1097,6 +1101,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -1314,6 +1319,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. diff --git a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html index ceac9043216..145fb762cb9 100644 --- a/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.fileStoreDataProfiles.html @@ -233,6 +233,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -806,6 +807,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. diff --git a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html index e511be106c4..0c031d4f8d6 100644 --- a/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.organizations.locations.tableDataProfiles.html @@ -233,6 +233,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -750,6 +751,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. diff --git a/docs/dyn/dlp_v2.projects.locations.connections.html b/docs/dyn/dlp_v2.projects.locations.connections.html index e86c3d96b6e..09a42c78ec7 100644 --- a/docs/dyn/dlp_v2.projects.locations.connections.html +++ b/docs/dyn/dlp_v2.projects.locations.connections.html @@ -88,7 +88,7 @@

Instance Methods

Get a Connection by name.

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

-

Lists Connections in a parent.

+

Lists Connections in a parent. Use SearchConnections to see all connections within an organization.

list_next()

Retrieves the next page of results.

@@ -261,10 +261,10 @@

Method Details

list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists Connections in a parent.
+  
Lists Connections in a parent. Use SearchConnections to see all connections within an organization.
 
 Args:
-  parent: string, Required. Parent name, for example: `projects/project-id/locations/global`. (required)
+  parent: string, Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`. (required)
   filter: string, Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR
   pageSize: integer, Optional. Number of results per page, max 1000.
   pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
@@ -421,7 +421,7 @@ 

Method Details

Searches for Connections in a parent.
 
 Args:
-  parent: string, Required. Parent name, typically an organization, without location. For example: `organizations/12345678`. (required)
+  parent: string, Required. Resource name of the organization or project with a wildcard location, for example `organizations/433245324/locations/-` or `projects/project-id/locations/-`. (required)
   filter: string, Optional. Supported field/value: - `state` - MISSING|AVAILABLE|ERROR
   pageSize: integer, Optional. Number of results per page, max 1000.
   pageToken: string, Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.
diff --git a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html
index 7b3d8c81b4a..d9d52acbdc5 100644
--- a/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html
+++ b/docs/dyn/dlp_v2.projects.locations.discoveryConfigs.html
@@ -179,6 +179,7 @@ 

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -395,6 +396,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -635,6 +637,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -862,6 +865,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -1097,6 +1101,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -1314,6 +1319,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. diff --git a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html index fda2894196b..630adda6958 100644 --- a/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.fileStoreDataProfiles.html @@ -233,6 +233,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -806,6 +807,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. diff --git a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html index b4dc2193769..2514361e548 100644 --- a/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html +++ b/docs/dyn/dlp_v2.projects.locations.tableDataProfiles.html @@ -233,6 +233,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. @@ -750,6 +751,7 @@

Method Details

"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", # Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never. "schemaModifiedCadence": { # The cadence at which to update data profiles when a schema is modified. # Governs when to update data profiles when a schema is modified. "frequency": "A String", # How frequently profiles may be updated when schemas are modified. Defaults to monthly. "types": [ # The type of events to consider when deciding if the table's schema has been modified and should have the profile updated. Defaults to NEW_COLUMNS. diff --git a/docs/dyn/dns_v1.changes.html b/docs/dyn/dns_v1.changes.html index 74fe65c912d..955c514a522 100644 --- a/docs/dyn/dns_v1.changes.html +++ b/docs/dyn/dns_v1.changes.html @@ -116,6 +116,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -141,6 +144,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -148,6 +152,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -175,6 +182,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -194,6 +204,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -240,6 +253,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -265,6 +281,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -272,6 +289,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -299,6 +319,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -318,6 +341,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -381,6 +407,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -406,6 +435,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -413,6 +443,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -440,6 +473,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -459,6 +495,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -505,6 +544,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -530,6 +572,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -537,6 +580,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -564,6 +610,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -583,6 +632,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -655,6 +707,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -680,6 +735,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -687,6 +743,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -714,6 +773,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -733,6 +795,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -779,6 +844,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -804,6 +872,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -811,6 +880,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -838,6 +910,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -857,6 +932,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -935,6 +1013,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -960,6 +1041,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -967,6 +1049,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -994,6 +1079,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1013,6 +1101,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1059,6 +1150,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1084,6 +1178,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1091,6 +1186,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1118,6 +1216,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1137,6 +1238,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. diff --git a/docs/dyn/dns_v1.projects.html b/docs/dyn/dns_v1.projects.html index dd07c28002b..7af128874e4 100644 --- a/docs/dyn/dns_v1.projects.html +++ b/docs/dyn/dns_v1.projects.html @@ -110,6 +110,7 @@

Method Details

"gkeClustersPerManagedZone": 42, # Maximum allowed number of GKE clusters to which a privately scoped zone can be attached. "gkeClustersPerPolicy": 42, # Maximum allowed number of GKE clusters per policy. "gkeClustersPerResponsePolicy": 42, # Maximum allowed number of GKE clusters per response policy. + "internetHealthChecksPerManagedZone": 42, "itemsPerRoutingPolicy": 42, # Maximum allowed number of items per routing policy. "kind": "dns#quota", "managedZones": 42, # Maximum allowed number of managed zones in the project. diff --git a/docs/dyn/dns_v1.resourceRecordSets.html b/docs/dyn/dns_v1.resourceRecordSets.html index 8aa0d870550..9bd57c21640 100644 --- a/docs/dyn/dns_v1.resourceRecordSets.html +++ b/docs/dyn/dns_v1.resourceRecordSets.html @@ -120,6 +120,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -145,6 +148,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -152,6 +156,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -179,6 +186,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -198,6 +208,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -252,6 +265,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -277,6 +293,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -284,6 +301,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -311,6 +331,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -330,6 +353,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -416,6 +442,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -441,6 +470,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -448,6 +478,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -475,6 +508,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -494,6 +530,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -563,6 +602,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -588,6 +630,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -595,6 +638,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -622,6 +668,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -641,6 +690,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -715,6 +767,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -740,6 +795,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -747,6 +803,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -774,6 +833,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -793,6 +855,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -847,6 +912,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -872,6 +940,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -879,6 +948,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -906,6 +978,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -925,6 +1000,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. diff --git a/docs/dyn/dns_v1.responsePolicyRules.html b/docs/dyn/dns_v1.responsePolicyRules.html index 8e08db0f5a9..b7b95f10a13 100644 --- a/docs/dyn/dns_v1.responsePolicyRules.html +++ b/docs/dyn/dns_v1.responsePolicyRules.html @@ -129,6 +129,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -154,6 +157,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -161,6 +165,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -188,6 +195,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -207,6 +217,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -271,6 +284,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -296,6 +312,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -303,6 +320,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -330,6 +350,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -349,6 +372,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -438,6 +464,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -463,6 +492,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -470,6 +500,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -497,6 +530,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -516,6 +552,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -592,6 +631,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -617,6 +659,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -624,6 +667,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -651,6 +697,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -670,6 +719,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -753,6 +805,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -778,6 +833,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -785,6 +841,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -812,6 +871,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -831,6 +893,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -896,6 +961,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -921,6 +989,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -928,6 +997,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -955,6 +1027,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -974,6 +1049,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1042,6 +1120,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1067,6 +1148,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1074,6 +1156,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1101,6 +1186,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1120,6 +1208,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1185,6 +1276,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1210,6 +1304,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1217,6 +1312,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1244,6 +1342,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1263,6 +1364,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. diff --git a/docs/dyn/dns_v1beta2.changes.html b/docs/dyn/dns_v1beta2.changes.html index 2bbcf6d8310..f5e9277f8fe 100644 --- a/docs/dyn/dns_v1beta2.changes.html +++ b/docs/dyn/dns_v1beta2.changes.html @@ -116,6 +116,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -146,6 +149,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -171,6 +177,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -178,6 +185,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -205,6 +215,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -224,6 +237,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -253,6 +269,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -299,6 +318,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -329,6 +351,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -354,6 +379,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -361,6 +387,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -388,6 +417,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -407,6 +439,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -436,6 +471,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -499,6 +537,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -529,6 +570,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -554,6 +598,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -561,6 +606,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -588,6 +636,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -607,6 +658,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -636,6 +690,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -682,6 +739,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -712,6 +772,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -737,6 +800,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -744,6 +808,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -771,6 +838,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -790,6 +860,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -819,6 +892,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -891,6 +967,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -921,6 +1000,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -946,6 +1028,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -953,6 +1036,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -980,6 +1066,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -999,6 +1088,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1028,6 +1120,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1074,6 +1169,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1104,6 +1202,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1129,6 +1230,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1136,6 +1238,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1163,6 +1268,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1182,6 +1290,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1211,6 +1322,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1289,6 +1403,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1319,6 +1436,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1344,6 +1464,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1351,6 +1472,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1378,6 +1502,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1397,6 +1524,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1426,6 +1556,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1472,6 +1605,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1502,6 +1638,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1527,6 +1666,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1534,6 +1674,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1561,6 +1704,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1580,6 +1726,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1609,6 +1758,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. diff --git a/docs/dyn/dns_v1beta2.projects.html b/docs/dyn/dns_v1beta2.projects.html index 53635ea57e9..4c4bb6b4d33 100644 --- a/docs/dyn/dns_v1beta2.projects.html +++ b/docs/dyn/dns_v1beta2.projects.html @@ -110,6 +110,7 @@

Method Details

"gkeClustersPerManagedZone": 42, # Maximum allowed number of GKE clusters to which a privately scoped zone can be attached. "gkeClustersPerPolicy": 42, # Maximum allowed number of GKE clusters per policy. "gkeClustersPerResponsePolicy": 42, # Maximum allowed number of GKE clusters per response policy. + "internetHealthChecksPerManagedZone": 42, "itemsPerRoutingPolicy": 42, # Maximum allowed number of items per routing policy. "kind": "dns#quota", "managedZones": 42, # Maximum allowed number of managed zones in the project. diff --git a/docs/dyn/dns_v1beta2.resourceRecordSets.html b/docs/dyn/dns_v1beta2.resourceRecordSets.html index e975dd386a1..c2f6afb8f1d 100644 --- a/docs/dyn/dns_v1beta2.resourceRecordSets.html +++ b/docs/dyn/dns_v1beta2.resourceRecordSets.html @@ -120,6 +120,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -150,6 +153,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -175,6 +181,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -182,6 +189,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -209,6 +219,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -228,6 +241,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -257,6 +273,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -311,6 +330,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -341,6 +363,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -366,6 +391,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -373,6 +399,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -400,6 +429,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -419,6 +451,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -448,6 +483,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -529,6 +567,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -559,6 +600,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -584,6 +628,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -591,6 +636,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -618,6 +666,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -637,6 +688,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -666,6 +720,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -735,6 +792,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -765,6 +825,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -790,6 +853,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -797,6 +861,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -824,6 +891,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -843,6 +913,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -872,6 +945,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -946,6 +1022,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -976,6 +1055,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1001,6 +1083,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1008,6 +1091,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1035,6 +1121,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1054,6 +1143,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1083,6 +1175,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1137,6 +1232,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1167,6 +1265,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1192,6 +1293,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1199,6 +1301,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1226,6 +1331,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1245,6 +1353,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1274,6 +1385,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. diff --git a/docs/dyn/dns_v1beta2.responsePolicyRules.html b/docs/dyn/dns_v1beta2.responsePolicyRules.html index b361e1539d9..f29a7857a54 100644 --- a/docs/dyn/dns_v1beta2.responsePolicyRules.html +++ b/docs/dyn/dns_v1beta2.responsePolicyRules.html @@ -129,6 +129,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -159,6 +162,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -184,6 +190,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -191,6 +198,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -218,6 +228,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -237,6 +250,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -266,6 +282,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -330,6 +349,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -360,6 +382,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -385,6 +410,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -392,6 +418,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -419,6 +448,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -438,6 +470,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -467,6 +502,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -556,6 +594,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -586,6 +627,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -611,6 +655,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -618,6 +663,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -645,6 +693,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -664,6 +715,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -693,6 +747,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -769,6 +826,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -799,6 +859,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -824,6 +887,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -831,6 +895,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -858,6 +925,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -877,6 +947,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -906,6 +979,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -989,6 +1065,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1019,6 +1098,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1044,6 +1126,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1051,6 +1134,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1078,6 +1164,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1097,6 +1186,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1126,6 +1218,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1191,6 +1286,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1221,6 +1319,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1246,6 +1347,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1253,6 +1355,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1280,6 +1385,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1299,6 +1407,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1328,6 +1439,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1396,6 +1510,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1426,6 +1543,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1451,6 +1571,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1458,6 +1579,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1485,6 +1609,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1504,6 +1631,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1533,6 +1663,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1598,6 +1731,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1628,6 +1764,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1653,6 +1792,7 @@

Method Details

], "kind": "dns#rRSetRoutingPolicyGeoPolicy", }, + "healthCheck": "A String", # The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks "kind": "dns#rRSetRoutingPolicy", "primaryBackup": { # Configures a RRSetRoutingPolicy such that all queries are responded with the primary_targets if they are healthy. And if all of them are unhealthy, then we fallback to a geo localized policy. "backupGeoTargets": { # Configures a `RRSetRoutingPolicy` that routes based on the geo location of the querying user. # Backup targets provide a regional failover policy for the otherwise global primary targets. If serving state is set to `BACKUP`, this policy essentially becomes a geo routing policy. @@ -1660,6 +1800,9 @@

Method Details

"items": [ # The primary geo routing configuration. If there are multiple items with the same location, an error is returned instead. { # ResourceRecordSet data for one geo location. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # For A and AAAA types only. Endpoints to return in the query result only if they are healthy. These can be specified along with `rrdata` within this item. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1687,6 +1830,9 @@

Method Details

}, "kind": "dns#rRSetRoutingPolicyPrimaryBackupPolicy", "primaryTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. Unhealthy endpoints are omitted from the results. If all endpoints are unhealthy, we serve a response based on the `backup_geo_targets`. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1706,6 +1852,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. @@ -1735,6 +1884,9 @@

Method Details

"items": [ { # A routing block which contains the routing information for one WRR item. "healthCheckedTargets": { # HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response. # Endpoints that are health checked before making the routing decision. The unhealthy endpoints are omitted from the result. If all endpoints within a bucket are unhealthy, we choose a different bucket (sampled with respect to its weight) for responding. If DNSSEC is enabled for this zone, only one of `rrdata` or `health_checked_targets` can be set. + "externalEndpoints": [ # The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1) + "A String", + ], "internalLoadBalancers": [ # Configuration for internal load balancers to be health checked. { # The configuration for an individual load balancer to health check. "ipAddress": "A String", # The frontend IP address of the load balancer to health check. diff --git a/docs/dyn/drive_v2.files.html b/docs/dyn/drive_v2.files.html index 11946a1aeeb..84f2fd04c1a 100644 --- a/docs/dyn/drive_v2.files.html +++ b/docs/dyn/drive_v2.files.html @@ -1025,7 +1025,7 @@

Method Details

Args: fileId: string, The ID for the file in question. (required) - acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. + acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. projection: string, Deprecated: This parameter has no function. @@ -1431,7 +1431,7 @@

Method Details

Args: fileId: string, The ID for the file in question. (required) - acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. + acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. projection: string, Deprecated: This parameter has no function. @@ -5684,7 +5684,7 @@

Method Details

"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook". } - acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. + acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only `published` is supported. projection: string, Deprecated: This parameter has no function. diff --git a/docs/dyn/drive_v3.files.html b/docs/dyn/drive_v3.files.html index c8501640237..7c282f54174 100644 --- a/docs/dyn/drive_v3.files.html +++ b/docs/dyn/drive_v3.files.html @@ -1394,7 +1394,7 @@

Method Details

Args: fileId: string, The ID of the file. (required) - acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. @@ -1694,7 +1694,7 @@

Method Details

Args: fileId: string, The ID of the file. (required) - acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. @@ -2820,7 +2820,7 @@

Method Details

"type": "A String", # The type of delivery mechanism used for this channel. Valid values are "web_hook" or "webhook". } - acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. includeLabels: string, A comma-separated list of IDs of labels to include in the `labelInfo` part of the response. includePermissionsForView: string, Specifies which additional view's permissions to include in the response. Only 'published' is supported. supportsAllDrives: boolean, Whether the requesting application supports both My Drives and shared drives. diff --git a/docs/dyn/drive_v3.revisions.html b/docs/dyn/drive_v3.revisions.html index 68bf2fd7080..df6a0d42500 100644 --- a/docs/dyn/drive_v3.revisions.html +++ b/docs/dyn/drive_v3.revisions.html @@ -122,7 +122,7 @@

Method Details

Args: fileId: string, The ID of the file. (required) revisionId: string, The ID of the revision. (required) - acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -165,7 +165,7 @@

Method Details

Args: fileId: string, The ID of the file. (required) revisionId: string, The ID of the revision. (required) - acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. + acknowledgeAbuse: boolean, Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/file_v1.projects.locations.instances.html b/docs/dyn/file_v1.projects.locations.instances.html index 4a4a64c980f..9b9550b290f 100644 --- a/docs/dyn/file_v1.projects.locations.instances.html +++ b/docs/dyn/file_v1.projects.locations.instances.html @@ -143,21 +143,6 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], - "performanceConfig": { # Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. # Optional. Used to configure performance. - "fixedIops": { # Fixed IOPS parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. - }, - "iopsByCapacity": True or False, # Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - "iopsPerGb": { # IOPS per capacity parameters. # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerGb": "A String", # Required. Maximum read IOPS per GB. - }, - }, - "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. - "maxReadIops": "A String", # Output only. The max read IOPS. - "maxReadThroughput": "A String", # Output only. The max read throughput. - "maxWriteIops": "A String", # Output only. The max write IOPS. - "maxWriteThroughput": "A String", # Output only. The max write throughput. - }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. }, ], @@ -304,21 +289,6 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], - "performanceConfig": { # Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. # Optional. Used to configure performance. - "fixedIops": { # Fixed IOPS parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. - }, - "iopsByCapacity": True or False, # Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - "iopsPerGb": { # IOPS per capacity parameters. # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerGb": "A String", # Required. Maximum read IOPS per GB. - }, - }, - "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. - "maxReadIops": "A String", # Output only. The max read IOPS. - "maxReadThroughput": "A String", # Output only. The max read throughput. - "maxWriteIops": "A String", # Output only. The max write IOPS. - "maxWriteThroughput": "A String", # Output only. The max write throughput. - }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. }, ], @@ -406,21 +376,6 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], - "performanceConfig": { # Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. # Optional. Used to configure performance. - "fixedIops": { # Fixed IOPS parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. - }, - "iopsByCapacity": True or False, # Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - "iopsPerGb": { # IOPS per capacity parameters. # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerGb": "A String", # Required. Maximum read IOPS per GB. - }, - }, - "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. - "maxReadIops": "A String", # Output only. The max read IOPS. - "maxReadThroughput": "A String", # Output only. The max read throughput. - "maxWriteIops": "A String", # Output only. The max write IOPS. - "maxWriteThroughput": "A String", # Output only. The max write throughput. - }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. }, ], @@ -517,21 +472,6 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], - "performanceConfig": { # Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. # Optional. Used to configure performance. - "fixedIops": { # Fixed IOPS parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. - }, - "iopsByCapacity": True or False, # Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - "iopsPerGb": { # IOPS per capacity parameters. # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerGb": "A String", # Required. Maximum read IOPS per GB. - }, - }, - "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. - "maxReadIops": "A String", # Output only. The max read IOPS. - "maxReadThroughput": "A String", # Output only. The max read throughput. - "maxWriteIops": "A String", # Output only. The max write IOPS. - "maxWriteThroughput": "A String", # Output only. The max write throughput. - }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. }, ], diff --git a/docs/dyn/file_v1beta1.projects.locations.instances.html b/docs/dyn/file_v1beta1.projects.locations.instances.html index 4072f9a3573..227a9ce2283 100644 --- a/docs/dyn/file_v1beta1.projects.locations.instances.html +++ b/docs/dyn/file_v1beta1.projects.locations.instances.html @@ -159,21 +159,6 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], - "performanceConfig": { # Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. # Optional. Used to configure performance. - "fixedIops": { # Fixed IOPS parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. - }, - "iopsByCapacity": True or False, # Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - "iopsPerGb": { # IOPS per capacity parameters. # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerGb": "A String", # Required. Maximum read IOPS per GB. - }, - }, - "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. - "maxReadIops": "A String", # Output only. The max read IOPS. - "maxReadThroughput": "A String", # Output only. The max read throughput. - "maxWriteIops": "A String", # Output only. The max write IOPS. - "maxWriteThroughput": "A String", # Output only. The max write throughput. - }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. }, ], @@ -335,21 +320,6 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], - "performanceConfig": { # Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. # Optional. Used to configure performance. - "fixedIops": { # Fixed IOPS parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. - }, - "iopsByCapacity": True or False, # Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - "iopsPerGb": { # IOPS per capacity parameters. # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerGb": "A String", # Required. Maximum read IOPS per GB. - }, - }, - "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. - "maxReadIops": "A String", # Output only. The max read IOPS. - "maxReadThroughput": "A String", # Output only. The max read throughput. - "maxWriteIops": "A String", # Output only. The max write IOPS. - "maxWriteThroughput": "A String", # Output only. The max write throughput. - }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. }, ], @@ -452,21 +422,6 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], - "performanceConfig": { # Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. # Optional. Used to configure performance. - "fixedIops": { # Fixed IOPS parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. - }, - "iopsByCapacity": True or False, # Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - "iopsPerGb": { # IOPS per capacity parameters. # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerGb": "A String", # Required. Maximum read IOPS per GB. - }, - }, - "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. - "maxReadIops": "A String", # Output only. The max read IOPS. - "maxReadThroughput": "A String", # Output only. The max read throughput. - "maxWriteIops": "A String", # Output only. The max write IOPS. - "maxWriteThroughput": "A String", # Output only. The max write throughput. - }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. }, ], @@ -578,21 +533,6 @@

Method Details

"squashMode": "A String", # Either NO_ROOT_SQUASH, for allowing root access on the exported directory, or ROOT_SQUASH, for not allowing root access. The default is NO_ROOT_SQUASH. }, ], - "performanceConfig": { # Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation. # Optional. Used to configure performance. - "fixedIops": { # Fixed IOPS parameters. # Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIops": "A String", # Required. Maximum raw read IOPS. - }, - "iopsByCapacity": True or False, # Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation. - "iopsPerGb": { # IOPS per capacity parameters. # Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error. - "maxReadIopsPerGb": "A String", # Required. Maximum read IOPS per GB. - }, - }, - "performanceLimits": { # The enforced performance limits, calculated from the instance's performance configuration. # Output only. Used for getting performance limits. - "maxReadIops": "A String", # Output only. The max read IOPS. - "maxReadThroughput": "A String", # Output only. The max read throughput. - "maxWriteIops": "A String", # Output only. The max write IOPS. - "maxWriteThroughput": "A String", # Output only. The max write throughput. - }, "sourceBackup": "A String", # The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from. }, ], diff --git a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html index 84f3c3e86f1..53e880de4eb 100644 --- a/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html +++ b/docs/dyn/firebaseappdistribution_v1alpha.projects.apps.releases.tests.html @@ -105,7 +105,7 @@

Method Details

The object takes the form of: { # The results of running an automated test on a release. - "aiInstructions": { # Instructions for AI driven test # Optional. Input only. Instructions for AI driven test. Input only. + "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI @@ -119,6 +119,60 @@

Method Details

{ # The results of running an automated test on a particular device. "aiStepResults": [ # Output only. Results of the AI steps if passed in { # Captures the results of an AiStep + "assertionDetails": { # Details for an assertion step. # Output only. Details for an assertion step. + "explanation": "A String", # Output only. An explanation justifying the assertion result. + "result": True or False, # Output only. The result of the assertion. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this assertion. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + }, + "goalDetails": { # Details for a goal step. # Output only. Details for a goal step. + "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. + { # An action taken by the AI agent while attempting to accomplish a goal. + "deviceAction": { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device. + "description": "A String", # Output only. A short description of the high level action taken by the AI agent. + "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. + { # An interaction with the device, such as a tap, text entry, wait, etc. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + "swipe": { # A swipe action. # Output only. A swipe action. + "end": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The end point of the swipe. + "xCoordinate": 42, + "yCoordinate": 42, + }, + "start": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The start point of the swipe. + "xCoordinate": 42, + "yCoordinate": 42, + }, + }, + "tap": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. A tap action. + "xCoordinate": 42, + "yCoordinate": 42, + }, + "textInput": "A String", # Output only. Text entered for a text entry action. + "wait": { # A wait action. # Output only. A wait action. + "duration": "A String", # Output only. The duration of the wait. + }, + }, + ], + }, + "explanation": "A String", # Output only. An explanation justifying why the action was taken. + "terminalAction": { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal. + "reason": "A String", # Output only. The reason why this goal was ended. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + }, + }, + ], + }, "state": "A String", # Output only. The current state of the step "step": { # A step to be accomplished by the AI # Required. The step performed by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -175,7 +229,7 @@

Method Details

An object of the form: { # The results of running an automated test on a release. - "aiInstructions": { # Instructions for AI driven test # Optional. Input only. Instructions for AI driven test. Input only. + "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI @@ -189,6 +243,60 @@

Method Details

{ # The results of running an automated test on a particular device. "aiStepResults": [ # Output only. Results of the AI steps if passed in { # Captures the results of an AiStep + "assertionDetails": { # Details for an assertion step. # Output only. Details for an assertion step. + "explanation": "A String", # Output only. An explanation justifying the assertion result. + "result": True or False, # Output only. The result of the assertion. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this assertion. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + }, + "goalDetails": { # Details for a goal step. # Output only. Details for a goal step. + "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. + { # An action taken by the AI agent while attempting to accomplish a goal. + "deviceAction": { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device. + "description": "A String", # Output only. A short description of the high level action taken by the AI agent. + "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. + { # An interaction with the device, such as a tap, text entry, wait, etc. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + "swipe": { # A swipe action. # Output only. A swipe action. + "end": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The end point of the swipe. + "xCoordinate": 42, + "yCoordinate": 42, + }, + "start": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The start point of the swipe. + "xCoordinate": 42, + "yCoordinate": 42, + }, + }, + "tap": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. A tap action. + "xCoordinate": 42, + "yCoordinate": 42, + }, + "textInput": "A String", # Output only. Text entered for a text entry action. + "wait": { # A wait action. # Output only. A wait action. + "duration": "A String", # Output only. The duration of the wait. + }, + }, + ], + }, + "explanation": "A String", # Output only. An explanation justifying why the action was taken. + "terminalAction": { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal. + "reason": "A String", # Output only. The reason why this goal was ended. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + }, + }, + ], + }, "state": "A String", # Output only. The current state of the step "step": { # A step to be accomplished by the AI # Required. The step performed by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -251,7 +359,7 @@

Method Details

An object of the form: { # The results of running an automated test on a release. - "aiInstructions": { # Instructions for AI driven test # Optional. Input only. Instructions for AI driven test. Input only. + "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI @@ -265,6 +373,60 @@

Method Details

{ # The results of running an automated test on a particular device. "aiStepResults": [ # Output only. Results of the AI steps if passed in { # Captures the results of an AiStep + "assertionDetails": { # Details for an assertion step. # Output only. Details for an assertion step. + "explanation": "A String", # Output only. An explanation justifying the assertion result. + "result": True or False, # Output only. The result of the assertion. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this assertion. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + }, + "goalDetails": { # Details for a goal step. # Output only. Details for a goal step. + "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. + { # An action taken by the AI agent while attempting to accomplish a goal. + "deviceAction": { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device. + "description": "A String", # Output only. A short description of the high level action taken by the AI agent. + "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. + { # An interaction with the device, such as a tap, text entry, wait, etc. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + "swipe": { # A swipe action. # Output only. A swipe action. + "end": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The end point of the swipe. + "xCoordinate": 42, + "yCoordinate": 42, + }, + "start": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The start point of the swipe. + "xCoordinate": 42, + "yCoordinate": 42, + }, + }, + "tap": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. A tap action. + "xCoordinate": 42, + "yCoordinate": 42, + }, + "textInput": "A String", # Output only. Text entered for a text entry action. + "wait": { # A wait action. # Output only. A wait action. + "duration": "A String", # Output only. The duration of the wait. + }, + }, + ], + }, + "explanation": "A String", # Output only. An explanation justifying why the action was taken. + "terminalAction": { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal. + "reason": "A String", # Output only. The reason why this goal was ended. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + }, + }, + ], + }, "state": "A String", # Output only. The current state of the step "step": { # A step to be accomplished by the AI # Required. The step performed by the AI "assertion": "A String", # An assertion to be checked by the AI @@ -332,7 +494,7 @@

Method Details

"nextPageToken": "A String", # A short-lived token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. "releaseTests": [ # The tests listed. { # The results of running an automated test on a release. - "aiInstructions": { # Instructions for AI driven test # Optional. Input only. Instructions for AI driven test. Input only. + "aiInstructions": { # Instructions for AI driven test # Optional. Instructions for AI driven test. "appDescription": "A String", # Optional. Describes the app to give the AI some context "steps": [ # Required. Steps to be accomplished by the AI { # A step to be accomplished by the AI @@ -346,6 +508,60 @@

Method Details

{ # The results of running an automated test on a particular device. "aiStepResults": [ # Output only. Results of the AI steps if passed in { # Captures the results of an AiStep + "assertionDetails": { # Details for an assertion step. # Output only. Details for an assertion step. + "explanation": "A String", # Output only. An explanation justifying the assertion result. + "result": True or False, # Output only. The result of the assertion. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this assertion. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + }, + "goalDetails": { # Details for a goal step. # Output only. Details for a goal step. + "goalActions": [ # Output only. The actions taken by the AI while attempting to accomplish the goal. + { # An action taken by the AI agent while attempting to accomplish a goal. + "deviceAction": { # A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc. # Output only. A high level action taken by the AI on the device. + "description": "A String", # Output only. A short description of the high level action taken by the AI agent. + "deviceInteractions": [ # Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc. + { # An interaction with the device, such as a tap, text entry, wait, etc. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + "swipe": { # A swipe action. # Output only. A swipe action. + "end": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The end point of the swipe. + "xCoordinate": 42, + "yCoordinate": 42, + }, + "start": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. The start point of the swipe. + "xCoordinate": 42, + "yCoordinate": 42, + }, + }, + "tap": { # Point for describing bounding boxes tap locations Top left is 0,0 # Output only. A tap action. + "xCoordinate": 42, + "yCoordinate": 42, + }, + "textInput": "A String", # Output only. Text entered for a text entry action. + "wait": { # A wait action. # Output only. A wait action. + "duration": "A String", # Output only. The duration of the wait. + }, + }, + ], + }, + "explanation": "A String", # Output only. An explanation justifying why the action was taken. + "terminalAction": { # An action taken by the AI to end the goal. # Output only. An action taken by the AI to end the goal. + "reason": "A String", # Output only. The reason why this goal was ended. + "screenshot": { # A device screenshot taken during a test. # Output only. The screenshot used in the context of this terminal action. + "height": 42, # Output only. The height of the screenshot, in pixels. + "uri": "A String", # Output only. The URI of the screenshot. + "width": 42, # Output only. The width of the screenshot, in pixels. + }, + }, + }, + ], + }, "state": "A String", # Output only. The current state of the step "step": { # A step to be accomplished by the AI # Required. The step performed by the AI "assertion": "A String", # An assertion to be checked by the AI diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html index 848116843a9..cdfeb775fc0 100644 --- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html +++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html @@ -356,6 +356,14 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, + "routingConfig": { # Routing config. # Optional. Routing configuration. + "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. + "modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. + }, + }, "stopSequences": [ # Optional. Stop sequences. "A String", ], @@ -716,6 +724,14 @@

Method Details

"title": "A String", # Optional. The title of the Schema. "type": "A String", # Optional. The type of the data. }, + "routingConfig": { # Routing config. # Optional. Routing configuration. + "autoMode": { # When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference. # Automated routing. + "modelRoutingPreference": "A String", # The model routing preference. + }, + "manualMode": { # When manual routing is set, the specified model will be used directly. # Manual routing. + "modelName": "A String", # The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001. + }, + }, "stopSequences": [ # Optional. Stop sequences. "A String", ], diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 4a7ce03a070..4514ec254c4 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -1012,7 +1012,6 @@ ## realtimebidding * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/realtimebidding_v1.html) -* [v1alpha](http://googleapis.github.io/google-api-python-client/docs/dyn/realtimebidding_v1alpha.html) ## recaptchaenterprise diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.accounttax.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.accounttax.html index 33928590fbe..795e61ff8ab 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.accounttax.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.accounttax.html @@ -80,12 +80,6 @@

Instance Methods

get(name, x__xgafv=None)

Returns the tax rules that match the conditions of GetAccountTaxRequest

-

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

-

Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.

-

- list_next()

-

Retrieves the next page of results.

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

Updates the tax settings of the account.

@@ -132,64 +126,6 @@

Method Details

}
-
- list(parent, pageSize=None, pageToken=None, x__xgafv=None) -
Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.
-
-Args:
-  parent: string, Required. The parent, which owns this collection of account tax. Format: accounts/{account} (required)
-  pageSize: integer, The maximum number of tax settings to return in the response, used for paging.
-  pageToken: string, The token returned by the previous request.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Response to account tax list request This method can only be called on a multi-client account, otherwise it'll return an error.
-  "accountTaxes": [ # Page of accounttax settings
-    { # The tax settings of a merchant account. All methods require the admin role.
-      "account": "A String", # Output only. The ID of the account to which these account tax settings belong.
-      "name": "A String", # Identifier. The name of the tax setting. Format: "{account_tax.name=accounts/{account}}"
-      "taxRules": [ # Tax rules. "Define the tax rules in each region. No tax will be presented if a region has no rule."
-        { # Primary type convension percent micro : 100% = 1 000 000 and 1% = 10 000 cannot be negative. Information about tax nexus and related parameters applicable to orders delivered to the area covered by a single tax admin. Nexus is created when a merchant is doing business in an area administered by tax admin (only US states are supported for nexus configuration). If merchant has nexus in a US state, merchant needs to pay tax to all tax authorities associated with the shipping destination. Next Id : 8
-          "effectiveTimePeriod": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Required. Time period when this rule is effective. If the duration is missing from effective_time listed, then it is open ended to the future. The start of this time period is inclusive, and the end is exclusive.
-            "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.
-          },
-          "locationId": "A String", # The admin_id or criteria_id of the region in which this rule is applicable.
-          "postCodeRange": { # A range of postal codes that defines the area. # The range of postal codes in which this rule is applicable.
-            "end": "A String", # The end of the postal code range. Will be the same as start if not specified.
-            "start": "A String", # Required. The start of the postal code range, which is also the smallest in the range.
-          },
-          "regionCode": "A String", # Region code in which this rule is applicable
-          "selfSpecifiedRateMicros": "A String", # A fixed rate specified in micros, where 100% = 1_000_000. Suitable for origin-based states.
-          "shippingTaxed": True or False, # If set, shipping charge is taxed (at the same rate as product) when delivering to this admin's area. Can only be set on US states without category.
-          "useGoogleRate": True or False, # Rate that depends on delivery location: if merchant has a nexus in corresponding US state, rates from authorities with jurisdiction over delivery area are added up.
-        },
-      ],
-    },
-  ],
-  "nextPageToken": "A String", # The token for the retrieval of the next page of account tax settings.
-}
-
- -
- list_next() -
Retrieves the next page of results.
-
-        Args:
-          previous_request: The request for the previous page. (required)
-          previous_response: The response from the request for the previous page. (required)
-
-        Returns:
-          A request object that you can call 'execute()' on to request the next
-          page. Returns None if there are no more items in the collection.
-        
-
-
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the tax settings of the account.
diff --git a/docs/dyn/monitoring_v1.projects.dashboards.html b/docs/dyn/monitoring_v1.projects.dashboards.html
index f0ca2a1fb60..562f57c8af8 100644
--- a/docs/dyn/monitoring_v1.projects.dashboards.html
+++ b/docs/dyn/monitoring_v1.projects.dashboards.html
@@ -725,9 +725,106 @@ 

Method Details

"dashboardFilters": [ # Filters to reduce the amount of data charted based on the filter criteria. { # A filter to reduce the amount of data charted in relevant widgets. "filterType": "A String", # The specified filter type - "labelKey": "A String", # Required. The key for the label - "stringValue": "A String", # A variable-length string value. + "labelKey": "A String", # Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise. + "stringArray": { # An array of strings # A list of possible string values for the filter + "values": [ # The values of the array + "A String", + ], + }, + "stringArrayValue": { # An array of strings # An array of variable-length string values. If this field is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED + "values": [ # The values of the array + "A String", + ], + }, + "stringValue": "A String", # A variable-length string value. If this field is set, value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED "templateVariable": "A String", # The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard. + "timeSeriesQuery": { # TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. # A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported + "opsAnalyticsQuery": { # Preview: A query that produces an aggregated response and supporting data. This is a preview feature and may be subject to change before final release. # Preview: A query used to fetch a time series, category series, or numeric series with SQL. This is a preview feature and may be subject to change before final release. + "sql": "A String", # A SQL query to fetch time series, category series, or numeric series data. + }, + "outputFullDuration": True or False, # Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like - XyChart - Scorecard's spark chart + "prometheusQuery": "A String", # A query used to fetch time series with PromQL. + "timeSeriesFilter": { # A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method. # Filter parameters to fetch time series. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after aggregation is applied. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesFilterRatio": { # A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series. # Parameters to fetch a ratio between two time series filters. + "denominator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The denominator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "numerator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The numerator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after the ratio is computed. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesQueryLanguage": "A String", # A query used to fetch time series with MQL. + "unitOverride": "A String", # The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in MetricDescriptor. + }, + "valueType": "A String", # The type of the filter value. If value_type is not provided, it will be inferred from the default_value. If neither value_type nor default_value is provided, value_type will be set to STRING by default. }, ], "displayName": "A String", # Required. The mutable, human-readable name. @@ -3145,9 +3242,106 @@

Method Details

"dashboardFilters": [ # Filters to reduce the amount of data charted based on the filter criteria. { # A filter to reduce the amount of data charted in relevant widgets. "filterType": "A String", # The specified filter type - "labelKey": "A String", # Required. The key for the label - "stringValue": "A String", # A variable-length string value. + "labelKey": "A String", # Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise. + "stringArray": { # An array of strings # A list of possible string values for the filter + "values": [ # The values of the array + "A String", + ], + }, + "stringArrayValue": { # An array of strings # An array of variable-length string values. If this field is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED + "values": [ # The values of the array + "A String", + ], + }, + "stringValue": "A String", # A variable-length string value. If this field is set, value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED "templateVariable": "A String", # The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard. + "timeSeriesQuery": { # TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. # A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported + "opsAnalyticsQuery": { # Preview: A query that produces an aggregated response and supporting data. This is a preview feature and may be subject to change before final release. # Preview: A query used to fetch a time series, category series, or numeric series with SQL. This is a preview feature and may be subject to change before final release. + "sql": "A String", # A SQL query to fetch time series, category series, or numeric series data. + }, + "outputFullDuration": True or False, # Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like - XyChart - Scorecard's spark chart + "prometheusQuery": "A String", # A query used to fetch time series with PromQL. + "timeSeriesFilter": { # A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method. # Filter parameters to fetch time series. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after aggregation is applied. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesFilterRatio": { # A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series. # Parameters to fetch a ratio between two time series filters. + "denominator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The denominator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "numerator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The numerator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after the ratio is computed. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesQueryLanguage": "A String", # A query used to fetch time series with MQL. + "unitOverride": "A String", # The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in MetricDescriptor. + }, + "valueType": "A String", # The type of the filter value. If value_type is not provided, it will be inferred from the default_value. If neither value_type nor default_value is provided, value_type will be set to STRING by default. }, ], "displayName": "A String", # Required. The mutable, human-readable name. @@ -5589,9 +5783,106 @@

Method Details

"dashboardFilters": [ # Filters to reduce the amount of data charted based on the filter criteria. { # A filter to reduce the amount of data charted in relevant widgets. "filterType": "A String", # The specified filter type - "labelKey": "A String", # Required. The key for the label - "stringValue": "A String", # A variable-length string value. + "labelKey": "A String", # Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise. + "stringArray": { # An array of strings # A list of possible string values for the filter + "values": [ # The values of the array + "A String", + ], + }, + "stringArrayValue": { # An array of strings # An array of variable-length string values. If this field is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED + "values": [ # The values of the array + "A String", + ], + }, + "stringValue": "A String", # A variable-length string value. If this field is set, value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED "templateVariable": "A String", # The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard. + "timeSeriesQuery": { # TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. # A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported + "opsAnalyticsQuery": { # Preview: A query that produces an aggregated response and supporting data. This is a preview feature and may be subject to change before final release. # Preview: A query used to fetch a time series, category series, or numeric series with SQL. This is a preview feature and may be subject to change before final release. + "sql": "A String", # A SQL query to fetch time series, category series, or numeric series data. + }, + "outputFullDuration": True or False, # Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like - XyChart - Scorecard's spark chart + "prometheusQuery": "A String", # A query used to fetch time series with PromQL. + "timeSeriesFilter": { # A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method. # Filter parameters to fetch time series. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after aggregation is applied. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesFilterRatio": { # A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series. # Parameters to fetch a ratio between two time series filters. + "denominator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The denominator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "numerator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The numerator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after the ratio is computed. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesQueryLanguage": "A String", # A query used to fetch time series with MQL. + "unitOverride": "A String", # The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in MetricDescriptor. + }, + "valueType": "A String", # The type of the filter value. If value_type is not provided, it will be inferred from the default_value. If neither value_type nor default_value is provided, value_type will be set to STRING by default. }, ], "displayName": "A String", # Required. The mutable, human-readable name. @@ -8019,9 +8310,106 @@

Method Details

"dashboardFilters": [ # Filters to reduce the amount of data charted based on the filter criteria. { # A filter to reduce the amount of data charted in relevant widgets. "filterType": "A String", # The specified filter type - "labelKey": "A String", # Required. The key for the label - "stringValue": "A String", # A variable-length string value. + "labelKey": "A String", # Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise. + "stringArray": { # An array of strings # A list of possible string values for the filter + "values": [ # The values of the array + "A String", + ], + }, + "stringArrayValue": { # An array of strings # An array of variable-length string values. If this field is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED + "values": [ # The values of the array + "A String", + ], + }, + "stringValue": "A String", # A variable-length string value. If this field is set, value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED "templateVariable": "A String", # The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard. + "timeSeriesQuery": { # TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. # A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported + "opsAnalyticsQuery": { # Preview: A query that produces an aggregated response and supporting data. This is a preview feature and may be subject to change before final release. # Preview: A query used to fetch a time series, category series, or numeric series with SQL. This is a preview feature and may be subject to change before final release. + "sql": "A String", # A SQL query to fetch time series, category series, or numeric series data. + }, + "outputFullDuration": True or False, # Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like - XyChart - Scorecard's spark chart + "prometheusQuery": "A String", # A query used to fetch time series with PromQL. + "timeSeriesFilter": { # A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method. # Filter parameters to fetch time series. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after aggregation is applied. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesFilterRatio": { # A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series. # Parameters to fetch a ratio between two time series filters. + "denominator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The denominator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "numerator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The numerator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after the ratio is computed. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesQueryLanguage": "A String", # A query used to fetch time series with MQL. + "unitOverride": "A String", # The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in MetricDescriptor. + }, + "valueType": "A String", # The type of the filter value. If value_type is not provided, it will be inferred from the default_value. If neither value_type nor default_value is provided, value_type will be set to STRING by default. }, ], "displayName": "A String", # Required. The mutable, human-readable name. @@ -10457,9 +10845,106 @@

Method Details

"dashboardFilters": [ # Filters to reduce the amount of data charted based on the filter criteria. { # A filter to reduce the amount of data charted in relevant widgets. "filterType": "A String", # The specified filter type - "labelKey": "A String", # Required. The key for the label - "stringValue": "A String", # A variable-length string value. + "labelKey": "A String", # Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise. + "stringArray": { # An array of strings # A list of possible string values for the filter + "values": [ # The values of the array + "A String", + ], + }, + "stringArrayValue": { # An array of strings # An array of variable-length string values. If this field is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED + "values": [ # The values of the array + "A String", + ], + }, + "stringValue": "A String", # A variable-length string value. If this field is set, value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED "templateVariable": "A String", # The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard. + "timeSeriesQuery": { # TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. # A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported + "opsAnalyticsQuery": { # Preview: A query that produces an aggregated response and supporting data. This is a preview feature and may be subject to change before final release. # Preview: A query used to fetch a time series, category series, or numeric series with SQL. This is a preview feature and may be subject to change before final release. + "sql": "A String", # A SQL query to fetch time series, category series, or numeric series data. + }, + "outputFullDuration": True or False, # Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like - XyChart - Scorecard's spark chart + "prometheusQuery": "A String", # A query used to fetch time series with PromQL. + "timeSeriesFilter": { # A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method. # Filter parameters to fetch time series. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after aggregation is applied. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesFilterRatio": { # A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series. # Parameters to fetch a ratio between two time series filters. + "denominator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The denominator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "numerator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The numerator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after the ratio is computed. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesQueryLanguage": "A String", # A query used to fetch time series with MQL. + "unitOverride": "A String", # The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in MetricDescriptor. + }, + "valueType": "A String", # The type of the filter value. If value_type is not provided, it will be inferred from the default_value. If neither value_type nor default_value is provided, value_type will be set to STRING by default. }, ], "displayName": "A String", # Required. The mutable, human-readable name. @@ -12877,9 +13362,106 @@

Method Details

"dashboardFilters": [ # Filters to reduce the amount of data charted based on the filter criteria. { # A filter to reduce the amount of data charted in relevant widgets. "filterType": "A String", # The specified filter type - "labelKey": "A String", # Required. The key for the label - "stringValue": "A String", # A variable-length string value. + "labelKey": "A String", # Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise. + "stringArray": { # An array of strings # A list of possible string values for the filter + "values": [ # The values of the array + "A String", + ], + }, + "stringArrayValue": { # An array of strings # An array of variable-length string values. If this field is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED + "values": [ # The values of the array + "A String", + ], + }, + "stringValue": "A String", # A variable-length string value. If this field is set, value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED "templateVariable": "A String", # The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard. + "timeSeriesQuery": { # TimeSeriesQuery collects the set of supported methods for querying time series data from the Stackdriver metrics API. # A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported + "opsAnalyticsQuery": { # Preview: A query that produces an aggregated response and supporting data. This is a preview feature and may be subject to change before final release. # Preview: A query used to fetch a time series, category series, or numeric series with SQL. This is a preview feature and may be subject to change before final release. + "sql": "A String", # A SQL query to fetch time series, category series, or numeric series data. + }, + "outputFullDuration": True or False, # Optional. If set, Cloud Monitoring will treat the full query duration as the alignment period so that there will be only 1 output value.*Note: This could override the configured alignment period except for the cases where a series of data points are expected, like - XyChart - Scorecard's spark chart + "prometheusQuery": "A String", # A query used to fetch time series with PromQL. + "timeSeriesFilter": { # A filter that defines a subset of time series data that is displayed in a widget. Time series data is fetched using the ListTimeSeries (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list) method. # Filter parameters to fetch time series. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after aggregation is applied. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesFilterRatio": { # A pair of time series filters that define a ratio computation. The output time series is the pair-wise division of each aligned element from the numerator and denominator time series. # Parameters to fetch a ratio between two time series filters. + "denominator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The denominator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "numerator": { # Describes a query to build the numerator or denominator of a TimeSeriesFilterRatio. # The numerator of the ratio. + "aggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # By default, the raw time series data is returned. Use this field to combine multiple time series for different views of the data. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "filter": "A String", # Required. The monitoring filter (https://cloud.google.com/monitoring/api/v3/filters) that identifies the metric types, resources, and projects to query. + }, + "pickTimeSeriesFilter": { # Describes a ranking-based time series filter. Each input time series is ranked with an aligner. The filter will allow up to num_time_series time series to pass through it, selecting them based on the relative ranking.For example, if ranking_method is METHOD_MEAN,direction is BOTTOM, and num_time_series is 3, then the 3 times series with the lowest mean values will pass through the filter. # Ranking based time series filter. + "direction": "A String", # How to use the ranking to select time series that pass through the filter. + "interval": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive).The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Select the top N streams/time series within this time interval + "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. + }, + "numTimeSeries": 42, # How many time series to allow to pass through the filter. + "rankingMethod": "A String", # ranking_method is applied to each time series independently to produce the value which will be used to compare the time series to other time series. + }, + "secondaryAggregation": { # Describes how to combine multiple time series to provide a different view of the data. Aggregation of time series is done in two steps. First, each time series in the set is aligned to the same time interval boundaries, then the set of time series is optionally reduced in number.Alignment consists of applying the per_series_aligner operation to each time series after its data has been divided into regular alignment_period time intervals. This process takes all of the data points in an alignment period, applies a mathematical transformation such as averaging, minimum, maximum, delta, etc., and converts them into a single data point per period.Reduction is when the aligned and transformed time series can optionally be combined, reducing the number of time series through similar mathematical transformations. Reduction involves applying a cross_series_reducer to all the time series, optionally sorting the time series into subsets with group_by_fields, and applying the reducer to each subset.The raw time series data can contain a huge amount of information from multiple sources. Alignment and reduction transforms this mass of data into a more manageable and representative collection of data, for example "the 95% latency across the average of all tasks in a cluster". This representative data can be more easily graphed and comprehended, and the individual time series data is still available for later drilldown. For more details, see Filtering and aggregation (https://cloud.google.com/monitoring/api/v3/aggregation). # Apply a second aggregation after the ratio is computed. + "alignmentPeriod": "A String", # The alignment_period specifies a time interval, in seconds, that is used to divide the data in all the time series into consistent blocks of time. This will be done before the per-series aligner can be applied to the data.The value must be at least 60 seconds. If a per-series aligner other than ALIGN_NONE is specified, this field is required or an error is returned. If no per-series aligner is specified, or the aligner ALIGN_NONE is specified, then this field is ignored.The maximum value of the alignment_period is 2 years, or 104 weeks. + "crossSeriesReducer": "A String", # The reduction operation to be used to combine time series into a single time series, where the value of each data point in the resulting series is a function of all the already aligned values in the input time series.Not all reducer operations can be applied to all time series. The valid choices depend on the metric_kind and the value_type of the original time series. Reduction can yield a time series with a different metric_kind or value_type than the input time series.Time series data must first be aligned (see per_series_aligner) in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified, and must not be ALIGN_NONE. An alignment_period must also be specified; otherwise, an error is returned. + "groupByFields": [ # The set of fields to preserve when cross_series_reducer is specified. The group_by_fields determine how the time series are partitioned into subsets prior to applying the aggregation operation. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The cross_series_reducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in group_by_fields are aggregated away. If group_by_fields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If cross_series_reducer is not defined, this field is ignored. + "A String", + ], + "perSeriesAligner": "A String", # An Aligner describes how to bring the data points in a single time series into temporal alignment. Except for ALIGN_NONE, all alignments cause all the data points in an alignment_period to be mathematically grouped together, resulting in a single data point for each alignment_period with end timestamp at the end of the period.Not all alignment operations may be applied to all time series. The valid choices depend on the metric_kind and value_type of the original time series. Alignment can change the metric_kind or the value_type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If cross_series_reducer is specified, then per_series_aligner must be specified and not equal to ALIGN_NONE and alignment_period must be specified; otherwise, an error is returned. + }, + "statisticalTimeSeriesFilter": { # A filter that ranks streams based on their statistical relation to other streams in a request. Note: This field is deprecated and completely ignored by the API. # Statistics based time series filter. Note: This field is deprecated and completely ignored by the API. + "numTimeSeries": 42, # How many time series to output. + "rankingMethod": "A String", # rankingMethod is applied to a set of time series, and then the produced value for each individual time series is used to compare a given time series to others. These are methods that cannot be applied stream-by-stream, but rather require the full context of a request to evaluate time series. + }, + }, + "timeSeriesQueryLanguage": "A String", # A query used to fetch time series with MQL. + "unitOverride": "A String", # The unit of data contained in fetched time series. If non-empty, this unit will override any unit that accompanies fetched data. The format is the same as the unit (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors) field in MetricDescriptor. + }, + "valueType": "A String", # The type of the filter value. If value_type is not provided, it will be inferred from the default_value. If neither value_type nor default_value is provided, value_type will be set to STRING by default. }, ], "displayName": "A String", # Required. The mutable, human-readable name. diff --git a/docs/dyn/monitoring_v1.projects.location.prometheus.api.v1.html b/docs/dyn/monitoring_v1.projects.location.prometheus.api.v1.html index ba7bc7edd22..dffb53ce524 100644 --- a/docs/dyn/monitoring_v1.projects.location.prometheus.api.v1.html +++ b/docs/dyn/monitoring_v1.projects.location.prometheus.api.v1.html @@ -113,7 +113,7 @@

Method Details

Lists labels for metrics.
 
 Args:
-  name: string, The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER. (required)
+  name: string, Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER. (required)
   location: string, Location of the resource information. Has to be "global" now. (required)
   body: object, The request body.
     The object takes the form of:
@@ -148,7 +148,7 @@ 

Method Details

Evaluate a PromQL query at a single point in time.
 
 Args:
-  name: string, The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. (required)
+  name: string, Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. (required)
   location: string, Location of the resource information. Has to be "global" now. (required)
   body: object, The request body.
     The object takes the form of:
@@ -183,7 +183,7 @@ 

Method Details

Lists exemplars relevant to a given PromQL query,
 
 Args:
-  name: string, The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. (required)
+  name: string, Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. (required)
   location: string, Location of the resource information. Has to be "global" now. (required)
   body: object, The request body.
     The object takes the form of:
@@ -218,7 +218,7 @@ 

Method Details

Evaluate a PromQL query with start, end time range.
 
 Args:
-  name: string, The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. (required)
+  name: string, Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. (required)
   location: string, Location of the resource information. Has to be "global" now. (required)
   body: object, The request body.
     The object takes the form of:
diff --git a/docs/dyn/monitoring_v1.projects.location.prometheus.api.v1.label.html b/docs/dyn/monitoring_v1.projects.location.prometheus.api.v1.label.html
index 133f2b81b3f..9e3d19be940 100644
--- a/docs/dyn/monitoring_v1.projects.location.prometheus.api.v1.label.html
+++ b/docs/dyn/monitoring_v1.projects.location.prometheus.api.v1.label.html
@@ -91,7 +91,7 @@ 

Method Details

Lists possible values for a given label name.
 
 Args:
-  name: string, The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER. (required)
+  name: string, Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER. (required)
   location: string, Location of the resource information. Has to be "global" now. (required)
   label: string, The label name for which values are queried. (required)
   end: string, The end time to evaluate the query for. Either floating point UNIX seconds or RFC3339 formatted timestamp.
diff --git a/docs/dyn/monitoring_v3.folders.timeSeries.html b/docs/dyn/monitoring_v3.folders.timeSeries.html
index b8046347848..2a805e9ad93 100644
--- a/docs/dyn/monitoring_v3.folders.timeSeries.html
+++ b/docs/dyn/monitoring_v3.folders.timeSeries.html
@@ -206,6 +206,7 @@ 

Method Details

"nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. "timeSeries": [ # One or more time series that match the filter included in the request. { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. + "description": "A String", # Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. "metadata": { # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. # Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored. "systemLabels": { # Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } "a_key": "", # Properties of the object. @@ -281,7 +282,7 @@

Method Details

}, "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). }, - "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. + "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty or "1". "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. }, ], diff --git a/docs/dyn/monitoring_v3.organizations.timeSeries.html b/docs/dyn/monitoring_v3.organizations.timeSeries.html index a2f85fbf47e..511e5901c24 100644 --- a/docs/dyn/monitoring_v3.organizations.timeSeries.html +++ b/docs/dyn/monitoring_v3.organizations.timeSeries.html @@ -206,6 +206,7 @@

Method Details

"nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. "timeSeries": [ # One or more time series that match the filter included in the request. { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. + "description": "A String", # Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. "metadata": { # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. # Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored. "systemLabels": { # Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } "a_key": "", # Properties of the object. @@ -281,7 +282,7 @@

Method Details

}, "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). }, - "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. + "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty or "1". "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. }, ], diff --git a/docs/dyn/monitoring_v3.projects.alertPolicies.html b/docs/dyn/monitoring_v3.projects.alertPolicies.html index 4b412c824a8..78e4d4b02c7 100644 --- a/docs/dyn/monitoring_v3.projects.alertPolicies.html +++ b/docs/dyn/monitoring_v3.projects.alertPolicies.html @@ -121,7 +121,7 @@

Method Details

"renotifyInterval": "A String", # The frequency at which to send reminder notifications for open incidents. }, ], - "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based. + "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition. "period": "A String", # Not more than one notification per period. }, }, @@ -269,7 +269,7 @@

Method Details

"renotifyInterval": "A String", # The frequency at which to send reminder notifications for open incidents. }, ], - "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based. + "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition. "period": "A String", # Not more than one notification per period. }, }, @@ -442,7 +442,7 @@

Method Details

"renotifyInterval": "A String", # The frequency at which to send reminder notifications for open incidents. }, ], - "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based. + "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition. "period": "A String", # Not more than one notification per period. }, }, @@ -603,7 +603,7 @@

Method Details

"renotifyInterval": "A String", # The frequency at which to send reminder notifications for open incidents. }, ], - "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based. + "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition. "period": "A String", # Not more than one notification per period. }, }, @@ -771,7 +771,7 @@

Method Details

"renotifyInterval": "A String", # The frequency at which to send reminder notifications for open incidents. }, ], - "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based. + "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition. "period": "A String", # Not more than one notification per period. }, }, @@ -920,7 +920,7 @@

Method Details

"renotifyInterval": "A String", # The frequency at which to send reminder notifications for open incidents. }, ], - "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based. + "notificationRateLimit": { # Control over the rate of notifications sent to this alert policy's notification channels. # Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition. "period": "A String", # Not more than one notification per period. }, }, diff --git a/docs/dyn/monitoring_v3.projects.timeSeries.html b/docs/dyn/monitoring_v3.projects.timeSeries.html index 4c4c56b296e..54c56612b0f 100644 --- a/docs/dyn/monitoring_v3.projects.timeSeries.html +++ b/docs/dyn/monitoring_v3.projects.timeSeries.html @@ -113,6 +113,7 @@

Method Details

{ # The CreateTimeSeries request. "timeSeries": [ # Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.The maximum number of TimeSeries objects per Create request is 200. { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. + "description": "A String", # Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. "metadata": { # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. # Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored. "systemLabels": { # Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } "a_key": "", # Properties of the object. @@ -188,7 +189,7 @@

Method Details

}, "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). }, - "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. + "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty or "1". "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. }, ], @@ -218,6 +219,7 @@

Method Details

{ # The CreateTimeSeries request. "timeSeries": [ # Required. The new data to be added to a list of time series. Adds at most one data point to each of several time series. The new data point must be more recent than any other point in its time series. Each TimeSeries value must fully specify a unique time series by supplying all label values for the metric and the monitored resource.The maximum number of TimeSeries objects per Create request is 200. { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. + "description": "A String", # Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. "metadata": { # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. # Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored. "systemLabels": { # Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } "a_key": "", # Properties of the object. @@ -293,7 +295,7 @@

Method Details

}, "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). }, - "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. + "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty or "1". "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. }, ], @@ -428,6 +430,7 @@

Method Details

"nextPageToken": "A String", # If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as page_token in the next call to this method. "timeSeries": [ # One or more time series that match the filter included in the request. { # A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series. + "description": "A String", # Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries. "metadata": { # Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Monitoring and Logging use an ingestion pipeline to extract metadata for cloud resources of all types, and store the metadata in this message. # Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored. "systemLabels": { # Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google, including "machine_image", "vpc", "subnet_id", "security_group", "name", etc. System label values can be only strings, Boolean values, or a list of strings. For example: { "name": "my-test-instance", "security_group": ["a", "b", "c"], "spot_instance": false } "a_key": "", # Properties of the object. @@ -503,7 +506,7 @@

Method Details

}, "type": "A String", # Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance. For a list of types, see Monitoring resource types (https://cloud.google.com/monitoring/api/resources) and Logging resource types (https://cloud.google.com/logging/docs/api/v2/resource-list). }, - "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. + "unit": "A String", # The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty or "1". "valueType": "A String", # The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field. }, ], diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html index 2f0b6eb9c0b..11a583a3f10 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.serviceConnectionPolicies.html @@ -168,7 +168,7 @@

Method Details

"state": "A String", # State of the PSC Connection }, ], - "serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. + "serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. "updateTime": "A String", # Output only. Time when the ServiceConnectionMap was updated. } @@ -303,7 +303,7 @@

Method Details

"state": "A String", # State of the PSC Connection }, ], - "serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. + "serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. "updateTime": "A String", # Output only. Time when the ServiceConnectionMap was updated. }
@@ -426,7 +426,7 @@

Method Details

"state": "A String", # State of the PSC Connection }, ], - "serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. + "serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. "updateTime": "A String", # Output only. Time when the ServiceConnectionMap was updated. }, ], @@ -508,7 +508,7 @@

Method Details

"state": "A String", # State of the PSC Connection }, ], - "serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. + "serviceClass": "A String", # The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx. "updateTime": "A String", # Output only. Time when the ServiceConnectionMap was updated. } diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index f1ff9342e6c..b4c3562e103 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -331,6 +331,7 @@

Method Details

"A String", ], "networkUri": "A String", # URI of a Compute Engine network. + "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). "serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, @@ -779,6 +780,7 @@

Method Details

"A String", ], "networkUri": "A String", # URI of a Compute Engine network. + "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). "serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, @@ -1218,6 +1220,7 @@

Method Details

"A String", ], "networkUri": "A String", # URI of a Compute Engine network. + "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). "serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, @@ -1616,6 +1619,7 @@

Method Details

"A String", ], "networkUri": "A String", # URI of a Compute Engine network. + "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). "serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index fb002e7db3d..ef204280dad 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -332,6 +332,7 @@

Method Details

"A String", ], "networkUri": "A String", # URI of a Compute Engine network. + "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). "serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, @@ -781,6 +782,7 @@

Method Details

"A String", ], "networkUri": "A String", # URI of a Compute Engine network. + "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). "serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, @@ -1221,6 +1223,7 @@

Method Details

"A String", ], "networkUri": "A String", # URI of a Compute Engine network. + "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). "serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, @@ -1620,6 +1623,7 @@

Method Details

"A String", ], "networkUri": "A String", # URI of a Compute Engine network. + "pscNetworkAttachmentUri": "A String", # URI of the PSC network attachment the NIC is attached to (if relevant). "serviceAccount": "A String", # Service account authorized for the instance. "uri": "A String", # URI of a Compute Engine instance. }, diff --git a/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html new file mode 100644 index 00000000000..fe046f093f8 --- /dev/null +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.authzPolicies.html @@ -0,0 +1,960 @@ + + + +

Network Security API . projects . locations . authzPolicies

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a new AuthzPolicy in a given project and location.

+

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

+

Deletes a single AuthzPolicy.

+

+ get(name, x__xgafv=None)

+

Gets details of a single AuthzPolicy.

+

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

+

Lists AuthzPolicies in a given project and location.

+

+ list_next()

+

Retrieves the next page of results.

+

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

+

Updates the parameters of a single AuthzPolicy.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, authzPolicyId=None, body=None, requestId=None, x__xgafv=None) +
Creates a new AuthzPolicy in a given project and location.
+
+Args:
+  parent: string, Required. The parent resource of the `AuthzPolicy` resource. Must be in the format `projects/{project}/locations/{location}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `AuthzPolicy` is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.
+  "action": "A String", # Required. Can be one of ALLOW, DENY, CUSTOM. When the action is CUSTOM, customProvider must be specified. When the action is ALLOW, only requests matching the policy will be allowed. When the action is DENY, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any DENY policies that match the request, the request is denied. 3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "customProvider": { # Allows delegating authorization decisions to Cloud IAP or to Service Extensions. # Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified.
+    "authzExtension": { # Optional. Delegate authorization decision to user authored extension. Only one of cloudIap or authzExtension can be specified. # Optional. Delegate authorization decision to user authored Service Extension. Only one of cloudIap or authzExtension can be specified.
+      "resources": [ # Required. A list of references to authorization extensions that will be invoked for requests matching this policy. Limited to 1 custom provider.
+        "A String",
+      ],
+    },
+    "cloudIap": { # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places.
+    },
+  },
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "httpRules": [ # Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action.
+    { # Conditions to match against the incoming request.
+      "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of one or more sources of a request.
+        "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified.
+          { # Describes the properties of a single source.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.
+              { # Describes the properties of a client VM resource accessing the internal application load balancers.
+                "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request.
+                  "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                  "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                  "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                  "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                  "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                },
+                "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.
+                  "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.
+                    "A String",
+                  ],
+                },
+              },
+            ],
+          },
+        ],
+        "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 10 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.
+          { # Describes the properties of a single source.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.
+              { # Describes the properties of a client VM resource accessing the internal application load balancers.
+                "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request.
+                  "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                  "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                  "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                  "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                  "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                },
+                "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.
+                  "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.
+                    "A String",
+                  ],
+                },
+              },
+            ],
+          },
+        ],
+      },
+      "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of one or more targets of a request.
+        "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified.
+          { # Describes properties of one or more targets of a request.
+            "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header.
+              "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                { # Determines how a HTTP header should be matched.
+                  "name": "A String", # Optional. Specifies the name of the header in the request.
+                  "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                },
+              ],
+            },
+            "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.
+              "A String",
+            ],
+            "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+          },
+        ],
+        "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 10 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.
+          { # Describes properties of one or more targets of a request.
+            "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header.
+              "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                { # Determines how a HTTP header should be matched.
+                  "name": "A String", # Optional. Specifies the name of the header in the request.
+                  "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                },
+              ],
+            },
+            "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.
+              "A String",
+            ],
+            "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+          },
+        ],
+      },
+      "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes.
+    },
+  ],
+  "labels": { # Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+    "a_key": "A String",
+  },
+  "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.
+  "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to.
+    "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).
+    "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied.
+      "A String",
+    ],
+  },
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  authzPolicyId: string, Required. User-provided ID of the `AuthzPolicy` resource to be created.
+  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 can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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, x__xgafv=None) +
Deletes a single AuthzPolicy.
+
+Args:
+  name: string, Required. The name of the `AuthzPolicy` resource to delete. Must be in the format `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. (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 can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  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 AuthzPolicy.
+
+Args:
+  name: string, Required. A name of the `AuthzPolicy` resource to get. Must be in the format `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # `AuthzPolicy` is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.
+  "action": "A String", # Required. Can be one of ALLOW, DENY, CUSTOM. When the action is CUSTOM, customProvider must be specified. When the action is ALLOW, only requests matching the policy will be allowed. When the action is DENY, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any DENY policies that match the request, the request is denied. 3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "customProvider": { # Allows delegating authorization decisions to Cloud IAP or to Service Extensions. # Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified.
+    "authzExtension": { # Optional. Delegate authorization decision to user authored extension. Only one of cloudIap or authzExtension can be specified. # Optional. Delegate authorization decision to user authored Service Extension. Only one of cloudIap or authzExtension can be specified.
+      "resources": [ # Required. A list of references to authorization extensions that will be invoked for requests matching this policy. Limited to 1 custom provider.
+        "A String",
+      ],
+    },
+    "cloudIap": { # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places.
+    },
+  },
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "httpRules": [ # Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action.
+    { # Conditions to match against the incoming request.
+      "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of one or more sources of a request.
+        "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified.
+          { # Describes the properties of a single source.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.
+              { # Describes the properties of a client VM resource accessing the internal application load balancers.
+                "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request.
+                  "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                  "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                  "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                  "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                  "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                },
+                "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.
+                  "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.
+                    "A String",
+                  ],
+                },
+              },
+            ],
+          },
+        ],
+        "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 10 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.
+          { # Describes the properties of a single source.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.
+              { # Describes the properties of a client VM resource accessing the internal application load balancers.
+                "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request.
+                  "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                  "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                  "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                  "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                  "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                },
+                "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.
+                  "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.
+                    "A String",
+                  ],
+                },
+              },
+            ],
+          },
+        ],
+      },
+      "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of one or more targets of a request.
+        "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified.
+          { # Describes properties of one or more targets of a request.
+            "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header.
+              "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                { # Determines how a HTTP header should be matched.
+                  "name": "A String", # Optional. Specifies the name of the header in the request.
+                  "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                },
+              ],
+            },
+            "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.
+              "A String",
+            ],
+            "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+          },
+        ],
+        "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 10 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.
+          { # Describes properties of one or more targets of a request.
+            "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header.
+              "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                { # Determines how a HTTP header should be matched.
+                  "name": "A String", # Optional. Specifies the name of the header in the request.
+                  "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                },
+              ],
+            },
+            "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.
+              "A String",
+            ],
+            "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+          },
+        ],
+      },
+      "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes.
+    },
+  ],
+  "labels": { # Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+    "a_key": "A String",
+  },
+  "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.
+  "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to.
+    "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).
+    "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied.
+      "A String",
+    ],
+  },
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+ +
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) +
Lists AuthzPolicies in a given project and location.
+
+Args:
+  parent: string, Required. The project and location from which the `AuthzPolicy` resources are listed, specified in the following format: `projects/{project}/locations/{location}`. (required)
+  filter: string, Optional. Filtering results.
+  orderBy: string, Optional. Hint for how to order the results.
+  pageSize: integer, Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.
+  pageToken: string, Optional. A token identifying a page of results that the server returns.
+  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 `AuthzPolicy` resources.
+  "authzPolicies": [ # The list of `AuthzPolicy` resources.
+    { # `AuthzPolicy` is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.
+      "action": "A String", # Required. Can be one of ALLOW, DENY, CUSTOM. When the action is CUSTOM, customProvider must be specified. When the action is ALLOW, only requests matching the policy will be allowed. When the action is DENY, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any DENY policies that match the request, the request is denied. 3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request.
+      "createTime": "A String", # Output only. The timestamp when the resource was created.
+      "customProvider": { # Allows delegating authorization decisions to Cloud IAP or to Service Extensions. # Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified.
+        "authzExtension": { # Optional. Delegate authorization decision to user authored extension. Only one of cloudIap or authzExtension can be specified. # Optional. Delegate authorization decision to user authored Service Extension. Only one of cloudIap or authzExtension can be specified.
+          "resources": [ # Required. A list of references to authorization extensions that will be invoked for requests matching this policy. Limited to 1 custom provider.
+            "A String",
+          ],
+        },
+        "cloudIap": { # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places.
+        },
+      },
+      "description": "A String", # Optional. A human-readable description of the resource.
+      "httpRules": [ # Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action.
+        { # Conditions to match against the incoming request.
+          "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of one or more sources of a request.
+            "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified.
+              { # Describes the properties of a single source.
+                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.
+                  { # Determines how a string value should be matched.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                ],
+                "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.
+                  { # Describes the properties of a client VM resource accessing the internal application load balancers.
+                    "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request.
+                      "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                      "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                      "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                      "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                      "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                    },
+                    "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.
+                      "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.
+                        "A String",
+                      ],
+                    },
+                  },
+                ],
+              },
+            ],
+            "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 10 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.
+              { # Describes the properties of a single source.
+                "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.
+                  { # Determines how a string value should be matched.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                ],
+                "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.
+                  { # Describes the properties of a client VM resource accessing the internal application load balancers.
+                    "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request.
+                      "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                      "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                      "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                      "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                      "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                    },
+                    "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.
+                      "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.
+                        "A String",
+                      ],
+                    },
+                  },
+                ],
+              },
+            ],
+          },
+          "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of one or more targets of a request.
+            "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified.
+              { # Describes properties of one or more targets of a request.
+                "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header.
+                  "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                    { # Determines how a HTTP header should be matched.
+                      "name": "A String", # Optional. Specifies the name of the header in the request.
+                      "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed.
+                        "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                        "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                        "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                        "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                        "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                      },
+                    },
+                  ],
+                },
+                "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                  { # Determines how a string value should be matched.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                ],
+                "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.
+                  "A String",
+                ],
+                "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.
+                  { # Determines how a string value should be matched.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                ],
+              },
+            ],
+            "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 10 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.
+              { # Describes properties of one or more targets of a request.
+                "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header.
+                  "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                    { # Determines how a HTTP header should be matched.
+                      "name": "A String", # Optional. Specifies the name of the header in the request.
+                      "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed.
+                        "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                        "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                        "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                        "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                        "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                      },
+                    },
+                  ],
+                },
+                "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                  { # Determines how a string value should be matched.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                ],
+                "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.
+                  "A String",
+                ],
+                "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.
+                  { # Determines how a string value should be matched.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                ],
+              },
+            ],
+          },
+          "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes.
+        },
+      ],
+      "labels": { # Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+        "a_key": "A String",
+      },
+      "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.
+      "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to.
+        "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).
+        "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied.
+          "A String",
+        ],
+      },
+      "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+    },
+  ],
+  "nextPageToken": "A String", # A token identifying a page of results that the server returns.
+  "unreachable": [ # 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 AuthzPolicy.
+
+Args:
+  name: string, Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # `AuthzPolicy` is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.
+  "action": "A String", # Required. Can be one of ALLOW, DENY, CUSTOM. When the action is CUSTOM, customProvider must be specified. When the action is ALLOW, only requests matching the policy will be allowed. When the action is DENY, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any DENY policies that match the request, the request is denied. 3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request.
+  "createTime": "A String", # Output only. The timestamp when the resource was created.
+  "customProvider": { # Allows delegating authorization decisions to Cloud IAP or to Service Extensions. # Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified.
+    "authzExtension": { # Optional. Delegate authorization decision to user authored extension. Only one of cloudIap or authzExtension can be specified. # Optional. Delegate authorization decision to user authored Service Extension. Only one of cloudIap or authzExtension can be specified.
+      "resources": [ # Required. A list of references to authorization extensions that will be invoked for requests matching this policy. Limited to 1 custom provider.
+        "A String",
+      ],
+    },
+    "cloudIap": { # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places. # Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places.
+    },
+  },
+  "description": "A String", # Optional. A human-readable description of the resource.
+  "httpRules": [ # Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action.
+    { # Conditions to match against the incoming request.
+      "from": { # Describes properties of one or more sources of a request. # Optional. Describes properties of one or more sources of a request.
+        "notSources": [ # Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified.
+          { # Describes the properties of a single source.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.
+              { # Describes the properties of a client VM resource accessing the internal application load balancers.
+                "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request.
+                  "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                  "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                  "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                  "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                  "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                },
+                "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.
+                  "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.
+                    "A String",
+                  ],
+                },
+              },
+            ],
+          },
+        ],
+        "sources": [ # Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 10 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.
+          { # Describes the properties of a single source.
+            "principals": [ # Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "resources": [ # Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.
+              { # Describes the properties of a client VM resource accessing the internal application load balancers.
+                "iamServiceAccount": { # Determines how a string value should be matched. # Optional. An IAM service account to match against the source service account of the VM sending the request.
+                  "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                  "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                  "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                  "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                  "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                },
+                "tagValueIdSet": { # Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. # Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.
+                  "ids": [ # Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.
+                    "A String",
+                  ],
+                },
+              },
+            ],
+          },
+        ],
+      },
+      "to": { # Describes properties of one or more targets of a request. # Optional. Describes properties of one or more targets of a request.
+        "notOperations": [ # Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified.
+          { # Describes properties of one or more targets of a request.
+            "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header.
+              "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                { # Determines how a HTTP header should be matched.
+                  "name": "A String", # Optional. Specifies the name of the header in the request.
+                  "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                },
+              ],
+            },
+            "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.
+              "A String",
+            ],
+            "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+          },
+        ],
+        "operations": [ # Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 10 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.
+          { # Describes properties of one or more targets of a request.
+            "headerSet": { # Describes a set of HTTP headers to match against. # Optional. A list of headers to match against in http header.
+              "headers": [ # Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+                { # Determines how a HTTP header should be matched.
+                  "name": "A String", # Optional. Specifies the name of the header in the request.
+                  "value": { # Determines how a string value should be matched. # Optional. Specifies how the header match will be performed.
+                    "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                    "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                    "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                    "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                    "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+                  },
+                },
+              ],
+            },
+            "hosts": [ # Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+            "methods": [ # Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.
+              "A String",
+            ],
+            "paths": [ # Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.
+              { # Determines how a string value should be matched.
+                "contains": "A String", # The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``
+                "exact": "A String", # The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.
+                "ignoreCase": True or False, # If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.
+                "prefix": "A String", # The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``
+                "suffix": "A String", # The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``
+              },
+            ],
+          },
+        ],
+      },
+      "when": "A String", # Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes.
+    },
+  ],
+  "labels": { # Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).
+    "a_key": "A String",
+  },
+  "name": "A String", # Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.
+  "target": { # Specifies the set of targets to which this policy should be applied to. # Required. Specifies the set of resources to which this policy should be applied to.
+    "loadBalancingScheme": "A String", # Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).
+    "resources": [ # Required. A list of references to the Forwarding Rules on which this policy will be applied.
+      "A String",
+    ],
+  },
+  "updateTime": "A String", # Output only. The timestamp when the resource was updated.
+}
+
+  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 can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
+  updateMask: string, Required. Used to specify the fields to be overwritten in the `AuthzPolicy` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.
+  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/networksecurity_v1beta1.projects.locations.html b/docs/dyn/networksecurity_v1beta1.projects.locations.html index 93efe8a8305..65105b53073 100644 --- a/docs/dyn/networksecurity_v1beta1.projects.locations.html +++ b/docs/dyn/networksecurity_v1beta1.projects.locations.html @@ -84,6 +84,11 @@

Instance Methods

Returns the authorizationPolicies Resource.

+

+ authzPolicies() +

+

Returns the authzPolicies Resource.

+

clientTlsPolicies()

diff --git a/docs/dyn/playintegrity_v1.v1.html b/docs/dyn/playintegrity_v1.v1.html index 416f557d030..f8d65ce435d 100644 --- a/docs/dyn/playintegrity_v1.v1.html +++ b/docs/dyn/playintegrity_v1.v1.html @@ -124,6 +124,18 @@

Method Details

"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. + "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. + "bitThird": True or False, # Required. Third recall bit value. + }, + "writeDates": { # Contains the recall bits write dates. # Required. Contains the recall bits write dates. + "yyyymmFirst": 42, # Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the first bit. Note that this value won't be set if the first bit is false. + "yyyymmSecond": 42, # Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the second bit. Note that this value won't be set if the second bit is false. + "yyyymmThird": 42, # Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the third bit. Note that this value won't be set if the third bit is false. + }, + }, "deviceRecognitionVerdict": [ # Details about the integrity of the device the app is running on. "A String", ], diff --git a/docs/dyn/recaptchaenterprise_v1.projects.keys.html b/docs/dyn/recaptchaenterprise_v1.projects.keys.html index c4935c6164b..74affee96a3 100644 --- a/docs/dyn/recaptchaenterprise_v1.projects.keys.html +++ b/docs/dyn/recaptchaenterprise_v1.projects.keys.html @@ -74,6 +74,9 @@

reCAPTCHA Enterprise API . projects . keys

Instance Methods

+

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

+

Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned.

close()

Close httplib2 connections.

@@ -105,6 +108,34 @@

Instance Methods

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.

Method Details

+
+ addIpOverride(name, body=None, x__xgafv=None) +
Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned.
+
+Args:
+  name: string, Required. The name of the key to which the IP override is added, in the format `projects/{project}/keys/{key}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # The AddIpOverride request message.
+  "ipOverrideData": { # Information about the IP or IP range override. # Required. IP override added to 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 AddIpOverride.
+}
+
+
close()
Close httplib2 connections.
diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html index 40f7617950a..0e62c6a9c69 100644 --- a/docs/dyn/run_v1.namespaces.configurations.html +++ b/docs/dyn/run_v1.namespaces.configurations.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -141,7 +141,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -461,7 +461,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -495,7 +495,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.domainmappings.html b/docs/dyn/run_v1.namespaces.domainmappings.html index eb351fcbf4a..1242dd85034 100644 --- a/docs/dyn/run_v1.namespaces.domainmappings.html +++ b/docs/dyn/run_v1.namespaces.domainmappings.html @@ -108,7 +108,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -181,7 +181,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -305,7 +305,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -394,7 +394,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index b75b4548f0d..7c2f1988fd6 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -114,7 +114,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -473,7 +473,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -793,7 +793,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index f59978d088f..5f5d7db7522 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -114,7 +114,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -150,7 +150,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -455,7 +455,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -491,7 +491,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -847,7 +847,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -883,7 +883,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1205,7 +1205,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1241,7 +1241,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1559,7 +1559,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1595,7 +1595,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1900,7 +1900,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1936,7 +1936,7 @@

Method Details

"startExecutionToken": "A String", # A unique string used as a suffix for creating a new execution. The Job will become ready when the execution is successfully started. The sum of job name and token length must be fewer than 63 characters. "template": { # ExecutionTemplateSpec describes the metadata and spec an Execution should have when created from a job. # Optional. Describes the execution that will be created when running a job. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Optional metadata for this Execution, including labels and annotations. The following annotation keys set properties of the created execution: * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2291,7 +2291,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index 097da119b2c..2f387a1527f 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -155,7 +155,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -475,7 +475,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.routes.html b/docs/dyn/run_v1.namespaces.routes.html index 6bff9443da8..895b06ae701 100644 --- a/docs/dyn/run_v1.namespaces.routes.html +++ b/docs/dyn/run_v1.namespaces.routes.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -208,7 +208,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index e61f491c7f2..f8a05e5ba02 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -111,7 +111,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -145,7 +145,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -473,7 +473,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -507,7 +507,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -886,7 +886,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -920,7 +920,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1264,7 +1264,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1298,7 +1298,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1638,7 +1638,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1672,7 +1672,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2000,7 +2000,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2034,7 +2034,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index 324354ae08d..7e820236e34 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -430,7 +430,7 @@

Method Details

"apiVersion": "A String", # Optional. APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. "kind": "A String", # Optional. Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional. Standard object's metadata. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index 205ebf0490a..fa798666b65 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -141,7 +141,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -461,7 +461,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of resource, in this case always "Configuration". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Configuration, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -495,7 +495,7 @@

Method Details

"spec": { # ConfigurationSpec holds the desired state of the Configuration (from the client). # Spec holds the desired state of the Configuration (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Template holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.domainmappings.html b/docs/dyn/run_v1.projects.locations.domainmappings.html index df8738f7e1d..15e1272eecf 100644 --- a/docs/dyn/run_v1.projects.locations.domainmappings.html +++ b/docs/dyn/run_v1.projects.locations.domainmappings.html @@ -108,7 +108,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -181,7 +181,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -305,7 +305,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -394,7 +394,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "domains.cloudrun.com/v1". "kind": "A String", # The kind of resource, in this case "DomainMapping". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this BuildTemplate. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index fdd03828951..3f84f71ac10 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -155,7 +155,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -475,7 +475,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case "Revision". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Revision, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.routes.html b/docs/dyn/run_v1.projects.locations.routes.html index 888a1b0b0a7..348a4b7f01f 100644 --- a/docs/dyn/run_v1.projects.locations.routes.html +++ b/docs/dyn/run_v1.projects.locations.routes.html @@ -107,7 +107,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -208,7 +208,7 @@

Method Details

"apiVersion": "A String", # The API version for this call such as "serving.knative.dev/v1". "kind": "A String", # The kind of this resource, in this case always "Route". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Route, including name, namespace, labels, and annotations. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index 5f86f7fda1b..a10731d903a 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -120,7 +120,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -154,7 +154,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -482,7 +482,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -516,7 +516,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -895,7 +895,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -929,7 +929,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1321,7 +1321,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1355,7 +1355,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1695,7 +1695,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -1729,7 +1729,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2057,7 +2057,7 @@

Method Details

"apiVersion": "A String", # The API version for this call. It must be "serving.knative.dev/v1". "kind": "A String", # The kind of resource. It must be "Service". "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/default-url-disabled` * `run.googleapis.com/description` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run @@ -2091,7 +2091,7 @@

Method Details

"spec": { # ServiceSpec holds the desired state of the Route (from the client), which is used to manipulate the underlying Route and Configuration(s). # Holds the desired state of the Service (from the client). "template": { # RevisionTemplateSpec describes the data a revision should have when created from a template. # Holds the latest specification for the Revision to be stamped out. "metadata": { # google.cloud.run.meta.v1.ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create. # Optional metadata for this Revision, including labels and annotations. Name will be generated by the Configuration. The following annotation keys set properties of the created revision: * `autoscaling.knative.dev/minScale` sets the minimum number of instances. * `autoscaling.knative.dev/maxScale` sets the maximum number of instances. * `run.googleapis.com/cloudsql-instances` sets Cloud SQL connections. Multiple values should be comma separated. * `run.googleapis.com/vpc-access-connector` sets a Serverless VPC Access connector. * `run.googleapis.com/vpc-access-egress` sets VPC egress. Supported values are `all-traffic`, `all` (deprecated), and `private-ranges-only`. `all-traffic` and `all` provide the same functionality. `all` is deprecated but will continue to be supported. Prefer `all-traffic`. - "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + "annotations": { # Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. "a_key": "A String", }, "clusterName": "A String", # Not supported by Cloud Run diff --git a/docs/dyn/walletobjects_v1.genericobject.html b/docs/dyn/walletobjects_v1.genericobject.html index 4f0408b701f..9e51baebb4a 100644 --- a/docs/dyn/walletobjects_v1.genericobject.html +++ b/docs/dyn/walletobjects_v1.genericobject.html @@ -647,6 +647,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. @@ -1309,6 +1357,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. @@ -1959,6 +2055,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. @@ -2608,6 +2752,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. @@ -3273,6 +3465,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. @@ -3926,6 +4166,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. @@ -4575,6 +4863,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. @@ -5226,6 +5562,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. @@ -5875,6 +6259,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. diff --git a/docs/dyn/walletobjects_v1.jwt.html b/docs/dyn/walletobjects_v1.jwt.html index 024552cf10c..40bcd743c3f 100644 --- a/docs/dyn/walletobjects_v1.jwt.html +++ b/docs/dyn/walletobjects_v1.jwt.html @@ -7167,6 +7167,54 @@

Method Details

"uri": "A String", # The location of the image. URIs must have a scheme. }, }, + "messages": [ # An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10. + { # A message that will be displayed with a Valuable + "body": "A String", # The message body. + "displayInterval": { # The period of time that the message will be displayed to users. You can define both a `startTime` and `endTime` for each message. A message is displayed immediately after a Wallet Object is inserted unless a `startTime` is set. The message will appear in a list of messages indefinitely if `endTime` is not provided. + "end": { # End time of the interval. Offset is not required. If an offset is provided and `start` time is set, `start` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#timeInterval"`. + "start": { # Start time of the interval. Offset is not required. If an offset is provided and `end` time is set, `end` must also include an offset. + "date": "A String", # An ISO 8601 extended format date/time. Offset may or may not be required (refer to the parent field's documentation). Time may be specified up to nanosecond precision. Offsets may be specified with seconds precision (even though offset seconds is not part of ISO 8601). For example: `1985-04-12T23:20:50.52Z` would be 20 minutes and 50.52 seconds after the 23rd hour of April 12th, 1985 in UTC. `1985-04-12T19:20:50.52-04:00` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985, 4 hours before UTC (same instant in time as the above example). If the date/time is intended for a physical location in New York, this would be the equivalent of Eastern Daylight Time (EDT). Remember that offset varies in regions that observe Daylight Saving Time (or Summer Time), depending on the time of the year. `1985-04-12T19:20:50.52` would be 20 minutes and 50.52 seconds after the 19th hour of April 12th, 1985 with no offset information. Providing an offset makes this an absolute instant in time around the world. The date/time will be adjusted based on the user's time zone. For example, a time of `2018-06-19T18:30:00-04:00` will be 18:30:00 for a user in New York and 15:30:00 for a user in Los Angeles. Omitting the offset makes this a local date/time, representing several instants in time around the world. The date/time will always be in the user's current time zone. For example, a time of `2018-06-19T18:30:00` will be 18:30:00 for a user in New York and also 18:30:00 for a user in Los Angeles. This is useful when the same local date/time should apply to many physical locations across several time zones. + }, + }, + "header": "A String", # The message header. + "id": "A String", # The ID associated with a message. This field is here to enable ease of management of messages. Notice ID values could possibly duplicate across multiple messages in the same class/instance, and care must be taken to select a reasonable ID for each message. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#walletObjectMessage"`. + "localizedBody": { # Translated strings for the message body. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "localizedHeader": { # Translated strings for the message header. + "defaultValue": { # Contains the string to be displayed if no appropriate translation is available. + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#localizedString"`. + "translatedValues": [ # Contains the translations for the string. + { + "kind": "A String", # Identifies what kind of resource this is. Value: the fixed string `"walletobjects#translatedString"`. + "language": "A String", # Represents the BCP 47 language tag. Example values are "en-US", "en-GB", "de", or "de-AT". + "value": "A String", # The UTF-8 encoded translated string. + }, + ], + }, + "messageType": "A String", # The message type. + }, + ], "notifications": { # Indicates if the object needs to have notification enabled. We support only one of ExpiryNotification/UpcomingNotification. `expiryNotification` takes precedence over `upcomingNotification`. In other words if `expiryNotification` is set, we ignore the `upcomingNotification` field. # The notification settings that are enabled for this object. "expiryNotification": { # Indicates that the issuer would like Google Wallet to send expiry notifications 2 days prior to the card expiration. # A notification would be triggered at a specific time before the card expires. "enableNotification": True or False, # Indicates if the object needs to have expiry notification enabled. diff --git a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html index 58e8525e8d7..dbce211409b 100644 --- a/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html +++ b/docs/dyn/workloadmanager_v1.projects.locations.evaluations.executions.html @@ -163,7 +163,7 @@

Method Details

"evaluationId": "A String", # Output only. [Output only] Evaluation ID "externalDataSources": [ # Optional. External data sources { # Message for external data sources - "assetType": "A String", # Required. The asset type of the external data source must be one of go/cai-asset-types + "assetType": "A String", # Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data "type": "A String", # Required. Type of external data source "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID} @@ -205,7 +205,7 @@

Method Details

"evaluationId": "A String", # Output only. [Output only] Evaluation ID "externalDataSources": [ # Optional. External data sources { # Message for external data sources - "assetType": "A String", # Required. The asset type of the external data source must be one of go/cai-asset-types + "assetType": "A String", # Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data "type": "A String", # Required. Type of external data source "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID} @@ -257,7 +257,7 @@

Method Details

"evaluationId": "A String", # Output only. [Output only] Evaluation ID "externalDataSources": [ # Optional. External data sources { # Message for external data sources - "assetType": "A String", # Required. The asset type of the external data source must be one of go/cai-asset-types + "assetType": "A String", # Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule "name": "A String", # Optional. Name of external data source. The name will be used inside the rego/sql to refer the external data "type": "A String", # Required. Type of external data source "uri": "A String", # Required. URI of external data source. example of bq table {project_ID}.{dataset_ID}.{table_ID} diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index 6f031ee5277..20d1a443c0d 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -422,7 +422,7 @@ ] }, "subscribe": { -"description": "Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.", +"description": "Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataExchanges/{dataExchangesId}:subscribe", "httpMethod": "POST", "id": "analyticshub.projects.locations.dataExchanges.subscribe", @@ -1022,7 +1022,7 @@ } } }, -"revision": "20240630", +"revision": "20240715", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AnalyticsHubSubscriptionInfo": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1.json b/googleapiclient/discovery_cache/documents/appengine.v1.json index 639b7837f6f..93abb063c8a 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1.json @@ -1718,7 +1718,7 @@ } } }, -"revision": "20240708", +"revision": "20240722", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3699,7 +3699,8 @@ true "type": "object" }, "id": { -"description": "Relative name of the service within the application. Example: default.@OutputOnly", +"description": "Output only. Relative name of the service within the application. Example: default.@OutputOnly", +"readOnly": true, "type": "string" }, "labels": { @@ -3710,7 +3711,8 @@ true "type": "object" }, "name": { -"description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", +"description": "Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", +"readOnly": true, "type": "string" }, "networkSettings": { @@ -4026,7 +4028,8 @@ true "type": "string" }, "createdBy": { -"description": "Email address of the user who created this version.@OutputOnly", +"description": "Output only. Email address of the user who created this version.@OutputOnly", +"readOnly": true, "type": "string" }, "defaultExpiration": { @@ -4039,8 +4042,9 @@ true "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." }, "diskUsageBytes": { -"description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", +"description": "Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", "format": "int64", +"readOnly": true, "type": "string" }, "endpointsApiService": { @@ -4145,7 +4149,8 @@ true "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as \"backends\"." }, "name": { -"description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", +"description": "Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", +"readOnly": true, "type": "string" }, "network": { @@ -4203,7 +4208,8 @@ true "type": "boolean" }, "versionUrl": { -"description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", +"description": "Output only. Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", +"readOnly": true, "type": "string" }, "vm": { diff --git a/googleapiclient/discovery_cache/documents/appengine.v1beta.json b/googleapiclient/discovery_cache/documents/appengine.v1beta.json index 5b318ec88ad..6e74f2a3027 100644 --- a/googleapiclient/discovery_cache/documents/appengine.v1beta.json +++ b/googleapiclient/discovery_cache/documents/appengine.v1beta.json @@ -1918,7 +1918,7 @@ } } }, -"revision": "20240708", +"revision": "20240722", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -3948,7 +3948,8 @@ true "type": "object" }, "id": { -"description": "Relative name of the service within the application. Example: default.@OutputOnly", +"description": "Output only. Relative name of the service within the application. Example: default.@OutputOnly", +"readOnly": true, "type": "string" }, "labels": { @@ -3959,7 +3960,8 @@ true "type": "object" }, "name": { -"description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", +"description": "Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", +"readOnly": true, "type": "string" }, "networkSettings": { @@ -4273,7 +4275,8 @@ true "type": "string" }, "createdBy": { -"description": "Email address of the user who created this version.@OutputOnly", +"description": "Output only. Email address of the user who created this version.@OutputOnly", +"readOnly": true, "type": "string" }, "defaultExpiration": { @@ -4286,8 +4289,9 @@ true "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." }, "diskUsageBytes": { -"description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", +"description": "Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", "format": "int64", +"readOnly": true, "type": "string" }, "endpointsApiService": { @@ -4392,7 +4396,8 @@ true "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as \"backends\"." }, "name": { -"description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", +"description": "Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", +"readOnly": true, "type": "string" }, "network": { @@ -4450,7 +4455,8 @@ true "type": "boolean" }, "versionUrl": { -"description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", +"description": "Output only. Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", +"readOnly": true, "type": "string" }, "vm": { diff --git a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json index df88f3a7f3f..d19b9a1dee7 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1.json @@ -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`. * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*\"` --> tags with an ID starting with \"a/b/\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc\"` --> tags with an ID ending with \"/b/c\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*\"` --> tags with an ID containing \"/b/\".", +"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`.", "location": "query", "type": "string" }, @@ -2013,7 +2013,7 @@ } } }, -"revision": "20240717", +"revision": "20240724", "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 d289b85a595..47770b76588 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta1.json @@ -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`. * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*\"` --> tags with an ID starting with \"a/b/\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc\"` --> tags with an ID ending with \"/b/c\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*\"` --> tags with an ID containing \"/b/\".", +"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`.", "location": "query", "type": "string" }, @@ -1146,7 +1146,7 @@ } } }, -"revision": "20240704", +"revision": "20240724", "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 b8461d2230a..760df8cc637 100644 --- a/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/artifactregistry.v1beta2.json @@ -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`. * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*\"` --> tags with an ID starting with \"a/b/\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc\"` --> tags with an ID ending with \"/b/c\". * `name=\"projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*\"` --> tags with an ID containing \"/b/\".", +"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`.", "location": "query", "type": "string" }, @@ -1414,7 +1414,7 @@ } } }, -"revision": "20240717", +"revision": "20240724", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index 9b3ab346278..0a104c5350a 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -1935,7 +1935,7 @@ } } }, -"revision": "20240629", +"revision": "20240714", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -3100,7 +3100,7 @@ "id": "Dataset", "properties": { "access": { -"description": "Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;", +"description": "Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.", "items": { "description": "An object that defines dataset access for an entity.", "properties": { @@ -3296,7 +3296,8 @@ "type": "string" }, "tags": { -"description": "Output only. Tags for the Dataset.", +"deprecated": true, +"description": "Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.", "items": { "description": "A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions", "properties": { @@ -5506,6 +5507,23 @@ "description": "Output only. Statistics for data-masking. Present only for query and extract jobs.", "readOnly": true }, +"edition": { +"description": "Output only. Name of edition corresponding to the reservation for this job at the time of this update.", +"enum": [ +"RESERVATION_EDITION_UNSPECIFIED", +"STANDARD", +"ENTERPRISE", +"ENTERPRISE_PLUS" +], +"enumDescriptions": [ +"Default value, which will be treated as ENTERPRISE.", +"Standard edition.", +"Enterprise edition.", +"Enterprise plus edition." +], +"readOnly": true, +"type": "string" +}, "endTime": { "description": "Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.", "format": "int64", diff --git a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json index a095a4dafac..6a71aeda4fb 100644 --- a/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json +++ b/googleapiclient/discovery_cache/documents/bigtableadmin.v2.json @@ -2194,7 +2194,7 @@ } } }, -"revision": "20240703", +"revision": "20240720", "rootUrl": "https://bigtableadmin.googleapis.com/", "schemas": { "AppProfile": { @@ -3325,6 +3325,10 @@ "utf8Bytes": { "$ref": "GoogleBigtableAdminV2TypeStringEncodingUtf8Bytes", "description": "Use `Utf8Bytes` encoding." +}, +"utf8Raw": { +"$ref": "GoogleBigtableAdminV2TypeStringEncodingUtf8Raw", +"description": "Deprecated: if set, converts to an empty `utf8_bytes`." } }, "type": "object" @@ -3335,6 +3339,12 @@ "properties": {}, "type": "object" }, +"GoogleBigtableAdminV2TypeStringEncodingUtf8Raw": { +"description": "Deprecated: prefer the equivalent `Utf8Bytes`.", +"id": "GoogleBigtableAdminV2TypeStringEncodingUtf8Raw", +"properties": {}, +"type": "object" +}, "GoogleBigtableAdminV2TypeStruct": { "description": "A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`.", "id": "GoogleBigtableAdminV2TypeStruct", @@ -4246,7 +4256,7 @@ "type": "object" }, "Type": { -"description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING(\"-00001\") > STRING(\"00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", +"description": "`Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING(\"-00001\") > STRING(\"00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java?", "id": "Type", "properties": { "aggregateType": { diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 4c5d519d4ae..aa825f89ea8 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -21,28 +21,28 @@ "description": "Private Service: https://www.googleapis.com/auth/chat.bot" }, "https://www.googleapis.com/auth/chat.delete": { -"description": "Delete conversations and spaces & remove access to associated files in Google Chat" +"description": "Delete conversations and spaces and remove access to associated files in Google Chat" }, "https://www.googleapis.com/auth/chat.import": { "description": "Import spaces, messages, and memberships into Google Chat." }, "https://www.googleapis.com/auth/chat.memberships": { -"description": "View, add, update, and remove members from conversations in Google Chat" +"description": "See, add, update, and remove members from conversations and spaces in Google Chat" }, "https://www.googleapis.com/auth/chat.memberships.app": { -"description": "Add and remove itself from conversations in Google Chat" +"description": "Add and remove itself from conversations and spaces in Google Chat" }, "https://www.googleapis.com/auth/chat.memberships.readonly": { "description": "View members in Google Chat conversations." }, "https://www.googleapis.com/auth/chat.messages": { -"description": "View, compose, send, update, and delete messages, and add, view, and delete reactions to messages." +"description": "See, compose, send, update, and delete messages and their associated attachments, and add, see, and delete reactions to messages." }, "https://www.googleapis.com/auth/chat.messages.create": { "description": "Compose and send messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.reactions": { -"description": "View, add, and delete reactions to messages in Google Chat" +"description": "See, add, and delete reactions to messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.reactions.create": { "description": "Add reactions to messages in Google Chat" @@ -51,13 +51,13 @@ "description": "View reactions to messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.readonly": { -"description": "View messages and reactions in Google Chat" +"description": "See messages and their associated reactions and attachments in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces": { -"description": "Create conversations and spaces and see or edit metadata (including history settings and access settings) in Google Chat" +"description": "Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces.create": { -"description": "Create new conversations in Google Chat" +"description": "Create new conversations and spaces in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces.readonly": { "description": "View chat and spaces in Google Chat" @@ -1241,7 +1241,7 @@ } } }, -"revision": "20240709", +"revision": "20240723", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessSettings": { diff --git a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json index 804598c9561..32a372f62e5 100644 --- a/googleapiclient/discovery_cache/documents/cloudbuild.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudbuild.v2.json @@ -844,7 +844,7 @@ } } }, -"revision": "20240704", +"revision": "20240720", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -2513,8 +2513,7 @@ "type": "string" }, "secretVersion": { -"description": "Output only. Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*", -"readOnly": true, +"description": "Optional. Resource name of the SecretVersion. In format: projects/*/secrets/*/versions/*", "type": "string" } }, @@ -2525,6 +2524,7 @@ "id": "Security", "properties": { "privilegeMode": { +"deprecated": true, "description": "Optional. Privilege mode.", "enum": [ "PRIVILEGE_MODE_UNSPECIFIED", diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 3dc372198c0..38b291b7b61 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -109,6 +109,31 @@ "resources": { "locations": { "methods": { +"getEncryptionSpec": { +"description": "Gets location-level encryption key specification.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec", +"httpMethod": "GET", +"id": "contactcenterinsights.projects.locations.getEncryptionSpec", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the encryption spec resource to get.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "getSettings": { "description": "Gets project-level settings.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/settings", @@ -640,6 +665,38 @@ } } }, +"encryptionSpec": { +"methods": { +"initialize": { +"description": "Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/encryptionSpec:initialize", +"httpMethod": "POST", +"id": "contactcenterinsights.projects.locations.encryptionSpec.initialize", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/encryptionSpec$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:initialize", +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "insightsdata": { "methods": { "export": { @@ -1474,7 +1531,7 @@ } } }, -"revision": "20240708", +"revision": "20240723", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -2646,6 +2703,21 @@ }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudContactcenterinsightsV1EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1Entity": { "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "id": "GoogleCloudContactcenterinsightsV1Entity", @@ -3193,6 +3265,54 @@ "properties": {}, "type": "object" }, +"GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"partialErrors": { +"description": "Partial errors during initialising operation that might cause the operation output to be incomplete.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudContactcenterinsightsV1EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse": { +"description": "The response to initialize a location-level encryption specification.", +"id": "GoogleCloudContactcenterinsightsV1InitializeEncryptionSpecResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1Intent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "id": "GoogleCloudContactcenterinsightsV1Intent", @@ -5180,6 +5300,21 @@ }, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec": { +"description": "A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).", +"id": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", +"properties": { +"kmsKey": { +"description": "Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`", +"type": "string" +}, +"name": { +"description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1Entity": { "description": "The data for an entity annotation. Represents a phrase in the conversation that is a known entity, such as a person, an organization, or location.", "id": "GoogleCloudContactcenterinsightsV1alpha1Entity", @@ -5716,6 +5851,54 @@ "properties": {}, "type": "object" }, +"GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata": { +"description": "Metadata for initializing a location-level encryption specification.", +"id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecMetadata", +"properties": { +"createTime": { +"description": "Output only. The time the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"endTime": { +"description": "Output only. The time the operation finished running.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"partialErrors": { +"description": "Partial errors during initialising operation that might cause the operation output to be incomplete.", +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +}, +"request": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", +"description": "Output only. The original request for initialization.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest": { +"description": "The request to initialize a location-level encryption specification.", +"id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecRequest", +"properties": { +"encryptionSpec": { +"$ref": "GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec", +"description": "Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced." +} +}, +"type": "object" +}, +"GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse": { +"description": "The response to initialize a location-level encryption specification.", +"id": "GoogleCloudContactcenterinsightsV1alpha1InitializeEncryptionSpecResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudContactcenterinsightsV1alpha1Intent": { "description": "The data for an intent. Represents a detected intent in the conversation, for example MAKES_PROMISE.", "id": "GoogleCloudContactcenterinsightsV1alpha1Intent", diff --git a/googleapiclient/discovery_cache/documents/contentwarehouse.v1.json b/googleapiclient/discovery_cache/documents/contentwarehouse.v1.json index b45cfdb622c..29963923f0d 100644 --- a/googleapiclient/discovery_cache/documents/contentwarehouse.v1.json +++ b/googleapiclient/discovery_cache/documents/contentwarehouse.v1.json @@ -1156,7 +1156,7 @@ } } }, -"revision": "20240506", +"revision": "20240723", "rootUrl": "https://contentwarehouse.googleapis.com/", "schemas": { "CloudAiPlatformTenantresourceCloudSqlInstanceConfig": { @@ -3994,11 +3994,19 @@ true "description": "Document represents the canonical document resource in Document AI. It is an interchange format that provides insights into documents and allows for collaboration between users and Document AI to iterate and optimize for quality.", "id": "GoogleCloudDocumentaiV1Document", "properties": { +"chunkedDocument": { +"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocument", +"description": "Document chunked based on chunking config." +}, "content": { "description": "Optional. Inline document content, represented as a stream of bytes. Note: As with all `bytes` fields, protobuffers use a pure binary representation, whereas JSON representations use base64.", "format": "byte", "type": "string" }, +"documentLayout": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayout", +"description": "Parsed layout of the document." +}, "entities": { "description": "A list of entities detected on Document.text. For document shards, entities in this list may cross shard boundaries.", "items": { @@ -4065,6 +4073,282 @@ true }, "type": "object" }, +"GoogleCloudDocumentaiV1DocumentChunkedDocument": { +"description": "Represents the chunks that the document is divided into.", +"id": "GoogleCloudDocumentaiV1DocumentChunkedDocument", +"properties": { +"chunks": { +"description": "List of chunks.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk": { +"description": "Represents a chunk.", +"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunk", +"properties": { +"chunkId": { +"description": "ID of the chunk.", +"type": "string" +}, +"content": { +"description": "Text content of the chunk.", +"type": "string" +}, +"pageFooters": { +"description": "Page footers associated with the chunk.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter" +}, +"type": "array" +}, +"pageHeaders": { +"description": "Page headers associated with the chunk.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader" +}, +"type": "array" +}, +"pageSpan": { +"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", +"description": "Page span of the chunk." +}, +"sourceBlockIds": { +"description": "Unused.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter": { +"description": "Represents the page footer associated with the chunk.", +"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageFooter", +"properties": { +"pageSpan": { +"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", +"description": "Page span of the footer." +}, +"text": { +"description": "Footer in text format.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader": { +"description": "Represents the page header associated with the chunk.", +"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageHeader", +"properties": { +"pageSpan": { +"$ref": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", +"description": "Page span of the header." +}, +"text": { +"description": "Header in text format.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan": { +"description": "Represents where the chunk starts and ends in the document.", +"id": "GoogleCloudDocumentaiV1DocumentChunkedDocumentChunkChunkPageSpan", +"properties": { +"pageEnd": { +"description": "Page where chunk ends in the document.", +"format": "int32", +"type": "integer" +}, +"pageStart": { +"description": "Page where chunk starts in the document.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentDocumentLayout": { +"description": "Represents the parsed layout of a document as a collection of blocks that the document is divided into.", +"id": "GoogleCloudDocumentaiV1DocumentDocumentLayout", +"properties": { +"blocks": { +"description": "List of blocks in the document.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock": { +"description": "Represents a block. A block could be one of the various types (text, table, list) supported.", +"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock", +"properties": { +"blockId": { +"description": "ID of the block.", +"type": "string" +}, +"listBlock": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", +"description": "Block consisting of list content/structure." +}, +"pageSpan": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", +"description": "Page span of the block." +}, +"tableBlock": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", +"description": "Block consisting of table content/structure." +}, +"textBlock": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", +"description": "Block consisting of text content." +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock": { +"description": "Represents a list type block.", +"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListBlock", +"properties": { +"listEntries": { +"description": "List entries that constitute a list block.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry" +}, +"type": "array" +}, +"type": { +"description": "Type of the list_entries (if exist). Available options are `ordered` and `unordered`.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry": { +"description": "Represents an entry in the list.", +"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutListEntry", +"properties": { +"blocks": { +"description": "A list entry is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan": { +"description": "Represents where the block starts and ends in the document.", +"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutPageSpan", +"properties": { +"pageEnd": { +"description": "Page where block ends in the document.", +"format": "int32", +"type": "integer" +}, +"pageStart": { +"description": "Page where block starts in the document.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock": { +"description": "Represents a table type block.", +"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableBlock", +"properties": { +"bodyRows": { +"description": "Body rows containing main table content.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" +}, +"type": "array" +}, +"caption": { +"description": "Table caption/title.", +"type": "string" +}, +"headerRows": { +"description": "Header rows at the top of the table.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell": { +"description": "Represents a cell in a table row.", +"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell", +"properties": { +"blocks": { +"description": "A table cell is a list of blocks. Repeated blocks support further hierarchies and nested blocks.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" +}, +"type": "array" +}, +"colSpan": { +"description": "How many columns this cell spans.", +"format": "int32", +"type": "integer" +}, +"rowSpan": { +"description": "How many rows this cell spans.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow": { +"description": "Represents a row in a table.", +"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableRow", +"properties": { +"cells": { +"description": "A table row is a list of table cells.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTableCell" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock": { +"description": "Represents a text type block.", +"id": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlockLayoutTextBlock", +"properties": { +"blocks": { +"description": "A text block could further have child blocks. Repeated blocks support further hierarchies and nested blocks.", +"items": { +"$ref": "GoogleCloudDocumentaiV1DocumentDocumentLayoutDocumentLayoutBlock" +}, +"type": "array" +}, +"text": { +"description": "Text content stored in the block.", +"type": "string" +}, +"type": { +"description": "Type of the text in the block. Available options are: `paragraph`, `subtitle`, `heading-1`, `heading-2`, `heading-3`, `heading-4`, `heading-5`, `header`, `footer`.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDocumentaiV1DocumentEntity": { "description": "An entity that could be a phrase in the text or a property that belongs to the document. It is a known entity type, such as a person, an organization, or location.", "id": "GoogleCloudDocumentaiV1DocumentEntity", diff --git a/googleapiclient/discovery_cache/documents/datamigration.v1.json b/googleapiclient/discovery_cache/documents/datamigration.v1.json index b9ffd8f5968..18d4476d425 100644 --- a/googleapiclient/discovery_cache/documents/datamigration.v1.json +++ b/googleapiclient/discovery_cache/documents/datamigration.v1.json @@ -2125,7 +2125,7 @@ } } }, -"revision": "20240628", +"revision": "20240721", "rootUrl": "https://datamigration.googleapis.com/", "schemas": { "AlloyDbConnectionProfile": { @@ -2531,6 +2531,7 @@ "MYSQL_8_0_34", "MYSQL_8_0_35", "MYSQL_8_0_36", +"MYSQL_8_0_37", "POSTGRES_9_6", "POSTGRES_11", "POSTGRES_10", @@ -2556,6 +2557,7 @@ "The database major version is MySQL 8.0 and the minor version is 34.", "The database major version is MySQL 8.0 and the minor version is 35.", "The database major version is MySQL 8.0 and the minor version is 36.", +"The database major version is MySQL 8.0 and the minor version is 37.", "PostgreSQL 9.6.", "PostgreSQL 11.", "PostgreSQL 10.", @@ -5732,6 +5734,10 @@ }, "type": "array" }, +"promoteWhenReady": { +"description": "Optional. Promote databases when ready.", +"type": "boolean" +}, "useDiffBackup": { "description": "Optional. Enable differential backups.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index 5a65926ebea..7f01de4ee7c 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -105,6 +105,105 @@ }, "protocol": "rest", "resources": { +"organizations": { +"resources": { +"locations": { +"resources": { +"encryptionConfigs": { +"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/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataplex.organizations.locations.encryptionConfigs.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": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"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/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataplex.organizations.locations.encryptionConfigs.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": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"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/organizations/{organizationsId}/locations/{locationsId}/encryptionConfigs/{encryptionConfigsId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataplex.organizations.locations.encryptionConfigs.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": "^organizations/[^/]+/locations/[^/]+/encryptionConfigs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +}, "projects": { "resources": { "locations": { @@ -1999,7 +2098,7 @@ ], "parameters": { "name": { -"description": "Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.", +"description": "Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+$", "required": true, @@ -2269,7 +2368,7 @@ "type": "boolean" }, "name": { -"description": "Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", +"description": "Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/entryGroups/[^/]+/entries/.*$", "required": true, @@ -2566,6 +2665,97 @@ } } }, +"glossaries": { +"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}/glossaries/{glossariesId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataplex.projects.locations.glossaries.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/[^/]+/glossaries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"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}/glossaries/{glossariesId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataplex.projects.locations.glossaries.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/[^/]+/glossaries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"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}/glossaries/{glossariesId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataplex.projects.locations.glossaries.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/[^/]+/glossaries/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "governanceRules": { "methods": { "getIamPolicy": { @@ -5145,6 +5335,142 @@ } } }, +"metadataJobs": { +"methods": { +"cancel": { +"description": "Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}:cancel", +"httpMethod": "POST", +"id": "dataplex.projects.locations.metadataJobs.cancel", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/metadataJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:cancel", +"request": { +"$ref": "GoogleCloudDataplexV1CancelMetadataJobRequest" +}, +"response": { +"$ref": "Empty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"create": { +"description": "Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs", +"httpMethod": "POST", +"id": "dataplex.projects.locations.metadataJobs.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"metadataJobId": { +"description": "Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/metadataJobs", +"request": { +"$ref": "GoogleCloudDataplexV1MetadataJob" +}, +"response": { +"$ref": "GoogleLongrunningOperation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a metadata job.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs/{metadataJobsId}", +"httpMethod": "GET", +"id": "dataplex.projects.locations.metadataJobs.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the metadata job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/metadataJobs/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}", +"response": { +"$ref": "GoogleCloudDataplexV1MetadataJob" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists metadata jobs.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/metadataJobs", +"httpMethod": "GET", +"id": "dataplex.projects.locations.metadataJobs.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = \"value1\" labels:key1 name = \"value\"You can combine filters with AND, OR, and NOT operators.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+parent}/metadataJobs", +"response": { +"$ref": "GoogleCloudDataplexV1ListMetadataJobsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "operations": { "methods": { "cancel": { @@ -5273,7 +5599,7 @@ } } }, -"revision": "20240624", +"revision": "20240722", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -5496,7 +5822,8 @@ "id": "GoogleCloudDataplexV1Aspect", "properties": { "aspectSource": { -"$ref": "GoogleCloudDataplexV1AspectSource" +"$ref": "GoogleCloudDataplexV1AspectSource", +"description": "Optional. Information related to the source system of the aspect." }, "aspectType": { "description": "Output only. The resource name of the type used to create this Aspect.", @@ -5532,16 +5859,16 @@ "type": "object" }, "GoogleCloudDataplexV1AspectSource": { -"description": "AspectSource contains information related to the source system of the Aspect.", +"description": "Information related to the source system of the aspect.", "id": "GoogleCloudDataplexV1AspectSource", "properties": { "createTime": { -"description": "The create time of the aspect in the source system.", +"description": "The time the aspect was created in the source system.", "format": "google-datetime", "type": "string" }, "updateTime": { -"description": "The update time of the aspect in the source system.", +"description": "The time the aspect was last updated in the source system.", "format": "google-datetime", "type": "string" } @@ -6110,6 +6437,12 @@ "properties": {}, "type": "object" }, +"GoogleCloudDataplexV1CancelMetadataJobRequest": { +"description": "Cancel metadata job request.", +"id": "GoogleCloudDataplexV1CancelMetadataJobRequest", +"properties": {}, +"type": "object" +}, "GoogleCloudDataplexV1Content": { "description": "Content represents a user-visible notebook or a sql script", "id": "GoogleCloudDataplexV1Content", @@ -6476,7 +6809,7 @@ "id": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo", "properties": { "distinctRatio": { -"description": "Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.", +"description": "Ratio of rows with distinct values against total scanned rows. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.", "format": "double", "type": "number" }, @@ -6498,7 +6831,7 @@ "description": "String type field information." }, "topNValues": { -"description": "The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type RECORD and fields with REPEATABLE mode.", +"description": "The list of top N non-null values, frequency and ratio with which they occur in the scanned data. N is 10 or equal to the number of distinct values in the field, whichever is smaller. Not available for complex non-groupable field type, including RECORD, ARRAY, GEOGRAPHY, and JSON, as well as fields with REPEATABLE mode.", "items": { "$ref": "GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfoTopNValue" }, @@ -6881,6 +7214,10 @@ "$ref": "GoogleCloudDataplexV1DataQualityRuleStatisticRangeExpectation", "description": "Aggregate rule which evaluates whether the column aggregate statistic lies between a specified range." }, +"suspended": { +"description": "Optional. Whether the Rule is active or suspended. Default is false.", +"type": "boolean" +}, "tableConditionExpectation": { "$ref": "GoogleCloudDataplexV1DataQualityRuleTableConditionExpectation", "description": "Aggregate rule which evaluates whether the provided expression is true for a table." @@ -8161,36 +8498,36 @@ "type": "object" }, "GoogleCloudDataplexV1Entry": { -"description": "An entry is a representation of a data asset which can be described by various metadata.", +"description": "An entry is a representation of a data resource that can be described by various metadata.", "id": "GoogleCloudDataplexV1Entry", "properties": { "aspects": { "additionalProperties": { "$ref": "GoogleCloudDataplexV1Aspect" }, -"description": "Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)", +"description": "Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}", "type": "object" }, "createTime": { -"description": "Output only. The time when the Entry was created.", +"description": "Output only. The time when the entry was created in Dataplex.", "format": "google-datetime", "readOnly": true, "type": "string" }, "entrySource": { "$ref": "GoogleCloudDataplexV1EntrySource", -"description": "Optional. Information related to the source system for an entry." +"description": "Optional. Information related to the source system of the data resource that is represented by the entry." }, "entryType": { -"description": "Required. Immutable. The resource name of the EntryType used to create this Entry.", +"description": "Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.", "type": "string" }, "fullyQualifiedName": { -"description": "Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters.", +"description": "Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters.", "type": "string" }, "name": { -"description": "Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.", +"description": "Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.", "type": "string" }, "parentEntry": { @@ -8198,7 +8535,7 @@ "type": "string" }, "updateTime": { -"description": "Output only. The time when the Entry was last updated.", +"description": "Output only. The time when the entry was last updated in Dataplex.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -8236,7 +8573,7 @@ "type": "object" }, "name": { -"description": "Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.", +"description": "Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.", "readOnly": true, "type": "string" }, @@ -8255,27 +8592,27 @@ "type": "object" }, "GoogleCloudDataplexV1EntrySource": { -"description": "EntrySource contains information related to the source system of the Entry.", +"description": "Information related to the source system of the data resource that is represented by the entry.", "id": "GoogleCloudDataplexV1EntrySource", "properties": { "ancestors": { -"description": "Immutable. The ancestors of the Entry in the source system.", +"description": "Immutable. The entries representing the ancestors of the data resource in the source system.", "items": { "$ref": "GoogleCloudDataplexV1EntrySourceAncestor" }, "type": "array" }, "createTime": { -"description": "The create time of the resource in the source system.", +"description": "The time when the resource was created in the source system.", "format": "google-datetime", "type": "string" }, "description": { -"description": "Description of the Entry. The maximum size of the field is 2000 characters.", +"description": "A description of the data resource. Maximum length is 2,000 characters.", "type": "string" }, "displayName": { -"description": "User friendly display name. The maximum size of the field is 500 characters.", +"description": "A user-friendly display name. Maximum length is 500 characters.", "type": "string" }, "labels": { @@ -8286,24 +8623,24 @@ "type": "object" }, "location": { -"description": "Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud.", +"description": "Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.", "readOnly": true, "type": "string" }, "platform": { -"description": "The platform containing the source system. The maximum size of the field is 64 characters.", +"description": "The platform containing the source system. Maximum length is 64 characters.", "type": "string" }, "resource": { -"description": "The name of the resource in the source system. The maximum size of the field is 4000 characters.", +"description": "The name of the resource in the source system. Maximum length is 4,000 characters.", "type": "string" }, "system": { -"description": "The name of the source system. The maximum size of the field is 64 characters.", +"description": "The name of the source system. Maximum length is 64 characters.", "type": "string" }, "updateTime": { -"description": "The update time of the resource in the source system.", +"description": "The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.", "format": "google-datetime", "type": "string" } @@ -8311,7 +8648,7 @@ "type": "object" }, "GoogleCloudDataplexV1EntrySourceAncestor": { -"description": "Ancestor contains information about individual items in the hierarchy of an Entry.", +"description": "Information about individual items in the hierarchy that is associated with the data resource.", "id": "GoogleCloudDataplexV1EntrySourceAncestor", "properties": { "name": { @@ -8717,6 +9054,29 @@ }, "type": "object" }, +"GoogleCloudDataplexV1ImportItem": { +"description": "An object that describes the values that you want to set for an entry and its attached aspects when you import metadata. Used when you run a metadata import job. See CreateMetadataJob.You provide a collection of import items in a metadata import file. For more information about how to create a metadata import file, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).", +"id": "GoogleCloudDataplexV1ImportItem", +"properties": { +"aspectKeys": { +"description": "The aspects to modify. Supports the following syntaxes: {aspect_type_reference}: matches aspects that belong to the specified aspect type and are attached directly to the entry. {aspect_type_reference}@{path}: matches aspects that belong to the specified aspect type and path. {aspect_type_reference}@*: matches aspects that belong to the specified aspect type for all paths.Replace {aspect_type_reference} with a reference to the aspect type, in the format {project_id_or_number}.{location_id}.{aspect_type_id}.If you leave this field empty, it is treated as specifying exactly those aspects that are present within the specified entry.In FULL entry sync mode, Dataplex implicitly adds the keys for all of the required aspects of an entry.", +"items": { +"type": "string" +}, +"type": "array" +}, +"entry": { +"$ref": "GoogleCloudDataplexV1Entry", +"description": "Information about an entry and its attached aspects." +}, +"updateMask": { +"description": "The fields to update, in paths that are relative to the Entry resource. Separate each field with a comma.In FULL entry sync mode, Dataplex includes the paths of all of the fields for an entry that can be modified, including aspects. This means that Dataplex replaces the existing entry with the entry in the metadata import file. All modifiable fields are updated, regardless of the fields that are listed in the update mask, and regardless of whether a field is present in the entry object.The update_mask field is ignored when an entry is created or re-created.Dataplex also determines which entries and aspects to modify by comparing the values and timestamps that you provide in the metadata import file with the values and timestamps that exist in your project. For more information, see Comparison logic (https://cloud.google.com/dataplex/docs/import-metadata#data-modification-logic).", +"format": "google-fieldmask", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1Job": { "description": "A job represents an instance of a task.", "id": "GoogleCloudDataplexV1Job", @@ -9393,6 +9753,31 @@ }, "type": "object" }, +"GoogleCloudDataplexV1ListMetadataJobsResponse": { +"description": "List metadata jobs response.", +"id": "GoogleCloudDataplexV1ListMetadataJobsResponse", +"properties": { +"metadataJobs": { +"description": "Metadata jobs under the specified parent location.", +"items": { +"$ref": "GoogleCloudDataplexV1MetadataJob" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token to retrieve the next page of results. If there are no more results in the list, the value is empty.", +"type": "string" +}, +"unreachableLocations": { +"description": "Locations that the service couldn't reach.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1ListPartitionsResponse": { "description": "List metadata partitions response.", "id": "GoogleCloudDataplexV1ListPartitionsResponse", @@ -9472,6 +9857,248 @@ }, "type": "object" }, +"GoogleCloudDataplexV1MetadataJob": { +"description": "A metadata job resource.", +"id": "GoogleCloudDataplexV1MetadataJob", +"properties": { +"createTime": { +"description": "Output only. The time when the metadata job was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"importResult": { +"$ref": "GoogleCloudDataplexV1MetadataJobImportJobResult", +"description": "Output only. Import job result.", +"readOnly": true +}, +"importSpec": { +"$ref": "GoogleCloudDataplexV1MetadataJobImportJobSpec", +"description": "Import job specification." +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. User-defined labels.", +"type": "object" +}, +"name": { +"description": "Output only. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.", +"readOnly": true, +"type": "string" +}, +"status": { +"$ref": "GoogleCloudDataplexV1MetadataJobStatus", +"readOnly": true +}, +"type": { +"enum": [ +"TYPE_UNSPECIFIED", +"IMPORT" +], +"enumDescriptions": [ +"Unspecified.", +"Import job." +], +"type": "string" +}, +"uid": { +"description": "Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the metadata job was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1MetadataJobImportJobResult": { +"description": "Results from a metadata import job.", +"id": "GoogleCloudDataplexV1MetadataJobImportJobResult", +"properties": { +"createdEntries": { +"description": "Output only. The total number of entries that were created.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"deletedEntries": { +"description": "Output only. The total number of entries that were deleted.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"recreatedEntries": { +"description": "Output only. The total number of entries that were recreated.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"unchangedEntries": { +"description": "Output only. The total number of entries that were unchanged.", +"format": "int64", +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the status was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"updatedEntries": { +"description": "Output only. The total number of entries that were updated.", +"format": "int64", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1MetadataJobImportJobSpec": { +"description": "Job specification for a metadata import job", +"id": "GoogleCloudDataplexV1MetadataJobImportJobSpec", +"properties": { +"aspectSyncMode": { +"description": "Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.", +"enum": [ +"SYNC_MODE_UNSPECIFIED", +"FULL", +"INCREMENTAL" +], +"enumDescriptions": [ +"Sync mode unspecified.", +"All resources in the job's scope are modified. If a resource exists in Dataplex but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.", +"Only the entries and aspects that are explicitly included in the metadata import file are modified. Use this mode to modify a subset of resources while leaving unreferenced resources unchanged." +], +"type": "string" +}, +"entrySyncMode": { +"description": "Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.", +"enum": [ +"SYNC_MODE_UNSPECIFIED", +"FULL", +"INCREMENTAL" +], +"enumDescriptions": [ +"Sync mode unspecified.", +"All resources in the job's scope are modified. If a resource exists in Dataplex but isn't included in the metadata import file, the resource is deleted when you run the metadata job. Use this mode to perform a full sync of the set of entries in the job scope.", +"Only the entries and aspects that are explicitly included in the metadata import file are modified. Use this mode to modify a subset of resources while leaving unreferenced resources unchanged." +], +"type": "string" +}, +"logLevel": { +"description": "Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO.", +"enum": [ +"LOG_LEVEL_UNSPECIFIED", +"DEBUG", +"INFO" +], +"enumDescriptions": [ +"Log level unspecified.", +"Debug-level logging. Captures detailed logs for each import item. Use debug-level logging to troubleshoot issues with specific import items. For example, use debug-level logging to identify resources that are missing from the job scope, entries or aspects that don't conform to the associated entry type or aspect type, or other misconfigurations with the metadata import file.Depending on the size of your metadata job and the number of logs that are generated, debug-level logging might incur additional costs (https://cloud.google.com/stackdriver/pricing).", +"Info-level logging. Captures logs at the overall job level. Includes aggregate logs about import items, but doesn't specify which import item has an error." +], +"type": "string" +}, +"scope": { +"$ref": "GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope", +"description": "Required. A boundary on the scope of impact that the metadata import job can have." +}, +"sourceCreateTime": { +"description": "Optional. The time when the process that created the metadata import files began.", +"format": "google-datetime", +"type": "string" +}, +"sourceStorageUri": { +"description": "Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope": { +"description": "A boundary on the scope of impact that the metadata import job can have.", +"id": "GoogleCloudDataplexV1MetadataJobImportJobSpecImportJobScope", +"properties": { +"aspectTypes": { +"description": "Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.", +"items": { +"type": "string" +}, +"type": "array" +}, +"entryGroups": { +"description": "Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.", +"items": { +"type": "string" +}, +"type": "array" +}, +"entryTypes": { +"description": "Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. The job modifies only the entries that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDataplexV1MetadataJobStatus": { +"description": "Metadata job status.", +"id": "GoogleCloudDataplexV1MetadataJobStatus", +"properties": { +"completionPercent": { +"description": "Output only. Progress tracking.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"message": { +"description": "Output only. Message relating to the progression of a metadata job.", +"readOnly": true, +"type": "string" +}, +"state": { +"description": "Output only. State of the metadata job.", +"enum": [ +"STATE_UNSPECIFIED", +"QUEUED", +"RUNNING", +"CANCELING", +"CANCELED", +"SUCCEEDED", +"FAILED", +"SUCCEEDED_WITH_ERRORS" +], +"enumDescriptions": [ +"State unspecified.", +"The job is queued.", +"The job is running.", +"The job is being canceled.", +"The job is canceled.", +"The job succeeded.", +"The job failed.", +"The job completed with some errors." +], +"readOnly": true, +"type": "string" +}, +"updateTime": { +"description": "Output only. The time when the status was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1OperationMetadata": { "description": "Represents the metadata of a long-running operation.", "id": "GoogleCloudDataplexV1OperationMetadata", diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index ca7a422ff21..a0127b791b9 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -8714,7 +8714,7 @@ } } }, -"revision": "20240704", +"revision": "20240721", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8774,6 +8774,10 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { +"enableConsentBasedRedaction": { +"description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", +"type": "boolean" +}, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" @@ -11168,6 +11172,10 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { +"enableConsentBasedRedaction": { +"description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", +"type": "boolean" +}, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 4dd38b02dbe..3e9677ecc6e 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -8082,7 +8082,7 @@ } } }, -"revision": "20240716", +"revision": "20240721", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8142,6 +8142,10 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { +"enableConsentBasedRedaction": { +"description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", +"type": "boolean" +}, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" @@ -10536,6 +10540,10 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { +"enableConsentBasedRedaction": { +"description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", +"type": "boolean" +}, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index 37ab72d10a3..d92ad95fd6c 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -4453,7 +4453,7 @@ } } }, -"revision": "20240704", +"revision": "20240721", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4513,6 +4513,10 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { +"enableConsentBasedRedaction": { +"description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", +"type": "boolean" +}, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" @@ -10274,6 +10278,10 @@ false "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { +"enableConsentBasedRedaction": { +"description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", +"type": "boolean" +}, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 41558e76a42..53583a043fb 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5185,7 +5185,7 @@ } } }, -"revision": "20240704", +"revision": "20240721", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5245,6 +5245,10 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3AdvancedSettingsLoggingSettings", "properties": { +"enableConsentBasedRedaction": { +"description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", +"type": "boolean" +}, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" @@ -7666,6 +7670,10 @@ "description": "Define behaviors on logging.", "id": "GoogleCloudDialogflowCxV3beta1AdvancedSettingsLoggingSettings", "properties": { +"enableConsentBasedRedaction": { +"description": "Enables consent-based end-user input redaction, if true, a pre-defined session parameter `$session.params.conversation-redaction` will be used to determine if the utterance should be redacted.", +"type": "boolean" +}, "enableInteractionLogging": { "description": "Enables DF Interaction logging.", "type": "boolean" @@ -13628,6 +13636,10 @@ false "$ref": "GoogleCloudDialogflowCxV3beta1ToolAuthentication", "description": "Optional. Authentication information required by the API." }, +"serviceDirectoryConfig": { +"$ref": "GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig", +"description": "Optional. Service Directory configuration." +}, "textSchema": { "description": "Required. The OpenAPI schema specified as a text.", "type": "string" @@ -13639,6 +13651,17 @@ false }, "type": "object" }, +"GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig": { +"description": "Configuration for tools using Service Directory.", +"id": "GoogleCloudDialogflowCxV3beta1ToolServiceDirectoryConfig", +"properties": { +"service": { +"description": "Required. The name of [Service Directory](https://cloud.google.com/service-directory) service. Format: `projects//locations//namespaces//services/`. `Location ID` of the service directory must be the same as the location of the agent.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowCxV3beta1ToolTLSConfig": { "description": "The TLS configuration.", "id": "GoogleCloudDialogflowCxV3beta1ToolTLSConfig", diff --git a/googleapiclient/discovery_cache/documents/discovery.v1.json b/googleapiclient/discovery_cache/documents/discovery.v1.json index a588116c681..97434b0f0a2 100644 --- a/googleapiclient/discovery_cache/documents/discovery.v1.json +++ b/googleapiclient/discovery_cache/documents/discovery.v1.json @@ -234,6 +234,10 @@ "description": "The default value of this property (if one exists).", "type": "string" }, +"deprecated": { +"description": "Whether the parameter is deprecated.", +"type": "boolean" +}, "description": { "description": "A description of this object.", "type": "string" @@ -245,6 +249,13 @@ }, "type": "array" }, +"enumDeprecated": { +"description": "The deprecation status for the enums. Each position maps to the corresponding value in the \"enum\" array.", +"items": { +"type": "boolean" +}, +"type": "array" +}, "enumDescriptions": { "description": "The descriptions for the enums. Each position maps to the corresponding value in the \"enum\" array.", "items": { @@ -390,6 +401,32 @@ "description": "A link to human readable documentation for the API.", "type": "string" }, +"endpoints": { +"description": "A list of location-based endpoint objects for this API. Each object contains the endpoint URL, location, description and deprecation status.", +"items": { +"description": "A single endpoint object", +"properties": { +"deprecated": { +"description": "Whether this endpoint is deprecated", +"type": "boolean" +}, +"description": { +"description": "A string describing the host designated by the URL", +"type": "string" +}, +"endpointUrl": { +"description": "The URL of the endpoint target host", +"type": "string" +}, +"location": { +"description": "The location of the endpoint", +"type": "string" +} +}, +"type": "object" +}, +"type": "array" +}, "etag": { "description": "The ETag for this response.", "readOnly": true, @@ -518,6 +555,14 @@ "RestMethod": { "id": "RestMethod", "properties": { +"apiVersion": { +"description": "The API Version of this method, as passed in via the `X-Goog-Api-Version` header or `$apiVersion` query parameter.", +"type": "string" +}, +"deprecated": { +"description": "Whether this method is deprecated.", +"type": "boolean" +}, "description": { "description": "Description of this method.", "type": "string" @@ -663,6 +708,10 @@ "RestResource": { "id": "RestResource", "properties": { +"deprecated": { +"description": "Whether this resource is deprecated.", +"type": "boolean" +}, "methods": { "additionalProperties": { "$ref": "RestMethod", diff --git a/googleapiclient/discovery_cache/documents/dlp.v2.json b/googleapiclient/discovery_cache/documents/dlp.v2.json index a893dcc91da..2d33945e6ab 100644 --- a/googleapiclient/discovery_cache/documents/dlp.v2.json +++ b/googleapiclient/discovery_cache/documents/dlp.v2.json @@ -881,6 +881,47 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"list": { +"description": "Lists Connections in a parent. Use SearchConnections to see all connections within an organization.", +"flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections", +"httpMethod": "GET", +"id": "dlp.organizations.locations.connections.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Supported field/value: `state` - MISSING|AVAILABLE|ERROR", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Number of results per page, max 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. Page token from a previous page to return the next set of results. If set, all other request fields must match the original request.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.", +"location": "path", +"pattern": "^organizations/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/connections", +"response": { +"$ref": "GooglePrivacyDlpV2ListConnectionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "patch": { "description": "Update a Connection.", "flatPath": "v2/organizations/{organizationsId}/locations/{locationsId}/connections/{connectionsId}", @@ -935,7 +976,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent name, typically an organization, without location. For example: `organizations/12345678`.", +"description": "Required. Resource name of the organization or project with a wildcard location, for example `organizations/433245324/locations/-` or `projects/project-id/locations/-`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+$", "required": true, @@ -3224,7 +3265,7 @@ ] }, "list": { -"description": "Lists Connections in a parent.", +"description": "Lists Connections in a parent. Use SearchConnections to see all connections within an organization.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/connections", "httpMethod": "GET", "id": "dlp.projects.locations.connections.list", @@ -3249,7 +3290,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent name, for example: `projects/project-id/locations/global`.", +"description": "Required. Resource name of the organization or project, for example `organizations/433245324/locations/europe` or `projects/project-id/locations/asia`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -3318,7 +3359,7 @@ "type": "string" }, "parent": { -"description": "Required. Parent name, typically an organization, without location. For example: `organizations/12345678`.", +"description": "Required. Resource name of the organization or project with a wildcard location, for example `organizations/433245324/locations/-` or `projects/project-id/locations/-`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -4974,7 +5015,7 @@ } } }, -"revision": "20240707", +"revision": "20240721", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -7497,6 +7538,22 @@ "$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": "Frequency to update profiles regardless of whether the underlying resource has changed. Defaults to never.", +"enum": [ +"UPDATE_FREQUENCY_UNSPECIFIED", +"UPDATE_FREQUENCY_NEVER", +"UPDATE_FREQUENCY_DAILY", +"UPDATE_FREQUENCY_MONTHLY" +], +"enumDescriptions": [ +"Unspecified.", +"After the data profile is created, it will never be updated.", +"The data profile can be updated up to once every 24 hours.", +"The data profile can be updated up to once every 30 days. Default." +], +"type": "string" +}, "schemaModifiedCadence": { "$ref": "GooglePrivacyDlpV2DiscoverySchemaModifiedCadence", "description": "Governs when to update data profiles when a schema is modified." diff --git a/googleapiclient/discovery_cache/documents/dns.v1.json b/googleapiclient/discovery_cache/documents/dns.v1.json index 9735a9cee25..8b55b945033 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1.json +++ b/googleapiclient/discovery_cache/documents/dns.v1.json @@ -1824,7 +1824,7 @@ } } }, -"revision": "20240627", +"revision": "20240719", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2893,6 +2893,10 @@ "format": "int32", "type": "integer" }, +"internetHealthChecksPerManagedZone": { +"format": "int32", +"type": "integer" +}, "itemsPerRoutingPolicy": { "description": "Maximum allowed number of items per routing policy.", "format": "int32", @@ -3009,6 +3013,10 @@ "geo": { "$ref": "RRSetRoutingPolicyGeoPolicy" }, +"healthCheck": { +"description": "The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", +"type": "string" +}, "kind": { "default": "dns#rRSetRoutingPolicy", "type": "string" @@ -3080,6 +3088,13 @@ "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", "id": "RRSetRoutingPolicyHealthCheckTargets", "properties": { +"externalEndpoints": { +"description": "The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)", +"items": { +"type": "string" +}, +"type": "array" +}, "internalLoadBalancers": { "description": "Configuration for internal load balancers to be health checked.", "items": { diff --git a/googleapiclient/discovery_cache/documents/dns.v1beta2.json b/googleapiclient/discovery_cache/documents/dns.v1beta2.json index 677b1c60c52..18c18fe4413 100644 --- a/googleapiclient/discovery_cache/documents/dns.v1beta2.json +++ b/googleapiclient/discovery_cache/documents/dns.v1beta2.json @@ -1821,7 +1821,7 @@ } } }, -"revision": "20240627", +"revision": "20240719", "rootUrl": "https://dns.googleapis.com/", "schemas": { "Change": { @@ -2890,6 +2890,10 @@ "format": "int32", "type": "integer" }, +"internetHealthChecksPerManagedZone": { +"format": "int32", +"type": "integer" +}, "itemsPerRoutingPolicy": { "description": "Maximum allowed number of items per routing policy.", "format": "int32", @@ -3010,6 +3014,10 @@ "$ref": "RRSetRoutingPolicyGeoPolicy", "deprecated": true }, +"healthCheck": { +"description": "The selfLink attribute of the HealthCheck resource to use for this RRSetRoutingPolicy. https://cloud.google.com/compute/docs/reference/rest/v1/healthChecks", +"type": "string" +}, "kind": { "default": "dns#rRSetRoutingPolicy", "type": "string" @@ -3085,6 +3093,13 @@ "description": "HealthCheckTargets describes endpoints to health-check when responding to Routing Policy queries. Only the healthy endpoints will be included in the response.", "id": "RRSetRoutingPolicyHealthCheckTargets", "properties": { +"externalEndpoints": { +"description": "The Internet IP addresses to be health checked. The format matches the format of ResourceRecordSet.rrdata as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1)", +"items": { +"type": "string" +}, +"type": "array" +}, "internalLoadBalancers": { "description": "Configuration for internal load balancers to be health checked.", "items": { diff --git a/googleapiclient/discovery_cache/documents/drive.v2.json b/googleapiclient/discovery_cache/documents/drive.v2.json index 413513812a8..0603eaf0fa1 100644 --- a/googleapiclient/discovery_cache/documents/drive.v2.json +++ b/googleapiclient/discovery_cache/documents/drive.v2.json @@ -1495,7 +1495,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", -"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files.", +"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -2380,7 +2380,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", -"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files.", +"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -3869,7 +3869,7 @@ } } }, -"revision": "20240628", +"revision": "20240722", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/drive.v3.json b/googleapiclient/discovery_cache/documents/drive.v3.json index 1cc341e8fe7..af2b389ac2f 100644 --- a/googleapiclient/discovery_cache/documents/drive.v3.json +++ b/googleapiclient/discovery_cache/documents/drive.v3.json @@ -1253,7 +1253,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", -"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.", +"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -1612,7 +1612,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", -"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.", +"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -2247,7 +2247,7 @@ "parameters": { "acknowledgeAbuse": { "default": "false", -"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media.", +"description": "Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when the `alt` parameter is set to `media` and the user is the owner of the file or an organizer of the shared drive in which the file resides.", "location": "query", "type": "boolean" }, @@ -2523,7 +2523,7 @@ } } }, -"revision": "20240628", +"revision": "20240722", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { diff --git a/googleapiclient/discovery_cache/documents/file.v1.json b/googleapiclient/discovery_cache/documents/file.v1.json index e60e96ffcce..189a43a6b6a 100644 --- a/googleapiclient/discovery_cache/documents/file.v1.json +++ b/googleapiclient/discovery_cache/documents/file.v1.json @@ -902,7 +902,7 @@ } } }, -"revision": "20240626", +"revision": "20240716", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1118,15 +1118,6 @@ }, "type": "array" }, -"performanceConfig": { -"$ref": "PerformanceConfig", -"description": "Optional. Used to configure performance." -}, -"performanceLimits": { -"$ref": "PerformanceLimits", -"description": "Output only. Used for getting performance limits.", -"readOnly": true -}, "sourceBackup": { "description": "The resource name of the backup, in the format `projects/{project_number}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.", "type": "string" @@ -1134,18 +1125,6 @@ }, "type": "object" }, -"FixedIOPS": { -"description": "Fixed IOPS parameters.", -"id": "FixedIOPS", -"properties": { -"maxReadIops": { -"description": "Required. Maximum raw read IOPS.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudSaasacceleratorManagementProvidersV1Instance": { "description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange", "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance", @@ -1421,18 +1400,6 @@ }, "type": "object" }, -"IOPSPerGB": { -"description": "IOPS per capacity parameters.", -"id": "IOPSPerGB", -"properties": { -"maxReadIopsPerGb": { -"description": "Required. Maximum read IOPS per GB.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "Instance": { "description": "A Filestore instance.", "id": "Instance", @@ -1971,56 +1938,6 @@ }, "type": "object" }, -"PerformanceConfig": { -"description": "Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation.", -"id": "PerformanceConfig", -"properties": { -"fixedIops": { -"$ref": "FixedIOPS", -"description": "Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." -}, -"iopsByCapacity": { -"description": "Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation.", -"type": "boolean" -}, -"iopsPerGb": { -"$ref": "IOPSPerGB", -"description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." -} -}, -"type": "object" -}, -"PerformanceLimits": { -"description": "The enforced performance limits, calculated from the instance's performance configuration.", -"id": "PerformanceLimits", -"properties": { -"maxReadIops": { -"description": "Output only. The max read IOPS.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"maxReadThroughput": { -"description": "Output only. The max read throughput.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"maxWriteIops": { -"description": "Output only. The max write IOPS.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"maxWriteThroughput": { -"description": "Output only. The max write throughput.", -"format": "int64", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "PromoteReplicaRequest": { "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", "id": "PromoteReplicaRequest", diff --git a/googleapiclient/discovery_cache/documents/file.v1beta1.json b/googleapiclient/discovery_cache/documents/file.v1beta1.json index 4641a75596c..97d9a0dbc9c 100644 --- a/googleapiclient/discovery_cache/documents/file.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/file.v1beta1.json @@ -1069,7 +1069,7 @@ } } }, -"revision": "20240704", +"revision": "20240716", "rootUrl": "https://file.googleapis.com/", "schemas": { "Backup": { @@ -1311,15 +1311,6 @@ }, "type": "array" }, -"performanceConfig": { -"$ref": "PerformanceConfig", -"description": "Optional. Used to configure performance." -}, -"performanceLimits": { -"$ref": "PerformanceLimits", -"description": "Output only. Used for getting performance limits.", -"readOnly": true -}, "sourceBackup": { "description": "The resource name of the backup, in the format `projects/{project_id}/locations/{location_id}/backups/{backup_id}`, that this file share has been restored from.", "type": "string" @@ -1327,18 +1318,6 @@ }, "type": "object" }, -"FixedIOPS": { -"description": "Fixed IOPS parameters.", -"id": "FixedIOPS", -"properties": { -"maxReadIops": { -"description": "Required. Maximum raw read IOPS.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudSaasacceleratorManagementProvidersV1Instance": { "description": "Instance represents the interface for SLM services to actuate the state of control plane resources. Example Instance in JSON, where consumer-project-number=123456, producer-project-id=cloud-sql: ```json Instance: { \"name\": \"projects/123456/locations/us-east1/instances/prod-instance\", \"create_time\": { \"seconds\": 1526406431, }, \"labels\": { \"env\": \"prod\", \"foo\": \"bar\" }, \"state\": READY, \"software_versions\": { \"software_update\": \"cloud-sql-09-28-2018\", }, \"maintenance_policy_names\": { \"UpdatePolicy\": \"projects/123456/locations/us-east1/maintenancePolicies/prod-update-policy\", } \"tenant_project_id\": \"cloud-sql-test-tenant\", \"producer_metadata\": { \"cloud-sql-tier\": \"basic\", \"cloud-sql-instance-size\": \"1G\", }, \"provisioned_resources\": [ { \"resource-type\": \"compute-instance\", \"resource-url\": \"https://www.googleapis.com/compute/v1/projects/cloud-sql/zones/us-east1-b/instances/vm-1\", } ], \"maintenance_schedules\": { \"csa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, }, \"ncsa_rollout\": { \"start_time\": { \"seconds\": 1526406431, }, \"end_time\": { \"seconds\": 1535406431, }, } }, \"consumer_defined_name\": \"my-sql-instance1\", } ``` LINT.IfChange", "id": "GoogleCloudSaasacceleratorManagementProvidersV1Instance", @@ -1614,18 +1593,6 @@ }, "type": "object" }, -"IOPSPerGB": { -"description": "IOPS per capacity parameters.", -"id": "IOPSPerGB", -"properties": { -"maxReadIopsPerGb": { -"description": "Required. Maximum read IOPS per GB.", -"format": "int64", -"type": "string" -} -}, -"type": "object" -}, "Instance": { "description": "A Filestore instance.", "id": "Instance", @@ -2269,56 +2236,6 @@ }, "type": "object" }, -"PerformanceConfig": { -"description": "Performance configuration. Used for setting the performance configuration. Defaults to `iops_by_capacity` if unset in instance creation.", -"id": "PerformanceConfig", -"properties": { -"fixedIops": { -"$ref": "FixedIOPS", -"description": "Choose a fixed provisioned IOPS value for the instance, which will remain constant regardless of instance capacity. Value must be a multiple of 1000. If the chosen value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." -}, -"iopsByCapacity": { -"description": "Automatically provision maximum available IOPS based on the capacity of the instance. Larger instances will be granted more IOPS. If instance capacity is increased or decreased, IOPS will be automatically adjusted upwards or downwards accordingly. The maximum available IOPS for a given capacity is defined in Filestore documentation.", -"type": "boolean" -}, -"iopsPerGb": { -"$ref": "IOPSPerGB", -"description": "Provision IOPS dynamically based on the capacity of the instance. Provisioned read IOPS will be calculated by by multiplying the capacity of the instance in GiB by the `iops_per_gb` value, and rounding to the nearest 1000. For example, for a 1 TiB instance with an `iops_per_gb` value of 15, the provisioned read IOPS would be `1024 * 15 = 15,360`, rounded to `15,000`. If the calculated value is outside the supported range for the instance's capacity during instance creation, instance creation will fail with an `InvalidArgument` error. Similarly, if an instance capacity update would result in a value outside the supported range, the update will fail with an `InvalidArgument` error." -} -}, -"type": "object" -}, -"PerformanceLimits": { -"description": "The enforced performance limits, calculated from the instance's performance configuration.", -"id": "PerformanceLimits", -"properties": { -"maxReadIops": { -"description": "Output only. The max read IOPS.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"maxReadThroughput": { -"description": "Output only. The max read throughput.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"maxWriteIops": { -"description": "Output only. The max write IOPS.", -"format": "int64", -"readOnly": true, -"type": "string" -}, -"maxWriteThroughput": { -"description": "Output only. The max write throughput.", -"format": "int64", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "PromoteReplicaRequest": { "description": "PromoteReplicaRequest promotes a Filestore standby instance (replica).", "id": "PromoteReplicaRequest", diff --git a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json index 66106394321..bb201190fd7 100644 --- a/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebaseappdistribution.v1alpha.json @@ -585,9 +585,24 @@ } } }, -"revision": "20240717", +"revision": "20240726", "rootUrl": "https://firebaseappdistribution.googleapis.com/", "schemas": { +"AndroidxCrawlerOutputPoint": { +"description": "Point for describing bounding boxes tap locations Top left is 0,0", +"id": "AndroidxCrawlerOutputPoint", +"properties": { +"xCoordinate": { +"format": "int32", +"type": "integer" +}, +"yCoordinate": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1Release": { "description": "A release of a Firebase app.", "id": "GoogleFirebaseAppdistroV1Release", @@ -734,6 +749,16 @@ "description": "Captures the results of an AiStep", "id": "GoogleFirebaseAppdistroV1alphaAiStepResult", "properties": { +"assertionDetails": { +"$ref": "GoogleFirebaseAppdistroV1alphaAssertionDetails", +"description": "Output only. Details for an assertion step.", +"readOnly": true +}, +"goalDetails": { +"$ref": "GoogleFirebaseAppdistroV1alphaGoalDetails", +"description": "Output only. Details for a goal step.", +"readOnly": true +}, "state": { "description": "Output only. The current state of the step", "enum": [ @@ -827,6 +852,28 @@ }, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaAssertionDetails": { +"description": "Details for an assertion step.", +"id": "GoogleFirebaseAppdistroV1alphaAssertionDetails", +"properties": { +"explanation": { +"description": "Output only. An explanation justifying the assertion result.", +"readOnly": true, +"type": "string" +}, +"result": { +"description": "Output only. The result of the assertion.", +"readOnly": true, +"type": "boolean" +}, +"screenshot": { +"$ref": "GoogleFirebaseAppdistroV1alphaScreenshot", +"description": "Output only. The screenshot used in the context of this assertion.", +"readOnly": true +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest": { "id": "GoogleFirebaseAppdistroV1alphaCreateReleaseNotesRequest", "properties": { @@ -842,6 +889,26 @@ "properties": {}, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaDeviceAction": { +"description": "A high level action taken by the AI on the device, potentially involving multiple taps, text entries, waits, etc.", +"id": "GoogleFirebaseAppdistroV1alphaDeviceAction", +"properties": { +"description": { +"description": "Output only. A short description of the high level action taken by the AI agent.", +"readOnly": true, +"type": "string" +}, +"deviceInteractions": { +"description": "Output only. The interactions made with the device as part of this higher level action taken by the agent, such as taps, text entries, waits, etc.", +"items": { +"$ref": "GoogleFirebaseAppdistroV1alphaDeviceInteraction" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaDeviceExecution": { "description": "The results of running an automated test on a particular device.", "id": "GoogleFirebaseAppdistroV1alphaDeviceExecution", @@ -963,6 +1030,68 @@ }, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaDeviceInteraction": { +"description": "An interaction with the device, such as a tap, text entry, wait, etc.", +"id": "GoogleFirebaseAppdistroV1alphaDeviceInteraction", +"properties": { +"screenshot": { +"$ref": "GoogleFirebaseAppdistroV1alphaScreenshot", +"description": "Output only. The screenshot used in the context of this action. The screen may have changed before the action was actually taken.", +"readOnly": true +}, +"swipe": { +"$ref": "GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe", +"description": "Output only. A swipe action.", +"readOnly": true +}, +"tap": { +"$ref": "AndroidxCrawlerOutputPoint", +"description": "Output only. A tap action.", +"readOnly": true +}, +"textInput": { +"description": "Output only. Text entered for a text entry action.", +"readOnly": true, +"type": "string" +}, +"wait": { +"$ref": "GoogleFirebaseAppdistroV1alphaDeviceInteractionWait", +"description": "Output only. A wait action.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe": { +"description": "A swipe action.", +"id": "GoogleFirebaseAppdistroV1alphaDeviceInteractionSwipe", +"properties": { +"end": { +"$ref": "AndroidxCrawlerOutputPoint", +"description": "Output only. The end point of the swipe.", +"readOnly": true +}, +"start": { +"$ref": "AndroidxCrawlerOutputPoint", +"description": "Output only. The start point of the swipe.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleFirebaseAppdistroV1alphaDeviceInteractionWait": { +"description": "A wait action.", +"id": "GoogleFirebaseAppdistroV1alphaDeviceInteractionWait", +"properties": { +"duration": { +"description": "Output only. The duration of the wait.", +"format": "google-duration", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseRequest": { "id": "GoogleFirebaseAppdistroV1alphaEnableAccessOnReleaseRequest", "properties": { @@ -1107,6 +1236,43 @@ }, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaGoalAction": { +"description": "An action taken by the AI agent while attempting to accomplish a goal.", +"id": "GoogleFirebaseAppdistroV1alphaGoalAction", +"properties": { +"deviceAction": { +"$ref": "GoogleFirebaseAppdistroV1alphaDeviceAction", +"description": "Output only. A high level action taken by the AI on the device.", +"readOnly": true +}, +"explanation": { +"description": "Output only. An explanation justifying why the action was taken.", +"readOnly": true, +"type": "string" +}, +"terminalAction": { +"$ref": "GoogleFirebaseAppdistroV1alphaTerminalAction", +"description": "Output only. An action taken by the AI to end the goal.", +"readOnly": true +} +}, +"type": "object" +}, +"GoogleFirebaseAppdistroV1alphaGoalDetails": { +"description": "Details for a goal step.", +"id": "GoogleFirebaseAppdistroV1alphaGoalDetails", +"properties": { +"goalActions": { +"description": "Output only. The actions taken by the AI while attempting to accomplish the goal.", +"items": { +"$ref": "GoogleFirebaseAppdistroV1alphaGoalAction" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaJwt": { "id": "GoogleFirebaseAppdistroV1alphaJwt", "properties": { @@ -1250,7 +1416,7 @@ "properties": { "aiInstructions": { "$ref": "GoogleFirebaseAppdistroV1alphaAiInstructions", -"description": "Optional. Input only. Instructions for AI driven test. Input only." +"description": "Optional. Instructions for AI driven test." }, "createTime": { "description": "Output only. Timestamp when the test was run.", @@ -1321,6 +1487,57 @@ }, "type": "object" }, +"GoogleFirebaseAppdistroV1alphaScreenshot": { +"description": "A device screenshot taken during a test.", +"id": "GoogleFirebaseAppdistroV1alphaScreenshot", +"properties": { +"height": { +"description": "Output only. The height of the screenshot, in pixels.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"uri": { +"description": "Output only. The URI of the screenshot.", +"readOnly": true, +"type": "string" +}, +"width": { +"description": "Output only. The width of the screenshot, in pixels.", +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, +"GoogleFirebaseAppdistroV1alphaTerminalAction": { +"description": "An action taken by the AI to end the goal.", +"id": "GoogleFirebaseAppdistroV1alphaTerminalAction", +"properties": { +"reason": { +"description": "Output only. The reason why this goal was ended.", +"enum": [ +"REASON_UNSPECIFIED", +"GOAL_IMPOSSIBLE", +"GOAL_COMPLETE" +], +"enumDescriptions": [ +"Reason unspecified.", +"The goal was impossible to accomplish.", +"The goal was completed successfully." +], +"readOnly": true, +"type": "string" +}, +"screenshot": { +"$ref": "GoogleFirebaseAppdistroV1alphaScreenshot", +"description": "Output only. The screenshot used in the context of this terminal action.", +"readOnly": true +} +}, +"type": "object" +}, "GoogleFirebaseAppdistroV1alphaTestConfig": { "description": "Configuration for automated tests", "id": "GoogleFirebaseAppdistroV1alphaTestConfig", diff --git a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json index d5ed50c9f1d..c268de43c32 100644 --- a/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json +++ b/googleapiclient/discovery_cache/documents/firebaseml.v2beta.json @@ -206,7 +206,7 @@ } } }, -"revision": "20240722", +"revision": "20240724", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -708,6 +708,10 @@ "$ref": "GoogleCloudAiplatformV1beta1Schema", "description": "Optional. The `Schema` object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. Represents a select subset of an [OpenAPI 3.0 schema object](https://spec.openapis.org/oas/v3.0.3#schema). If set, a compatible response_mime_type must also be set. Compatible mimetypes: `application/json`: Schema for JSON response." }, +"routingConfig": { +"$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", +"description": "Optional. Routing configuration." +}, "stopSequences": { "description": "Optional. Stop sequences.", "items": { @@ -733,6 +737,55 @@ }, "type": "object" }, +"GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig": { +"description": "Routing config.", +"id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig", +"properties": { +"autoMode": { +"$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", +"description": "Automated routing." +}, +"manualMode": { +"$ref": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", +"description": "Manual routing." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode": { +"description": "When automated routing is specified, the routing will be determined by the pretrained routing model and customer provided model routing preference.", +"id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode", +"properties": { +"modelRoutingPreference": { +"description": "The model routing preference.", +"enum": [ +"UNKNOWN", +"PRIORITIZE_QUALITY", +"BALANCED", +"PRIORITIZE_COST" +], +"enumDescriptions": [ +"Unspecified model routing preference.", +"Prefer higher quality over low cost.", +"Balanced model routing preference.", +"Prefer lower cost over higher quality." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode": { +"description": "When manual routing is set, the specified model will be used directly.", +"id": "GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode", +"properties": { +"modelName": { +"description": "The model name to use. Only the public LLM models are accepted. e.g. gemini-1.5-pro-001.", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval": { "description": "Tool to retrieve public web data for grounding, powered by Google.", "id": "GoogleCloudAiplatformV1beta1GoogleSearchRetrieval", diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index 2b442215d42..7cb8e2bcd43 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -306,42 +306,6 @@ "https://www.googleapis.com/auth/content" ] }, -"list": { -"description": "Lists the tax settings of the sub-accounts only in your Merchant Center account. This method can only be called on a multi-client account, otherwise it'll return an error.", -"flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax", -"httpMethod": "GET", -"id": "merchantapi.accounts.accounttax.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"pageSize": { -"description": "The maximum number of tax settings to return in the response, used for paging.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "The token returned by the previous request.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The parent, which owns this collection of account tax. Format: accounts/{account}", -"location": "path", -"pattern": "^accounts/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "accounts/v1beta/{+parent}/accounttax", -"response": { -"$ref": "ListAccountTaxResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/content" -] -}, "patch": { "description": "Updates the tax settings of the account.", "flatPath": "accounts/v1beta/accounts/{accountsId}/accounttax/{accounttaxId}", @@ -1453,7 +1417,7 @@ } } }, -"revision": "20240719", +"revision": "20240728", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AcceptTermsOfService": { @@ -2275,24 +2239,6 @@ false }, "type": "object" }, -"ListAccountTaxResponse": { -"description": "Response to account tax list request This method can only be called on a multi-client account, otherwise it'll return an error.", -"id": "ListAccountTaxResponse", -"properties": { -"accountTaxes": { -"description": "Page of accounttax settings", -"items": { -"$ref": "AccountTax" -}, -"type": "array" -}, -"nextPageToken": { -"description": "The token for the retrieval of the next page of account tax settings.", -"type": "string" -} -}, -"type": "object" -}, "ListAccountsResponse": { "description": "Response message for the `ListAccounts` method.", "id": "ListAccountsResponse", diff --git a/googleapiclient/discovery_cache/documents/monitoring.v1.json b/googleapiclient/discovery_cache/documents/monitoring.v1.json index 8d5237871ee..3ced827d911 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v1.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v1.json @@ -463,7 +463,7 @@ "type": "string" }, "name": { -"description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", +"description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -500,7 +500,7 @@ "type": "string" }, "name": { -"description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", +"description": "Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -537,7 +537,7 @@ "type": "string" }, "name": { -"description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", +"description": "Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -574,7 +574,7 @@ "type": "string" }, "name": { -"description": "The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", +"description": "Required. The project on which to execute the request. Data associcated with the project's workspace stored under the The format is: projects/PROJECT_ID_OR_NUMBER. Open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -669,7 +669,7 @@ "type": "string" }, "name": { -"description": "The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", +"description": "Required. The workspace on which to execute the request. It is not part of the open source API but used as a request path prefix to distinguish different virtual Prometheus instances of Google Prometheus Engine. The format is: projects/PROJECT_ID_OR_NUMBER.", "location": "path", "pattern": "^projects/[^/]+$", "required": true, @@ -753,7 +753,7 @@ } } }, -"revision": "20240707", +"revision": "20240721", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -1119,7 +1119,8 @@ "METRIC_LABEL", "USER_METADATA_LABEL", "SYSTEM_METADATA_LABEL", -"GROUP" +"GROUP", +"VALUE_ONLY" ], "enumDescriptions": [ "Filter type is unspecified. This is not valid in a well-formed request.", @@ -1127,21 +1128,48 @@ "Filter on a metrics label value", "Filter on a user metadata label value", "Filter on a system metadata label value", -"Filter on a group id" +"Filter on a group id", +"Filter that only contains a value. The label_key field must be unset for filters of this type." ], "type": "string" }, "labelKey": { -"description": "Required. The key for the label", +"description": "Optional. The key for the label. This must be omitted if the filter_type is VALUE_ONLY but is required otherwise.", "type": "string" }, +"stringArray": { +"$ref": "StringArray", +"description": "A list of possible string values for the filter" +}, +"stringArrayValue": { +"$ref": "StringArray", +"description": "An array of variable-length string values. If this field is set, value_type must be set to STRING_ARRAY or VALUE_TYPE_UNSPECIFIED" +}, "stringValue": { -"description": "A variable-length string value.", +"description": "A variable-length string value. If this field is set, value_type must be set to STRING or VALUE_TYPE_UNSPECIFIED", "type": "string" }, "templateVariable": { "description": "The placeholder text that can be referenced in a filter string or MQL query. If omitted, the dashboard filter will be applied to all relevant widgets in the dashboard.", "type": "string" +}, +"timeSeriesQuery": { +"$ref": "TimeSeriesQuery", +"description": "A query to run to fetch possible values for the filter. Only OpsAnalyticsQueries are supported" +}, +"valueType": { +"description": "The type of the filter value. If value_type is not provided, it will be inferred from the default_value. If neither value_type nor default_value is provided, value_type will be set to STRING by default.", +"enum": [ +"VALUE_TYPE_UNSPECIFIED", +"STRING", +"STRING_ARRAY" +], +"enumDescriptions": [ +"Value type is unspecified", +"String type", +"String array type" +], +"type": "string" } }, "type": "object" @@ -2301,6 +2329,20 @@ }, "type": "object" }, +"StringArray": { +"description": "An array of strings", +"id": "StringArray", +"properties": { +"values": { +"description": "The values of the array", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "TableDataSet": { "description": "Groups a time series query definition with table options.", "id": "TableDataSet", diff --git a/googleapiclient/discovery_cache/documents/monitoring.v3.json b/googleapiclient/discovery_cache/documents/monitoring.v3.json index c6fa3c6e576..96adb2de0c9 100644 --- a/googleapiclient/discovery_cache/documents/monitoring.v3.json +++ b/googleapiclient/discovery_cache/documents/monitoring.v3.json @@ -2714,7 +2714,7 @@ } } }, -"revision": "20240630", +"revision": "20240721", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -2928,7 +2928,7 @@ }, "notificationRateLimit": { "$ref": "NotificationRateLimit", -"description": "Required for alert policies with a LogMatch condition.This limit is not implemented for alert policies that are not log-based." +"description": "Required for log-based alert policies, i.e. policies with a LogMatch condition.This limit is not implemented for alert policies that do not have a LogMatch condition." } }, "type": "object" @@ -5639,6 +5639,10 @@ "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.", "id": "TimeSeries", "properties": { +"description": { +"description": "Input only. A detailed description of the time series that will be associated with the google.api.MetricDescriptor for the metric. Once set, this field cannot be changed through CreateTimeSeries.", +"type": "string" +}, "metadata": { "$ref": "MonitoredResourceMetadata", "description": "Output only. The associated monitored resource metadata. When reading a time series, this field will include metadata labels that are explicitly named in the reduction. When creating a time series, this field is ignored." @@ -5675,7 +5679,7 @@ "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data. For more information, see Monitored resources for custom metrics (https://cloud.google.com/monitoring/custom-metrics/creating-metrics#custom-metric-resources)." }, "unit": { -"description": "The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values.", +"description": "The units in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The unit defines the representation of the stored metric values. This field can only be changed through CreateTimeSeries when it is empty or \"1\".", "type": "string" }, "valueType": { diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index 55b833c8a4d..ea4e54dd235 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -2812,7 +2812,7 @@ } } }, -"revision": "20240624", +"revision": "20240717", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -4926,7 +4926,7 @@ "type": "array" }, "serviceClass": { -"description": "The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp. For example, gcp-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.", +"description": "The service class identifier for which this ServiceConnectionPolicy is for. The service class identifier is a unique, symbolic representation of a ServiceClass. It is provided by the Service Producer. Google services have a prefix of gcp or google-cloud. For example, gcp-memorystore-redis or google-cloud-sql. 3rd party services do not. For example, test-service-a3dfcx.", "type": "string" }, "updateTime": { diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index d237e2a66d3..d42eabf5c4f 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240626", +"revision": "20240718", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1702,6 +1702,10 @@ false "description": "URI of a Compute Engine network.", "type": "string" }, +"pscNetworkAttachmentUri": { +"description": "URI of the PSC network attachment the NIC is attached to (if relevant).", +"type": "string" +}, "serviceAccount": { "deprecated": true, "description": "Service account authorized for the instance.", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index 6b6199b95cf..14510d86df2 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20240626", +"revision": "20240718", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1707,6 +1707,10 @@ false "description": "URI of a Compute Engine network.", "type": "string" }, +"pscNetworkAttachmentUri": { +"description": "URI of the PSC network attachment the NIC is attached to (if relevant).", +"type": "string" +}, "serviceAccount": { "deprecated": true, "description": "Service account authorized for the instance.", diff --git a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json index e768a76a778..334c9e1d613 100644 --- a/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networksecurity.v1beta1.json @@ -1729,6 +1729,188 @@ } } }, +"authzPolicies": { +"methods": { +"create": { +"description": "Creates a new AuthzPolicy in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies", +"httpMethod": "POST", +"id": "networksecurity.projects.locations.authzPolicies.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"authzPolicyId": { +"description": "Required. User-provided ID of the `AuthzPolicy` resource to be created.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent resource of the `AuthzPolicy` resource. Must be in the format `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+parent}/authzPolicies", +"request": { +"$ref": "AuthzPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a single AuthzPolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}", +"httpMethod": "DELETE", +"id": "networksecurity.projects.locations.authzPolicies.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the `AuthzPolicy` resource to delete. Must be in the format `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", +"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 can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets details of a single AuthzPolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.authzPolicies.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. A name of the `AuthzPolicy` resource to get. Must be in the format `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"response": { +"$ref": "AuthzPolicy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists AuthzPolicies in a given project and location.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies", +"httpMethod": "GET", +"id": "networksecurity.projects.locations.authzPolicies.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Filtering results.", +"location": "query", +"type": "string" +}, +"orderBy": { +"description": "Optional. Hint for how to order the results.", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. A token identifying a page of results that the server returns.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The project and location from which the `AuthzPolicy` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/authzPolicies", +"response": { +"$ref": "ListAuthzPoliciesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"patch": { +"description": "Updates the parameters of a single AuthzPolicy.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/authzPolicies/{authzPoliciesId}", +"httpMethod": "PATCH", +"id": "networksecurity.projects.locations.authzPolicies.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authzPolicies/[^/]+$", +"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 can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", +"location": "query", +"type": "string" +}, +"updateMask": { +"description": "Required. Used to specify the fields to be overwritten in the `AuthzPolicy` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v1beta1/{+name}", +"request": { +"$ref": "AuthzPolicy" +}, +"response": { +"$ref": "Operation" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +}, "clientTlsPolicies": { "methods": { "create": { @@ -3162,7 +3344,7 @@ } } }, -"revision": "20240626", +"revision": "20240722", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3320,6 +3502,336 @@ }, "type": "object" }, +"AuthzPolicy": { +"description": "`AuthzPolicy` is a resource that allows to forward traffic to a callout backend designed to scan the traffic for security purposes.", +"id": "AuthzPolicy", +"properties": { +"action": { +"description": "Required. Can be one of ALLOW, DENY, CUSTOM. When the action is CUSTOM, customProvider must be specified. When the action is ALLOW, only requests matching the policy will be allowed. When the action is DENY, only requests matching the policy will be denied. When a request arrives, the policies are evaluated in the following order: 1. If there is a CUSTOM policy that matches the request, the CUSTOM policy is evaluated using the custom authorization providers and the request is denied if the provider rejects the request. 2. If there are any DENY policies that match the request, the request is denied. 3. If there are no ALLOW policies for the resource or if any of the ALLOW policies match the request, the request is allowed. 4. Else the request is denied by default if none of the configured AuthzPolicies with ALLOW action match the request.", +"enum": [ +"AUTHZ_ACTION_UNSPECIFIED", +"ALLOW", +"DENY", +"CUSTOM" +], +"enumDescriptions": [ +"Unspecified action.", +"Allow request to pass through to the backend.", +"Deny the request and return a HTTP 404 to the client.", +"Delegate the authorization decision to an external authorization engine." +], +"type": "string" +}, +"createTime": { +"description": "Output only. The timestamp when the resource was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"customProvider": { +"$ref": "AuthzPolicyCustomProvider", +"description": "Optional. Required if the action is CUSTOM. Allows delegating authorization decisions to Cloud IAP or to Service Extensions. One of cloudIap or authzExtension must be specified." +}, +"description": { +"description": "Optional. A human-readable description of the resource.", +"type": "string" +}, +"httpRules": { +"description": "Optional. A list of authorization HTTP rules to match against the incoming request. A policy match occurs when at least one HTTP rule matches the request or when no HTTP rules are specified in the policy. At least one HTTP Rule is required for Allow or Deny Action.", +"items": { +"$ref": "AuthzPolicyAuthzRule" +}, +"type": "array" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Set of labels associated with the `AuthzPolicy` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", +"type": "object" +}, +"name": { +"description": "Required. Identifier. Name of the `AuthzPolicy` resource in the following format: `projects/{project}/locations/{location}/authzPolicies/{authz_policy}`.", +"type": "string" +}, +"target": { +"$ref": "AuthzPolicyTarget", +"description": "Required. Specifies the set of resources to which this policy should be applied to." +}, +"updateTime": { +"description": "Output only. The timestamp when the resource was updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRule": { +"description": "Conditions to match against the incoming request.", +"id": "AuthzPolicyAuthzRule", +"properties": { +"from": { +"$ref": "AuthzPolicyAuthzRuleFrom", +"description": "Optional. Describes properties of one or more sources of a request." +}, +"to": { +"$ref": "AuthzPolicyAuthzRuleTo", +"description": "Optional. Describes properties of one or more targets of a request." +}, +"when": { +"description": "Optional. CEL expression that describes the conditions to be satisfied for the action. The result of the CEL expression is ANDed with the from and to. Refer to the CEL language reference for a list of available attributes.", +"type": "string" +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleFrom": { +"description": "Describes properties of one or more sources of a request.", +"id": "AuthzPolicyAuthzRuleFrom", +"properties": { +"notSources": { +"description": "Optional. Describes the negated properties of request sources. Matches requests from sources that do not match the criteria specified in this field. At least one of sources or notSources must be specified.", +"items": { +"$ref": "AuthzPolicyAuthzRuleFromRequestSource" +}, +"type": "array" +}, +"sources": { +"description": "Optional. Describes the properties of a request's sources. At least one of sources or notSources must be specified. Limited to 10 sources. A match occurs when ANY source (in sources or notSources) matches the request. Within a single source, the match follows AND semantics across fields and OR semantics within a single field, i.e. a match occurs when ANY principal matches AND ANY ipBlocks match.", +"items": { +"$ref": "AuthzPolicyAuthzRuleFromRequestSource" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleFromRequestSource": { +"description": "Describes the properties of a single source.", +"id": "AuthzPolicyAuthzRuleFromRequestSource", +"properties": { +"principals": { +"description": "Optional. A list of identities derived from the client's certificate. This field will not match on a request unless mutual TLS is enabled for the Forwarding rule or Gateway. Each identity is a string whose value is matched against the URI SAN, or DNS SAN or the subject field in the client's certificate. The match can be exact, prefix, suffix or a substring match. One of exact, prefix, suffix or contains must be specified. Limited to 10 principals.", +"items": { +"$ref": "AuthzPolicyAuthzRuleStringMatch" +}, +"type": "array" +}, +"resources": { +"description": "Optional. A list of resources to match against the resource of the source VM of a request. Limited to 10 resources.", +"items": { +"$ref": "AuthzPolicyAuthzRuleRequestResource" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleHeaderMatch": { +"description": "Determines how a HTTP header should be matched.", +"id": "AuthzPolicyAuthzRuleHeaderMatch", +"properties": { +"name": { +"description": "Optional. Specifies the name of the header in the request.", +"type": "string" +}, +"value": { +"$ref": "AuthzPolicyAuthzRuleStringMatch", +"description": "Optional. Specifies how the header match will be performed." +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleRequestResource": { +"description": "Describes the properties of a client VM resource accessing the internal application load balancers.", +"id": "AuthzPolicyAuthzRuleRequestResource", +"properties": { +"iamServiceAccount": { +"$ref": "AuthzPolicyAuthzRuleStringMatch", +"description": "Optional. An IAM service account to match against the source service account of the VM sending the request." +}, +"tagValueIdSet": { +"$ref": "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet", +"description": "Optional. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request." +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleRequestResourceTagValueIdSet": { +"description": "Describes a set of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request.", +"id": "AuthzPolicyAuthzRuleRequestResourceTagValueIdSet", +"properties": { +"ids": { +"description": "Required. A list of resource tag value permanent IDs to match against the resource manager tags value associated with the source VM of a request. The match follows AND semantics which means all the ids must match. Limited to 10 matches.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleStringMatch": { +"description": "Determines how a string value should be matched.", +"id": "AuthzPolicyAuthzRuleStringMatch", +"properties": { +"contains": { +"description": "The input string must have the substring specified here. Note: empty contains match is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc.def``", +"type": "string" +}, +"exact": { +"description": "The input string must match exactly the string specified here. Examples: * ``abc`` only matches the value ``abc``.", +"type": "string" +}, +"ignoreCase": { +"description": "If true, indicates the exact/prefix/suffix/contains matching should be case insensitive. For example, the matcher ``data`` will match both input string ``Data`` and ``data`` if set to true.", +"type": "boolean" +}, +"prefix": { +"description": "The input string must have the prefix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``abc.xyz``", +"type": "string" +}, +"suffix": { +"description": "The input string must have the suffix specified here. Note: empty prefix is not allowed, please use regex instead. Examples: * ``abc`` matches the value ``xyz.abc``", +"type": "string" +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleTo": { +"description": "Describes properties of one or more targets of a request.", +"id": "AuthzPolicyAuthzRuleTo", +"properties": { +"notOperations": { +"description": "Optional. Describes the negated properties of the targets of a request. Matches requests for operations that do not match the criteria specified in this field. At least one of operations or notOperations must be specified.", +"items": { +"$ref": "AuthzPolicyAuthzRuleToRequestOperation" +}, +"type": "array" +}, +"operations": { +"description": "Optional. Describes properties of one or more targets of a request. At least one of operations or notOperations must be specified. Limited to 10 operations. A match occurs when ANY operation (in operations or notOperations) matches. Within an operation, the match follows AND semantics across fields and OR semantics within a field, i.e. a match occurs when ANY path matches AND ANY header matches and ANY method matches.", +"items": { +"$ref": "AuthzPolicyAuthzRuleToRequestOperation" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleToRequestOperation": { +"description": "Describes properties of one or more targets of a request.", +"id": "AuthzPolicyAuthzRuleToRequestOperation", +"properties": { +"headerSet": { +"$ref": "AuthzPolicyAuthzRuleToRequestOperationHeaderSet", +"description": "Optional. A list of headers to match against in http header." +}, +"hosts": { +"description": "Optional. A list of HTTP Hosts to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.", +"items": { +"$ref": "AuthzPolicyAuthzRuleStringMatch" +}, +"type": "array" +}, +"methods": { +"description": "Optional. A list of HTTP methods to match against. Each entry must be a valid HTTP method name (GET, PUT, POST, HEAD, PATCH, DELETE, OPTIONS). It only allows exact match and is always case sensitive.", +"items": { +"type": "string" +}, +"type": "array" +}, +"paths": { +"description": "Optional. A list of paths to match against. The match can be one of exact, prefix, suffix, or contains (substring match). Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches. Note that this path match includes the query parameters. For gRPC services, this should be a fully-qualified name of the form /package.service/method.", +"items": { +"$ref": "AuthzPolicyAuthzRuleStringMatch" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthzPolicyAuthzRuleToRequestOperationHeaderSet": { +"description": "Describes a set of HTTP headers to match against.", +"id": "AuthzPolicyAuthzRuleToRequestOperationHeaderSet", +"properties": { +"headers": { +"description": "Required. A list of headers to match against in http header. The match can be one of exact, prefix, suffix, or contains (substring match). The match follows AND semantics which means all the headers must match. Matches are always case sensitive unless the ignoreCase is set. Limited to 10 matches.", +"items": { +"$ref": "AuthzPolicyAuthzRuleHeaderMatch" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthzPolicyCustomProvider": { +"description": "Allows delegating authorization decisions to Cloud IAP or to Service Extensions.", +"id": "AuthzPolicyCustomProvider", +"properties": { +"authzExtension": { +"$ref": "AuthzPolicyCustomProviderAuthzExtension", +"description": "Optional. Delegate authorization decision to user authored Service Extension. Only one of cloudIap or authzExtension can be specified." +}, +"cloudIap": { +"$ref": "AuthzPolicyCustomProviderCloudIap", +"description": "Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places." +} +}, +"type": "object" +}, +"AuthzPolicyCustomProviderAuthzExtension": { +"description": "Optional. Delegate authorization decision to user authored extension. Only one of cloudIap or authzExtension can be specified.", +"id": "AuthzPolicyCustomProviderAuthzExtension", +"properties": { +"resources": { +"description": "Required. A list of references to authorization extensions that will be invoked for requests matching this policy. Limited to 1 custom provider.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"AuthzPolicyCustomProviderCloudIap": { +"description": "Optional. Delegates authorization decisions to Cloud IAP. Applicable only for managed load balancers. Enabling Cloud IAP at the AuthzPolicy level is not compatible with Cloud IAP settings in the BackendService. Enabling IAP in both places will result in request failure. Ensure that IAP is enabled in either the AuthzPolicy or the BackendService but not in both places.", +"id": "AuthzPolicyCustomProviderCloudIap", +"properties": {}, +"type": "object" +}, +"AuthzPolicyTarget": { +"description": "Specifies the set of targets to which this policy should be applied to.", +"id": "AuthzPolicyTarget", +"properties": { +"loadBalancingScheme": { +"description": "Required. All gateways and forwarding rules referenced by this policy and extensions must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED` and `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", +"enum": [ +"LOAD_BALANCING_SCHEME_UNSPECIFIED", +"INTERNAL_MANAGED", +"EXTERNAL_MANAGED", +"INTERNAL_SELF_MANAGED" +], +"enumDescriptions": [ +"Default value. Do not use.", +"Signifies that this is used for Regional internal or Cross-region internal Application Load Balancing.", +"Signifies that this is used for Global external or Regional external Application Load Balancing.", +"Signifies that this is used for Cloud Service Mesh." +], +"type": "string" +}, +"resources": { +"description": "Required. A list of references to the Forwarding Rules on which this policy will be applied.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "CancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "id": "CancelOperationRequest", @@ -3982,6 +4494,31 @@ }, "type": "object" }, +"ListAuthzPoliciesResponse": { +"description": "Message for response to listing `AuthzPolicy` resources.", +"id": "ListAuthzPoliciesResponse", +"properties": { +"authzPolicies": { +"description": "The list of `AuthzPolicy` resources.", +"items": { +"$ref": "AuthzPolicy" +}, +"type": "array" +}, +"nextPageToken": { +"description": "A token identifying a page of results that the server returns.", +"type": "string" +}, +"unreachable": { +"description": "Locations that could not be reached.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "ListClientTlsPoliciesResponse": { "description": "Response returned by the ListClientTlsPolicies method.", "id": "ListClientTlsPoliciesResponse", diff --git a/googleapiclient/discovery_cache/documents/playintegrity.v1.json b/googleapiclient/discovery_cache/documents/playintegrity.v1.json index 202d0c942e0..e19cf7f10aa 100644 --- a/googleapiclient/discovery_cache/documents/playintegrity.v1.json +++ b/googleapiclient/discovery_cache/documents/playintegrity.v1.json @@ -170,7 +170,7 @@ } } }, -"revision": "20240711", +"revision": "20240725", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { @@ -370,6 +370,10 @@ "description": "Contains the device attestation information. Next tag: 4", "id": "DeviceIntegrity", "properties": { +"deviceRecall": { +"$ref": "DeviceRecall", +"description": "Details about the device recall bits set by the developer." +}, "deviceRecognitionVerdict": { "description": "Details about the integrity of the device the app is running on.", "items": { @@ -398,6 +402,21 @@ }, "type": "object" }, +"DeviceRecall": { +"description": "Contains the recall bits per device set by the developer. Next tag: 3", +"id": "DeviceRecall", +"properties": { +"values": { +"$ref": "Values", +"description": "Required. Contains the recall bits values." +}, +"writeDates": { +"$ref": "WriteDates", +"description": "Required. Contains the recall bits write dates." +} +}, +"type": "object" +}, "EnvironmentDetails": { "description": "Contains information about the environment Play Integrity API runs in, e.g. Play Protect verdict.", "id": "EnvironmentDetails", @@ -543,6 +562,28 @@ }, "type": "object" }, +"WriteDates": { +"description": "Contains the recall bits write dates.", +"id": "WriteDates", +"properties": { +"yyyymmFirst": { +"description": "Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the first bit. Note that this value won't be set if the first bit is false.", +"format": "int32", +"type": "integer" +}, +"yyyymmSecond": { +"description": "Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the second bit. Note that this value won't be set if the second bit is false.", +"format": "int32", +"type": "integer" +}, +"yyyymmThird": { +"description": "Optional. Write time in YYYYMM format (in UTC, e.g. 202402) for the third bit. Note that this value won't be set if the third bit is false.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, "WriteDeviceRecallRequest": { "description": "Request to write device recall bits.", "id": "WriteDeviceRecallRequest", diff --git a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json index c285e7ae463..db07c5d7624 100644 --- a/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json +++ b/googleapiclient/discovery_cache/documents/recaptchaenterprise.v1.json @@ -349,6 +349,34 @@ }, "keys": { "methods": { +"addIpOverride": { +"description": "Adds an IP override to a key. The following restrictions hold: * The maximum number of IP overrides per key is 100. * For any conflict (such as IP already exists or IP part of an existing IP range), an error will be returned.", +"flatPath": "v1/projects/{projectsId}/keys/{keysId}:addIpOverride", +"httpMethod": "POST", +"id": "recaptchaenterprise.projects.keys.addIpOverride", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the key to which the IP override is added, in the format `projects/{project}/keys/{key}`.", +"location": "path", +"pattern": "^projects/[^/]+/keys/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+name}:addIpOverride", +"request": { +"$ref": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest" +}, +"response": { +"$ref": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "create": { "description": "Creates a new reCAPTCHA Enterprise key.", "flatPath": "v1/projects/{projectsId}/keys", @@ -694,7 +722,7 @@ } } }, -"revision": "20240713", +"revision": "20240721", "rootUrl": "https://recaptchaenterprise.googleapis.com/", "schemas": { "GoogleCloudRecaptchaenterpriseV1AccountDefenderAssessment": { @@ -778,6 +806,23 @@ }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest": { +"description": "The AddIpOverride request message.", +"id": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideRequest", +"properties": { +"ipOverrideData": { +"$ref": "GoogleCloudRecaptchaenterpriseV1IpOverrideData", +"description": "Required. IP override added to the key." +} +}, +"type": "object" +}, +"GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse": { +"description": "Response for AddIpOverride.", +"id": "GoogleCloudRecaptchaenterpriseV1AddIpOverrideResponse", +"properties": {}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings": { "description": "Settings specific to keys that can be used by Android apps.", "id": "GoogleCloudRecaptchaenterpriseV1AndroidKeySettings", @@ -1391,6 +1436,29 @@ true }, "type": "object" }, +"GoogleCloudRecaptchaenterpriseV1IpOverrideData": { +"description": "Information about the IP or IP range override.", +"id": "GoogleCloudRecaptchaenterpriseV1IpOverrideData", +"properties": { +"ip": { +"description": "Required. The IP address to override (can be IPv4, IPv6 or CIDR). The IP override must be a valid IPv4 or IPv6 address, or a CIDR range. The IP override must be a public IP address. Example of IPv4: 168.192.5.6 Example of IPv6: 2001:0000:130F:0000:0000:09C0:876A:130B Example of IPv4 with CIDR: 168.192.5.0/24 Example of IPv6 with CIDR: 2001:0DB8:1234::/48", +"type": "string" +}, +"overrideType": { +"description": "Required. Describes the type of IP override.", +"enum": [ +"OVERRIDE_TYPE_UNSPECIFIED", +"ALLOW" +], +"enumDescriptions": [ +"Default override type that indicates this enum hasn't been specified.", +"Allowlist the IP address; i.e. give a `risk_analysis.score` of 0.9 for all valid assessments." +], +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudRecaptchaenterpriseV1Key": { "description": "A key used to identify and configure applications (web and/or mobile) that use reCAPTCHA Enterprise.", "id": "GoogleCloudRecaptchaenterpriseV1Key", diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index b3e1b649cb7..9da164c3d96 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -2614,7 +2614,7 @@ } } }, -"revision": "20240712", +"revision": "20240719", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -5381,7 +5381,7 @@ false "additionalProperties": { "type": "string" }, -"description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", +"description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/base-images`: Revision, Service. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/build-environment-variables`: Service. * `run.googleapis.com/build-id`: Service. * `run.googleapis.com/build-service-account`: Service. * `run.googleapis.com/build-worker-pool`: Service. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision . * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/default-url-disabled`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/function-target`: Service. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/minScale`: Service (ALPHA) * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/source-location`: Service. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", "type": "object" }, "clusterName": { diff --git a/googleapiclient/discovery_cache/documents/walletobjects.v1.json b/googleapiclient/discovery_cache/documents/walletobjects.v1.json index 1986fab15e8..bc612a1fc97 100644 --- a/googleapiclient/discovery_cache/documents/walletobjects.v1.json +++ b/googleapiclient/discovery_cache/documents/walletobjects.v1.json @@ -2681,7 +2681,7 @@ } } }, -"revision": "20240723", +"revision": "20240726", "rootUrl": "https://walletobjects.googleapis.com/", "schemas": { "ActivationOptions": { @@ -5335,6 +5335,13 @@ true "$ref": "Image", "description": "The logo image of the pass. This image is displayed in the card detail view in upper left, and also on the list/thumbnail view. If the logo is not present, the first letter of `cardTitle` would be shown as logo." }, +"messages": { +"description": "An array of messages displayed in the app. All users of this object will receive its associated messages. The maximum number of these fields is 10.", +"items": { +"$ref": "Message" +}, +"type": "array" +}, "notifications": { "$ref": "Notifications", "description": "The notification settings that are enabled for this object." diff --git a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json index 02023de594c..55b210c7e2e 100644 --- a/googleapiclient/discovery_cache/documents/workloadmanager.v1.json +++ b/googleapiclient/discovery_cache/documents/workloadmanager.v1.json @@ -772,7 +772,7 @@ } } }, -"revision": "20240701", +"revision": "20240717", "rootUrl": "https://workloadmanager.googleapis.com/", "schemas": { "AgentCommand": { @@ -1112,7 +1112,7 @@ "id": "ExternalDataSources", "properties": { "assetType": { -"description": "Required. The asset type of the external data source must be one of go/cai-asset-types", +"description": "Required. The asset type of the external data source this can be one of go/cai-asset-types to override the default asset type or it can be a custom type defined by the user custom type must match the asset type in the rule", "type": "string" }, "name": { @@ -1195,6 +1195,10 @@ "IsolationExpectations": { "id": "IsolationExpectations", "properties": { +"requirementOverride": { +"$ref": "RequirementOverride", +"description": "Explicit overrides for ZI and ZS requirements to be used for resources that should be excluded from ZI/ZS verification logic." +}, "ziOrgPolicy": { "enum": [ "ZI_UNSPECIFIED", @@ -1654,6 +1658,44 @@ }, "type": "object" }, +"RequirementOverride": { +"id": "RequirementOverride", +"properties": { +"ziOverride": { +"enum": [ +"ZI_UNSPECIFIED", +"ZI_UNKNOWN", +"ZI_NOT_REQUIRED", +"ZI_PREFERRED", +"ZI_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"", +"" +], +"type": "string" +}, +"zsOverride": { +"enum": [ +"ZS_UNSPECIFIED", +"ZS_UNKNOWN", +"ZS_NOT_REQUIRED", +"ZS_REQUIRED" +], +"enumDescriptions": [ +"", +"To be used if tracking is not available", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, "Resource": { "description": "Message represent resource in execution result", "id": "Resource", @@ -2128,14 +2170,36 @@ "INSTANCE_ROLE_ASCS", "INSTANCE_ROLE_ERS", "INSTANCE_ROLE_APP_SERVER", -"INSTANCE_ROLE_DATABASE" +"INSTANCE_ROLE_DATABASE", +"INSTANCE_ROLE_ASCS_ERS", +"INSTANCE_ROLE_ASCS_APP_SERVER", +"INSTANCE_ROLE_ASCS_DATABASE", +"INSTANCE_ROLE_ERS_APP_SERVER", +"INSTANCE_ROLE_ERS_DATABASE", +"INSTANCE_ROLE_APP_SERVER_DATABASE", +"INSTANCE_ROLE_ASCS_ERS_APP_SERVER", +"INSTANCE_ROLE_ASCS_ERS_DATABASE", +"INSTANCE_ROLE_ASCS_APP_SERVER_DATABASE", +"INSTANCE_ROLE_ERS_APP_SERVER_DATABASE", +"INSTANCE_ROLE_ASCS_ERS_APP_SERVER_DATABASE" ], "enumDescriptions": [ "Unspecified instance role.", "Application central services.", "Enqueue replication server.", "Application server.", -"Database node." +"Database node.", +"Combinations of roles. Application central services and enqueue replication server.", +"Application central services and application server.", +"Application central services and database.", +"Enqueue replication server and application server.", +"Enqueue replication server and database.", +"Application server and database.", +"Application central services, enqueue replication server and application server.", +"Application central services, enqueue replication server and database.", +"Application central services, application server and database.", +"Enqueue replication server, application server and database.", +"Application central services, enqueue replication server, application server and database." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json index 45147f9141d..779285303df 100644 --- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json +++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json @@ -6,25 +6,25 @@ "description": "Private Service: https://www.googleapis.com/auth/chat.bot" }, "https://www.googleapis.com/auth/chat.memberships": { -"description": "View, add, update, and remove members from conversations in Google Chat" +"description": "See, add, update, and remove members from conversations and spaces in Google Chat" }, "https://www.googleapis.com/auth/chat.memberships.readonly": { "description": "View members in Google Chat conversations." }, "https://www.googleapis.com/auth/chat.messages": { -"description": "View, compose, send, update, and delete messages, and add, view, and delete reactions to messages." +"description": "See, compose, send, update, and delete messages and their associated attachments, and add, see, and delete reactions to messages." }, "https://www.googleapis.com/auth/chat.messages.reactions": { -"description": "View, add, and delete reactions to messages in Google Chat" +"description": "See, add, and delete reactions to messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.reactions.readonly": { "description": "View reactions to messages in Google Chat" }, "https://www.googleapis.com/auth/chat.messages.readonly": { -"description": "View messages and reactions in Google Chat" +"description": "See messages and their associated reactions and attachments in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces": { -"description": "Create conversations and spaces and see or edit metadata (including history settings and access settings) in Google Chat" +"description": "Create conversations and spaces and see or update metadata (including history settings and access settings) in Google Chat" }, "https://www.googleapis.com/auth/chat.spaces.readonly": { "description": "View chat and spaces in Google Chat" @@ -424,7 +424,7 @@ } } }, -"revision": "20240702", +"revision": "20240723", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "ListSubscriptionsResponse": { From 33762a6405456ca7eae3b5edfbb130eacdda7912 Mon Sep 17 00:00:00 2001 From: "release-please[bot]" <55107282+release-please[bot]@users.noreply.github.com> Date: Tue, 30 Jul 2024 10:25:50 -0400 Subject: [PATCH 8/8] chore(main): release 2.139.0 (#2455) Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com> --- CHANGELOG.md | 29 +++++++++++++++++++++++++++++ googleapiclient/version.py | 2 +- 2 files changed, 30 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 46a639a7a36..4449bc241a1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,34 @@ # Changelog +## [2.139.0](https://github.com/googleapis/google-api-python-client/compare/v2.138.0...v2.139.0) (2024-07-30) + + +### Features + +* **appengine:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/17887bc99c42a827a837c887d47f76d75748de0d ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **bigquery:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ad010606ac5dd1b0468b25a4a66898de4e857d3b ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **bigtableadmin:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/544d82ff49b5995208a1739d5274bfe123c59444 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **cloudbuild:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/ad5f56d082ea3251d6da647566435d166fd6b6e7 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **contactcenterinsights:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/1a732f0eb101f373e7a2ae6c91156e05fb7d65ce ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **contentwarehouse:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/48e2b3bd0ed4dd26633d4a1c81e1f63e046514d3 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **datamigration:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/46af1b605a6a84847f00dd25708777f51676c3c8 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **dataplex:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/78f49d8b1b7929fb76834d50d6e9285dbfc05f00 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **dialogflow:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7c8c3eb783538965b78d588b95e440aeb060842e ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **discovery:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/c6a49d6d465ebb567889ad7d5e7bbaa0d59076fd ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **dlp:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/0187753309059d672007baafdbe6033370cd8598 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **dns:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/7edc7a13a310904a3912aff8b30b1e491bfa76de ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **file:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/24b685a269a6ebf5bb4d35b3fa4f92c6018eb71a ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **firebaseappdistribution:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/29dbaafedd1cc3fe417f700e4cc883f49e6c75e4 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **firebaseml:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/bb97577f13ea9ad9fed314741b8971d989238cec ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **merchantapi:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/f70a393a94baccb4bb2cf534a84013371683ebdd ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **monitoring:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/20233307f9bd544588117cd3e044f309192cbc8b ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **networkmanagement:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/1ed9d8d4a96aded469f9e50ce303b17df52652fb ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **networksecurity:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/9a8591a851f4655711d87ebfaa3f9a52776059ed ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **playintegrity:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/b1c1442954e110a4394581977d6f26b6604b3777 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **recaptchaenterprise:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/0e18da83fa98124bcc19f1692bacc9673d24f538 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **walletobjects:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/1c16a89a726c1ea26b78672c2b61aab0379209fd ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) +* **workloadmanager:** Update the api https://togithub.com/googleapis/google-api-python-client/commit/20736dd7325eed4ff35c2ea69f6d21eacbe4ab86 ([330a354](https://github.com/googleapis/google-api-python-client/commit/330a3541b9850e6df370ea15b24ca1e8e901d5d5)) + ## [2.138.0](https://github.com/googleapis/google-api-python-client/compare/v2.137.0...v2.138.0) (2024-07-25) diff --git a/googleapiclient/version.py b/googleapiclient/version.py index 281bc2e9b62..f830e25ffc0 100644 --- a/googleapiclient/version.py +++ b/googleapiclient/version.py @@ -12,4 +12,4 @@ # See the License for the specific language governing permissions and # limitations under the License. -__version__ = "2.138.0" +__version__ = "2.139.0"